.config/coc/extensions/node_modules/coc-prettier/node_modules/eslint-utils/README.md

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