Socket
Socket
Sign inDemoInstall

@infctr/eslint-docs

Package Overview
Dependencies
64
Maintainers
1
Versions
1
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @infctr/eslint-docs

Keep your rule names and descriptions up-to-date across your repo


Version published
Weekly downloads
1
decreased by-90.91%
Maintainers
1
Install size
1.36 MB
Created
Weekly downloads
 

Changelog

Source

v0.4.0

  • Allow use with scoped repositories
  • Enable semantic-release

Readme

Source

eslint-docs

NPM version NPM version Build Status Codecov Greenkeeper enabled semantic-release

Keep your rule names and descriptions up-to-date across your repo

NPM

Installation

$ npm install --save-dev eslint-docs

Usage

In the shell

$ eslint-docs
✔ docs/rules/no-insecure-random.md is up-to-date
✔ docs/rules/no-stateless-class.md is up-to-date
✔ docs/rules/promise-must-complete.md is up-to-date
✔ README.md is up-to-date

$ eslint-docs check # Run this in CI!
✔ docs/rules/no-insecure-random.md is valid
✔ docs/rules/no-stateless-class.md is valid
✔ docs/rules/promise-must-complete.md is valid
✔ The README is valid

In package.json:

{
  "scripts": {
    "docs": "eslint-docs",
    "docs:check": "eslint-docs check"
  }
}

In a Node.js script

const eslintDocs = require('eslint-docs')

eslintDocs(yourProjectDirectory).then(
  () => {
    // Everything went OK!
  },
  () => {
    // Something went wrong!
    // Currently, you’ll have to ask the user to look at the terminal. sorry :(
  }
)

yourProjectDirectory defaults to the closest directory above process.cwd() that includes a package.json

License

ISC © Jed Fox

Keywords

FAQs

Last updated on 24 Apr 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc