eslint-utils

npm version Downloads/month Build Status Coverage Status Dependency Status

:checkered_flag: Goal

This package provides utility functions and classes for make ESLint custom rules.

For examples:

  • getStaticValue evaluates static value on AST.
  • PatternMatcher finds a regular expression pattern as handling escape sequences.
  • ReferenceTracker checks the members of modules/globals as handling assignments and destructuring.

:book: Usage

See documentation.

:newspaper: Changelog

See releases.

:heart:️ 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.