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-rule-tester

v2.0.0

Published

A command-line interface for running ESLint rule unit tests

Downloads

321

Readme

A command-line interface for running ESLint rule unit tests powered by the official RuleTester API.

Running the unit tests

npm exec eslint-rule-tester <...path>

where <...path> is one or more Glob patterns, which can be mixed of..

  • JavaScript file exporting ESLint plugin, for example,
    module.exports = {
      // See https://eslint.org/docs/latest/extend/plugins#creating-a-plugin
      rules: {
        'rule-name': {
          // See https://eslint.org/docs/latest/extend/custom-rules#rule-structure
          tests: { valid: [], invalid: [] }
        }
      }
    }
  • JavaScript file exporting ESLint rule, for example,
    module.exports = {
      // See https://eslint.org/docs/latest/extend/custom-rules#rule-structure
      tests: { valid: [], invalid: [] }
    }

The command returns the status code representing the number of non-pass test results.

Optionally, the command accepts the following arguments:

|Argument|Description| |---|---| |--bail|Stop at the first failing test case.| |--silent|Print only failing test cases to the standard output.|

Running exclusive test cases

To run fewer test cases for debugging purposes, choose one of the following approaches:

  • Set only: true in your test case as mentioned in ESLint official documentations, for example,
    module.exports = {
      tests: {
        valid: [
          {
            only: true,
            code: '...'
          }
        ],
        invalid: [...]
      }
    }
  • Wrap your test case with the global function only injected by this package, for example,
    module.exports = {
      tests: {
        valid: [
          only({
            code: '...'
          })
        ],
        invalid: []
      }
    }
  • Wrap valid and/or invalid arrays with the global function only injected by this package, for example,
    module.exports = {
      tests: {
        valid: only([
          {
            code: '...'
          }
        ]),
        invalid: only([])
      }
    }

Sample command-line output

⚪ import-path-from-closest-index
🟢 react-sort-props
🔴 require-name-after-file-name
 1 var something = require("./james-arthur")
   filename: ./rules/require-name-after-file-name.js
   options: [
     [
       "./rules/*.js"
     ]
   ]
   Should have 1 error but had 0: [] (0 strictEqual 1)

 SKIP  1
 PASS  1
 FAIL  1