# eslint-utils

> Utilities for ESLint plugins.

Latest version **3.0.0** (published 2021-05-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install eslint-utils
pnpm add eslint-utils
yarn add eslint-utils
bun add eslint-utils
```

## Health

**Score 28/100 (F)** — status: abandoned.

Positive: has types package; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.0 |
| Published | 2021-05-14 |
| First published | 2018-05-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/eslint-utils) |
| Module format | ESM + CommonJS |
| Node | ^10.0.0 \|\| ^12.0.0 \|\| >= 14.0.0 |
| Dependencies | 1 |
| Unpacked size | 350 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 76 |
| Author | Toru Nagashima |
| Maintainers | mysticatea |
| Keywords | eslint |

## Links

- npm: https://www.npmjs.com/package/eslint-utils
- Repository: https://github.com/mysticatea/eslint-utils
- Homepage: https://github.com/mysticatea/eslint-utils#readme
- Issues: https://github.com/mysticatea/eslint-utils/issues
- Funding: https://github.com/sponsors/mysticatea
- npm.io page: https://npm.io/package/eslint-utils

## Dependencies (1)

- [eslint-visitor-keys](https://npm.io/package/eslint-visitor-keys.md) ^2.0.0

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 3.0.0 (latest) — 2021-05-14
- 2.1.0 — 2020-06-15
- 2.0.0 — 2019-12-26
- 1.4.3 — 2019-10-20
- 1.4.2 — 2019-08-20
- 1.4.1 — 2019-08-20
- 1.4.0 — 2019-07-14
- 1.3.1 — 2018-06-28
- 1.3.0 — 2018-05-27
- 1.2.0 — 2018-05-08
- 1.1.0 — 2018-05-04
- 1.0.0 — 2018-05-03
- 0.0.0 — 2018-05-03

## README

# 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)
[![Build Status](https://github.com/mysticatea/eslint-utils/workflows/CI/badge.svg)](https://github.com/mysticatea/eslint-utils/actions)
[![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:

- [getStaticValue](https://eslint-utils.mysticatea.dev/api/ast-utils.html#getstaticvalue) evaluates static value on AST.
- [ReferenceTracker](https://eslint-utils.mysticatea.dev/api/scope-utils.html#referencetracker-class) checks the members of modules/globals as handling assignments and destructuring.

## 📖 Usage

See [documentation](https://eslint-utils.mysticatea.dev/).

## 📰 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.

---
_Source: https://npm.io/package/eslint-utils · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._