main
|
Last change
on this file was d565449, checked in by stefan toskovski <stefantoska84@…>, 4 weeks ago |
|
Update repo after prototype presentation
|
-
Property mode
set to
100644
|
|
File size:
1.6 KB
|
| Rev | Line | |
|---|
| [d565449] | 1 | # @eslint-community/eslint-utils
|
|---|
| 2 |
|
|---|
| 3 | [](https://www.npmjs.com/package/@eslint-community/eslint-utils)
|
|---|
| 4 | [](http://www.npmtrends.com/@eslint-community/eslint-utils)
|
|---|
| 5 | [](https://github.com/eslint-community/eslint-utils/actions)
|
|---|
| 6 | [](https://codecov.io/gh/eslint-community/eslint-utils)
|
|---|
| 7 |
|
|---|
| 8 | ## 🏁 Goal
|
|---|
| 9 |
|
|---|
| 10 | This package provides utility functions and classes for make ESLint custom rules.
|
|---|
| 11 |
|
|---|
| 12 | For examples:
|
|---|
| 13 |
|
|---|
| 14 | - [`getStaticValue`](https://eslint-community.github.io/eslint-utils/api/ast-utils.html#getstaticvalue) evaluates static value on AST.
|
|---|
| 15 | - [`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.
|
|---|
| 16 |
|
|---|
| 17 | ## 📖 Usage
|
|---|
| 18 |
|
|---|
| 19 | See [documentation](https://eslint-community.github.io/eslint-utils).
|
|---|
| 20 |
|
|---|
| 21 | ## 📰 Changelog
|
|---|
| 22 |
|
|---|
| 23 | See [releases](https://github.com/eslint-community/eslint-utils/releases).
|
|---|
| 24 |
|
|---|
| 25 | ## ❤️ Contributing
|
|---|
| 26 |
|
|---|
| 27 | Welcome contributing!
|
|---|
| 28 |
|
|---|
| 29 | Please use GitHub's Issues/PRs.
|
|---|
| 30 |
|
|---|
| 31 | ### Development Tools
|
|---|
| 32 |
|
|---|
| 33 | - `npm test` runs tests and measures coverage.
|
|---|
| 34 | - `npm run clean` removes the coverage result of `npm test` command.
|
|---|
| 35 | - `npm run coverage` shows the coverage result of the last `npm test` command.
|
|---|
| 36 | - `npm run lint` runs ESLint.
|
|---|
| 37 | - `npm run watch` runs tests on each file change.
|
|---|
Note:
See
TracBrowser
for help on using the repository browser.
