| # @eslint-community/eslint-utils |
|
|
| [](https://www.npmjs.com/package/@eslint-community/eslint-utils) |
| [](http://www.npmtrends.com/@eslint-community/eslint-utils) |
| [](https://github.com/eslint-community/eslint-utils/actions) |
| [](https://codecov.io/gh/eslint-community/eslint-utils) |
|
|
| ## ๐ Goal |
|
|
| This package provides utility functions and classes for make ESLint custom rules. |
|
|
| For examples: |
|
|
| - [`getStaticValue`](https://eslint-community.github.io/eslint-utils/api/ast-utils.html#getstaticvalue) evaluates static value on AST. |
| - [`ReferenceTracker`](https://eslint-community.github.io/eslint-utils/api/scope-utils.html#referencetracker-class) checks the members of modules/globals as handling assignments and destructuring. |
|
|
| ## ๐ Usage |
|
|
| See [documentation](https://eslint-community.github.io/eslint-utils). |
|
|
| ## ๐ฐ Changelog |
|
|
| See [releases](https://github.com/eslint-community/eslint-utils/releases). |
|
|
| ## โค๏ธ Contributing |
|
|
| Welcome contributing! |
|
|
| Please use GitHub's Issues/PRs. |
|
|
| ### Development Tools |
|
|
| - `npm run test-coverage` runs tests and measures coverage. |
| - `npm run clean` removes the coverage result of `npm run test-coverage` command. |
| - `npm run coverage` shows the coverage result of the last `npm run test-coverage` command. |
| - `npm run lint` runs ESLint. |
| - `npm run watch` runs tests on each file change. |
|
|