npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

eslint-index

v1.5.0

Published

CLI for finding and managing rules in ESLint config files

Downloads

8,894

Readme

ESLint ESLint Index

CLI for finding and managing rules in ESLint config files

List all the rules!

Demo 1

Then count them, or create a pretty table!

Demo 2

Installation

npm install eslint-index --save-dev

Usage

eslint-index path/to/.eslintrc [options]

This package is intended to be used as a local utility.

It needs both eslint and the eslint-plugins referenced in the .eslintrc.* config file, to be installed alongside it.

Using it as a global utility will throw an error if eslint and the eslint-plugins referenced in the .eslintrc.* config file are not installed globally.

It is recommended that you use it within your package.json scripts:

"scripts": {
  "list-rules": "eslint-index .eslintrc",
  "count-rules": "eslint-index .eslintrc --format number",
  "table-rules": "eslint-index .eslintrc --format table",
  "list-rules-with-docs": "eslint-index .eslintrc --docs",
  "list-eslint-rules": "eslint-index .eslintrc --groups eslint",
  "list-disabled-rules": "eslint-index .eslintrc --status omitted off"
}

Alternatively, you can add ./node_modules/.bin to your $PATH.

This will allow you to use any node binaries within your project:

» cd some-project-with-eslint-index-installed
» which eslint-index
./node_modules/.bin/eslint-index
» eslint-index .eslintrc --format table
┌──────────┬─────────┬─────────┬─────────┬─────────┬─────────┐
│          │ total   │ omitted │ off     │ warn    │ error   │
├──────────┼─────────┼─────────┼─────────┼─────────┼─────────┤
│ eslint   │ 233     │ 0       │ 29      │ 2       │ 202     │
├──────────┼─────────┼─────────┼─────────┼─────────┼─────────┤
│ react    │ 53      │ 4       │ 0       │ 0       │ 49      │
└──────────┴─────────┴─────────┴─────────┴─────────┴─────────┘

Options

Option | Alias | Description | Arg Type | Arg Options ------------|-------|------------------------------|-----------------|------------ --help | -h | Display help | Boolean | N/A --docs | -d | Display docs alongside rules | Boolean | N/A --format | -f | Format rules | String | list|table|number --status | -s | Filter rules by status | Array<String> | omitted|off|warn|error --groups | -g | Filter rules by group/plugin | Array<String> | eslint|plugin eg. react --include | -i | Filter rules by id | Array<String> | rule-id-one rule-id-two --exclude | -e | Reject rules by id | Array<String> | rule-id-one rule-id-two

Examples

eslint-index .eslintrc --format table
eslint-index .eslintrc --format number
eslint-index .eslintrc --status omitted off
eslint-index .eslintrc --status warn error
eslint-index .eslintrc --groups eslint react
eslint-index .eslintrc --groups eslint --status warn error
eslint-index .eslintrc --groups eslint --status warn error --format number
eslint-index .eslintrc --include semi curly
eslint-index .eslintrc --exclude semi curly
eslint-index .eslintrc --docs
eslint-index .eslintrc --groups eslint react --docs

Author

Matthew Wagerfield @wagerfield