2023-12-18 13:12:25 +08:00
# eslint-utils
[![npm version ](https://img.shields.io/npm/v/eslint-utils.svg )](https://www.npmjs.com/package/eslint-utils)
[![Downloads/month ](https://img.shields.io/npm/dm/eslint-utils.svg )](http://www.npmtrends.com/eslint-utils)
2024-01-16 21:26:16 +08:00
[![Build Status ](https://github.com/mysticatea/eslint-utils/workflows/CI/badge.svg )](https://github.com/mysticatea/eslint-utils/actions)
2023-12-18 13:12:25 +08:00
[![Coverage Status ](https://codecov.io/gh/mysticatea/eslint-utils/branch/master/graph/badge.svg )](https://codecov.io/gh/mysticatea/eslint-utils)
[![Dependency Status ](https://david-dm.org/mysticatea/eslint-utils.svg )](https://david-dm.org/mysticatea/eslint-utils)
## 🏁 Goal
This package provides utility functions and classes for make ESLint custom rules.
For examples:
2024-01-16 21:26:16 +08:00
- [getStaticValue ](https://eslint-utils.mysticatea.dev/api/ast-utils.html#getstaticvalue ) evaluates static value on AST.
- [PatternMatcher ](https://eslint-utils.mysticatea.dev/api/ast-utils.html#patternmatcher-class ) finds a regular expression pattern as handling escape sequences.
- [ReferenceTracker ](https://eslint-utils.mysticatea.dev/api/scope-utils.html#referencetracker-class ) checks the members of modules/globals as handling assignments and destructuring.
2023-12-18 13:12:25 +08:00
## 📖 Usage
2024-01-16 21:26:16 +08:00
See [documentation ](https://eslint-utils.mysticatea.dev/ ).
2023-12-18 13:12:25 +08:00
## 📰 Changelog
See [releases ](https://github.com/mysticatea/eslint-utils/releases ).
## ❤️ Contributing
Welcome contributing!
Please use GitHub's Issues/PRs.
### Development Tools
- `npm test` runs tests and measures coverage.
- `npm run clean` removes the coverage result of `npm test` command.
- `npm run coverage` shows the coverage result of the last `npm test` command.
- `npm run lint` runs ESLint.
- `npm run watch` runs tests on each file change.