# coffeescope2

> coffeelint plugin that handles variables and their scope

Latest version **0.5.1** (published 2018-05-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install coffeescope2
pnpm add coffeescope2
yarn add coffeescope2
bun add coffeescope2
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.1 |
| Published | 2018-05-23 |
| First published | 2016-02-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.8 |
| Dependencies | 1 |
| Unpacked size | 39.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 30 |
| Author | Radu Dan |
| Maintainers | za_creature |
| Keywords | coffee, coffee-script, coffee-lint, coffeelint, coffeelintrule, lint, scope, undefined, unused, variables |

## Links

- npm: https://www.npmjs.com/package/coffeescope2
- Repository: https://github.com/za-creature/coffeescope
- Issues: https://github.com/za-creature/coffeescope/issues
- npm.io page: https://npm.io/package/coffeescope2

## Dependencies (1)

- [globals](https://npm.io/package/globals.md) ^11.5.0

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 0.5.1 (latest) — 2018-05-23
- 0.5.0 — 2017-12-12
- 0.4.6 — 2017-09-12
- 0.4.5 — 2017-01-16
- 0.4.4 — 2016-12-14
- 0.4.3 — 2016-10-05
- 0.4.2 — 2016-09-14
- 0.4.1 — 2016-08-02
- 0.4.0 — 2016-07-14
- 0.3.10 — 2016-06-29
- 0.3.9 — 2016-06-29
- 0.3.8 — 2016-06-29
- 0.3.7 — 2016-06-16
- 0.3.6 — 2016-06-16
- 0.3.5 — 2016-06-14
- … 14 more at https://npm.io/package/coffeescope2/versions

## README

# coffeescope2

[![Circle CI](https://circleci.com/gh/za-creature/coffeescope/tree/master.svg?style=shield)](https://circleci.com/gh/za-creature/coffeescope/tree/master)
[![Dependencies](https://david-dm.org/za-creature/coffeescope.svg)](https://david-dm.org/za-creature/coffeescope)
[![Dev Dependencies](https://david-dm.org/za-creature/coffeescope/dev-status.svg)](https://david-dm.org/za-creature/coffeescope#info=devDependencies)
[![Coverage Status](https://img.shields.io/coveralls/za-creature/coffeescope.svg)](https://coveralls.io/github/za-creature/coffeescope?branch=master)

[coffeelint](http://www.coffeelint.org/) plugin that handles variables and
their scope. It can detect:

* attempting to access an undefined variable
* overwriting or shadowing a variable from an outer scope
* unused variables and arguments

## Table of Contents

* [Installation](#installation)
* [License: MIT](#license)

## Installation

Add coffeescope to your project's dependencies

```bash
npm install --save coffeescope2
```

Insert this somewhere into your `coffeelint.json` file (I like to keep my
custom rules at the bottom):

```
"check_scope": {
    "module": "coffeescope2",
    "level": "warn",
    "environments": ["es5"],
    "globals": {
        "jQuery": true,
        "$": true
    },
    "overwrite": true,
    "shadow": true,
    "shadow_builtins": false,
    "shadow_exceptions": ["err", "next"],
    "undefined": true,
    "hoist_local": true,
    "hoist_parent": true,
    "unused_variables": true,
    "unused_arguments": false,
    "unused_classes": true
},
```

[Full list of options and values](src/index.coffee#L26)

[↑ Back to top](#table-of-contents)

## License

coffeescope2 is licensed under the [MIT license](LICENSE.md).

[↑ Back to top](#table-of-contents)

---
_Source: https://npm.io/package/coffeescope2 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._