Skip to content

jnmorse/eslint-rule-finder

Eslint Rule Finder

Conventional Commits PRs Welcome Build Status

Buy Me a Coffee at ko-fi.com

Package to help eslint config maintainers keep there rules up to date.

Install

npm i -D eslint-rule-finder

Usage

Check for unused rules and error if found

eslint-rule-finder --unused .eslint.rc

Save Unused Rules to a markdown file as a list

eslint-rule-finder --unused .eslint.rc --save UNUSED.md

Use in Test Frameworks

Below is some examples of how to use this with testing frameworks

Mocha & Chai

const { LoadConfig, findUnused } = require('eslint-rule-finder')
const { assert } = require('chai')

let config

describe('Rules', () => {
  before(() => {
    config = new LoadConfig()
  })

  it('should have 0 undefined rules', () => {
    const unusedRules = findUnused(config)

    assert.equal(unusedRules.size, 0)
  })

  it('should have 0 deprecated rules', () => {
    const { deprecated } = config

    assert.equal(deprecated.size, 0)
  })
})

Jest Example

const { LoadConfig, findUnused } = require('eslint-rule-finder')

let config

describe('Rules', () => {
  beforeAll(() => {
    config = new LoadConfig()
  })

  it('should have 0 undefined rules', () => {
    const unused = findUnused(config)

    expect(unused.size).toBe(0)
  })

  it('should have 0 deprecated rules', () => {
    const { deprecated } = config

    expect(deprecated).toEqual(new Map())
  })
})

About

CLI to find eslint rules not currently in use, or are deprecated

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Sponsor this project

Packages

No packages published

Contributors 3

  •  
  •  
  •