https://github.com/mysticatea/eslint-utils

Utilities for ESLint plugins and custom rules.
https://github.com/mysticatea/eslint-utils

eslint javascript nodejs npm-package

Last synced: 7 days ago
JSON representation

Utilities for ESLint plugins and custom rules.

• Host: GitHub
• URL: https://github.com/mysticatea/eslint-utils
• Owner: mysticatea
• License: mit
• Created: 2018-05-02T07:53:49.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-11-21T19:20:55.000Z (about 2 years ago)
• Last Synced: 2025-01-13T07:05:08.853Z (14 days ago)
• Topics: eslint, javascript, nodejs, npm-package
• Language: JavaScript
• Homepage: https://eslint-utils.mysticatea.dev/
• Size: 504 KB
• Stars: 74
• Watchers: 6
• Forks: 40
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

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.