You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

38 lines
1.6 KiB

4 years ago
  1. # eslint-utils
  2. [![npm version](https://img.shields.io/npm/v/eslint-utils.svg)](https://www.npmjs.com/package/eslint-utils)
  3. [![Downloads/month](https://img.shields.io/npm/dm/eslint-utils.svg)](http://www.npmtrends.com/eslint-utils)
  4. [![Build Status](https://github.com/mysticatea/eslint-utils/workflows/CI/badge.svg)](https://github.com/mysticatea/eslint-utils/actions)
  5. [![Coverage Status](https://codecov.io/gh/mysticatea/eslint-utils/branch/master/graph/badge.svg)](https://codecov.io/gh/mysticatea/eslint-utils)
  6. [![Dependency Status](https://david-dm.org/mysticatea/eslint-utils.svg)](https://david-dm.org/mysticatea/eslint-utils)
  7. ## 🏁 Goal
  8. This package provides utility functions and classes for make ESLint custom rules.
  9. For examples:
  10. - [getStaticValue](https://eslint-utils.mysticatea.dev/api/ast-utils.html#getstaticvalue) evaluates static value on AST.
  11. - [ReferenceTracker](https://eslint-utils.mysticatea.dev/api/scope-utils.html#referencetracker-class) checks the members of modules/globals as handling assignments and destructuring.
  12. ## 📖 Usage
  13. See [documentation](https://eslint-utils.mysticatea.dev/).
  14. ## 📰 Changelog
  15. See [releases](https://github.com/mysticatea/eslint-utils/releases).
  16. ## ❤️ Contributing
  17. Welcome contributing!
  18. Please use GitHub's Issues/PRs.
  19. ### Development Tools
  20. - `npm test` runs tests and measures coverage.
  21. - `npm run clean` removes the coverage result of `npm test` command.
  22. - `npm run coverage` shows the coverage result of the last `npm test` command.
  23. - `npm run lint` runs ESLint.
  24. - `npm run watch` runs tests on each file change.