Git Product home page Git Product logo

eslint-docs's Introduction

Heads Up!

This package is currently unmaintained. Consider checking out Wikimedia’s eslint-docgen instead.


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

eslint-docs's People

Contributors

armano2 avatar greenkeeper[bot] avatar greenkeeperio-bot avatar j-f1 avatar weirdpattern avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

eslint-docs's Issues

Errors when CRLF is used instead of LF

It seems the check is struggling with line breaks.
When I run npm run docs:check on Mac it works, but when I do the same on Windows I get errors.

error

Not saying this is wrong, is detecting the changes just fine, but this will cause a lot of issues when committing from different OSes...

An in-range update of eslint-plugin-promise is breaking the build 🚨

The devDependency eslint-plugin-promise was updated from 4.1.0 to 4.1.1.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

eslint-plugin-promise is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details
  • prettierci: Prettier is satisfied (Details).
  • codecov/project: No report found to compare against (Details).
  • codecov/patch: Coverage not affected. (Details).
  • Push Coverage: Succeeded
  • Only Branch Pushes: Succeeded
  • Lint: Succeeded
  • Test: Succeeded
  • Only master branch: Skipped
  • Install Dependencies: Cancelled
  • Install Dependencies: Succeeded

Commits

The new version differs by 2 commits.

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.


Your Greenkeeper Bot 🌴

An in-range update of rimraf is breaking the build 🚨

The devDependency rimraf was updated from 2.6.3 to 2.7.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

rimraf is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details
  • prettierci: Prettier is satisfied (Details).
  • codecov/project: 93.54% remains the same compared to 92174e8 (Details).
  • codecov/patch: Coverage not affected when comparing 92174e8...c6de33b (Details).
  • Push Coverage: Succeeded
  • Only Branch Pushes: Succeeded
  • Lint: Succeeded
  • Test: Succeeded
  • Only master branch: Skipped
  • Install Dependencies: Cancelled
  • Install Dependencies: Succeeded

Commits

The new version differs by 2 commits.

  • 250ee15 2.7.0
  • dc1682d feat: make it possible to omit glob dependency

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.


Your Greenkeeper Bot 🌴

An in-range update of ora is breaking the build 🚨

The dependency ora was updated from 3.3.1 to 3.4.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

ora is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

Status Details
  • prettierci: Prettier is satisfied (Details).
  • codecov/project: No report found to compare against (Details).
  • codecov/patch: Coverage not affected. (Details).
  • Push Coverage: Succeeded
  • Only Branch Pushes: Succeeded
  • Lint: Succeeded
  • Test: Succeeded
  • Install Dependencies: Succeeded
  • Only master branch: Skipped
  • Install Dependencies: Cancelled

Release Notes for v3.4.0
  • Refactor TypeScript definition to CommonJS compatible export (#107) 115735a

v3.3.1...v3.4.0

Commits

The new version differs by 2 commits.

  • 042de2b 3.4.0
  • 115735a Refactor TypeScript definition to CommonJS compatible export (#107)

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.


Your Greenkeeper Bot 🌴

An in-range update of eslint-plugin-node is breaking the build 🚨

The devDependency eslint-plugin-node was updated from 8.0.0 to 8.0.1.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

eslint-plugin-node is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details
  • prettierci: Prettier is satisfied (Details).
  • codecov/project: No report found to compare against (Details).
  • codecov/patch: Coverage not affected. (Details).
  • Push Coverage: Succeeded
  • Only Branch Pushes: Succeeded
  • Lint: Succeeded
  • Test: Succeeded
  • Only master branch: Skipped
  • Install Dependencies: Cancelled
  • Install Dependencies: Succeeded

Release Notes for v8.0.1

🐛 Bug fixes

Commits

The new version differs by 8 commits.

  • b234dcc 8.0.1
  • 0593c67 🎨 remove garbage
  • 679752b 🐛 fix no-unpublished-(require|import) false positive (fixes #126)
  • e2fc482 🐛 fix no-unpublished-bin false positive (fixes #115)
  • 0225b02 🎨 rename a function
  • 43e3198 ⚒ disable codecov comments
  • 62ba642 🐛 fix no-deprecated-api error messages (#147)
  • 153ab03 Chore: support the new rule meta.type property (fixes #143) (#145)

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.


Your Greenkeeper Bot 🌴

An in-range update of prettier is breaking the build 🚨

The devDependency prettier was updated from 1.14.2 to 1.14.3.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

prettier is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details
  • continuous-integration/travis-ci/push: The Travis CI build failed (Details).

Release Notes for 1.14.3

🔗 Changelog

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.


Your Greenkeeper Bot 🌴

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because we are using your CI build statuses to figure out when to notify you about breaking changes.

Since we did not receive a CI status on the greenkeeper/initial branch, we assume that you still need to configure it.

If you have already set up a CI for this repository, you might need to check your configuration. Make sure it will run on all new branches. If you don’t want it to run on every branch, you can whitelist branches starting with greenkeeper/.

We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

Once you have installed CI on this repository, you’ll need to re-trigger Greenkeeper’s initial Pull Request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper integration’s white list on Github. You'll find this list on your repo or organiszation’s settings page, under Installed GitHub Apps.

An in-range update of @types/eslint is breaking the build 🚨

The devDependency @types/eslint was updated from 4.16.6 to 4.16.7.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

@types/eslint is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details
  • prettierci: Prettier is satisfied (Details).
  • codecov/project: 93.54% remains the same compared to 92174e8 (Details).
  • codecov/patch: Coverage not affected when comparing 92174e8...cf5b77a (Details).
  • Push Coverage: Succeeded
  • Only Branch Pushes: Succeeded
  • Lint: Succeeded
  • Test: Succeeded
  • Install Dependencies: Succeeded
  • Only master branch: Skipped
  • Install Dependencies: Cancelled

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.


Your Greenkeeper Bot 🌴

An in-range update of semantic-release is breaking the build 🚨

The devDependency semantic-release was updated from 15.13.11 to 15.13.12.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

semantic-release is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details
  • prettierci: Prettier is satisfied (Details).
  • codecov/project: No report found to compare against (Details).
  • codecov/patch: Coverage not affected. (Details).
  • Push Coverage: Succeeded
  • Only Branch Pushes: Succeeded
  • Lint: Succeeded
  • Test: Succeeded
  • Only master branch: Skipped
  • Install Dependencies: Cancelled
  • Install Dependencies: Succeeded

Release Notes for v15.13.12

15.13.12 (2019-04-15)

Bug Fixes

  • package: update resolve-from to version 5.0.0 (6f3c21a)
Commits

The new version differs by 1 commits.

  • 6f3c21a fix(package): update resolve-from to version 5.0.0

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.


Your Greenkeeper Bot 🌴

An in-range update of eslint-plugin-prettier is breaking the build 🚨

The devDependency eslint-plugin-prettier was updated from 2.6.2 to 2.7.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

eslint-plugin-prettier is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details
  • continuous-integration/travis-ci/push: The Travis CI build failed (Details).

Commits

The new version differs by 3 commits.

  • 869f56d Build: update package.json and changelog for v2.7.0
  • 38537ba Update: Support prettierignore and custom processors (#111)
  • 047dc8f Build: switch to release script package

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.


Your Greenkeeper Bot 🌴

Support multiple README styles

TL;DR:

  • Load options from the eslint-config key in package.json
  • Add defaults
  • Convert the current rule format to use mustache for template magic
  • Implement options:
    • includePlugin
    • ruleAsCode
    • showFixable
  • Implement themes
  • Release!
  • Open PRs as shown below 🚀

Optional:

  • allow custom templates
  • implement tables ✨

Currently, this format is used for the README:

* [`{{fullName}}`](./docs/rules/{{name}}.md) — {{description}}

However, there are several other formats that could be useful, too:

default:
* [{{fullName}}](./docs/rules/{{name}}.md) — {{description}}
name-after:
* {{description}} ([{{fullName}}](./docs/rules/{{name}}.md))

Options:

  • includePlugin should specify whether {{fullName}} should be {{pluginName}}/{{name}} (true) or {{name}} (false, default)
  • ruleIsCode should specify whether {{fullName}} should be wrapped in ` (default: false).
  • showFixable should specify whether a piece of text indicating that the rule is fixable should be added to description in parentheses. If false, it won’t do so. Otherwise, the string value of the option will be inserted.

There should be an option to split up the rules by type:


Current usage:

Add a rule list:

docs in README; extract to separate files:

An in-range update of eslint-plugin-standard is breaking the build 🚨

The devDependency eslint-plugin-standard was updated from 4.0.0 to 4.0.1.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

eslint-plugin-standard is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details
  • prettierci: Prettier is satisfied (Details).
  • codecov/project: 93.54% remains the same compared to 92174e8 (Details).
  • codecov/patch: Coverage not affected when comparing 92174e8...0cf95d3 (Details).
  • Push Coverage: Succeeded
  • Only Branch Pushes: Succeeded
  • Lint: Succeeded
  • Test: Succeeded
  • Only master branch: Skipped
  • Install Dependencies: Cancelled
  • Install Dependencies: Succeeded

Commits

The new version differs by 8 commits.

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.


Your Greenkeeper Bot 🌴

Version 10 of node.js has been released

Version 10 of Node.js (code name Dubnium) has been released! 🎊

To see what happens to your code in Node.js 10, Greenkeeper has created a branch with the following changes:

  • Added the new Node.js version to your .travis.yml
  • The new Node.js version is in-range for the engines in 1 of your package.json files, so that was left alone

If you’re interested in upgrading this repo to Node.js 10, you can open a PR with these changes. Please note that this issue is just intended as a friendly reminder and the PR as a possible starting point for getting your code running on Node.js 10.

More information on this issue

Greenkeeper has checked the engines key in any package.json file, the .nvmrc file, and the .travis.yml file, if present.

  • engines was only updated if it defined a single version, not a range.
  • .nvmrc was updated to Node.js 10
  • .travis.yml was only changed if there was a root-level node_js that didn’t already include Node.js 10, such as node or lts/*. In this case, the new version was appended to the list. We didn’t touch job or matrix configurations because these tend to be quite specific and complex, and it’s difficult to infer what the intentions were.

For many simpler .travis.yml configurations, this PR should suffice as-is, but depending on what you’re doing it may require additional work or may not be applicable at all. We’re also aware that you may have good reasons to not update to Node.js 10, which is why this was sent as an issue and not a pull request. Feel free to delete it without comment, I’m a humble robot and won’t feel rejected 🤖


FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.


Your Greenkeeper Bot 🌴

An in-range update of eslint-plugin-import is breaking the build 🚨

The devDependency eslint-plugin-import was updated from 2.17.1 to 2.17.2.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

eslint-plugin-import is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details
  • prettierci: Prettier is satisfied (Details).
  • codecov/project: No report found to compare against (Details).
  • codecov/patch: Coverage not affected. (Details).
  • Push Coverage: Succeeded
  • Only Branch Pushes: Succeeded
  • Lint: Succeeded
  • Test: Succeeded
  • Only master branch: Skipped
  • Install Dependencies: Cancelled
  • Install Dependencies: Succeeded

Commits

The new version differs by 5 commits.

  • eddcfa9 Bump to v2.17.2
  • b151d04 [fix] no-unused-modules: avoid crash when using ignoreExports-option
  • 3512563 [fix] no-unused-modules: make sure that rule with no options will not fail
  • 8e0c021 [Test] no-unused-modules add failing test case
  • 9b7a970 [meta] add npm run mocha for easier unit testing

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.


Your Greenkeeper Bot 🌴

An in-range update of eslint is breaking the build 🚨

The devDependency eslint was updated from 5.13.0 to 5.14.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

eslint is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details
  • prettierci: Prettier is satisfied (Details).
  • Only master branch: Skipped
  • Install Dependencies: Cancelled

Release Notes for v5.14.0
  • 85a04b3 Fix: adds conditional for separateRequires in one-var (fixes #10179) (#10980) (Scott Stern)
  • 0c02932 Upgrade: [email protected] (#11401) (Ilya Volodin)
  • 104ae88 Docs: Update governance doc with reviewers status (#11399) (Nicholas C. Zakas)
  • ab8ac6a Fix: Support boundary spread elements in sort-keys (#11158) (Jakub Rożek)
  • a23d197 New: add allowSingleLineBlocks opt. to padded-blocks rule (fixes #7145) (#11243) (richie3366)
  • e25e7aa Fix: comma-spacing ignore comma before closing paren (fixes #11295) (#11374) (Pig Fang)
  • a1f7c44 Docs: fix space-before-blocks correct code for "classes": "never" (#11391) (PoziWorld)
  • 14f58a2 Docs: fix grammar in object-curly-spacing docs (#11389) (PoziWorld)
  • d3e9a27 Docs: fix grammar in “those who says” (#11390) (PoziWorld)
  • ea8e804 Docs: Add note about support for object spread (fixes #11136) (#11395) (Steven Thomas)
  • 95aa3fd Docs: Update README team and sponsors (ESLint Jenkins)
  • 51c4972 Update: Behavior of --init (fixes #11105) (#11332) (Nicholas C. Zakas)
  • ad7a380 Docs: Update README team and sponsors (ESLint Jenkins)
  • 550de1e Update: use default keyword in JSON schema (fixes #9929) (#11288) (Pig Fang)
  • 983c520 Update: Use 'readonly' and 'writable' for globals (fixes #11359) (#11384) (Nicholas C. Zakas)
  • f1d3a7e Upgrade: some deps (fixes #11372) (#11373) (薛定谔的猫)
  • 3e0c417 Docs: Fix grammar in “there’s nothing prevent you” (#11385) (PoziWorld)
  • de988bc Docs: Fix grammar: Spacing improve -> Spacing improves (#11386) (PoziWorld)
  • 1309dfd Revert "Build: fix test failure on Node 11 (#11100)" (#11375) (薛定谔的猫)
  • 1e56897 Docs: “the function actually use”: use -> uses (#11380) (PoziWorld)
  • 5a71bc9 Docs: Update README team and sponsors (ESLint Jenkins)
  • 82a58ce Docs: Update README team and sponsors (ESLint Jenkins)
  • 546d355 Docs: Update README with latest sponsors/team data (#11378) (Nicholas C. Zakas)
  • c0df9fe Docs: ... is not an operator (#11232) (Felix Kling)
  • 7ecfdef Docs: update typescript parser (refs #11368) (#11369) (薛定谔的猫)
  • 3c90dd7 Update: remove prefer-spread autofix (fixes #11330) (#11365) (薛定谔的猫)
  • 5eb3121 Update: add fixer for prefer-destructuring (fixes #11151) (#11301) (golopot)
  • 173eb38 Docs: Clarify ecmaVersion doesn't imply globals (refs #9812) (#11364) (Keith Maxwell)
  • 84ce72f Fix: Remove extraneous linefeeds in one-var fixer (fixes #10741) (#10955) (st-sloth)
  • 389362a Docs: clarify motivation for no-prototype-builtins (#11356) (Teddy Katz)
  • 533d240 Update: no-shadow-restricted-names lets unassigned vars shadow undefined (#11341) (Teddy Katz)
  • d0e823a Update: Make --init run js config files through linter (fixes #9947) (#11337) (Brian Kurek)
  • 92fc2f4 Fix: CircularJSON dependency warning (fixes #11052) (#11314) (Terry)
  • 4dd19a3 Docs: mention 'prefer-spread' in docs of 'no-useless-call' (#11348) (Klaus Meinhardt)
  • 4fd83d5 Docs: fix a misleading example in one-var (#11350) (薛定谔的猫)
  • 9441ce7 Chore: update incorrect tests to fix build failing (#11354) (薛定谔的猫)
Commits

The new version differs by 38 commits.

  • af9688b 5.14.0
  • 0ce3ac7 Build: changelog update for 5.14.0
  • 85a04b3 Fix: adds conditional for separateRequires in one-var (fixes #10179) (#10980)
  • 0c02932 Upgrade: [email protected] (#11401)
  • 104ae88 Docs: Update governance doc with reviewers status (#11399)
  • ab8ac6a Fix: Support boundary spread elements in sort-keys (#11158)
  • a23d197 New: add allowSingleLineBlocks opt. to padded-blocks rule (fixes #7145) (#11243)
  • e25e7aa Fix: comma-spacing ignore comma before closing paren (fixes #11295) (#11374)
  • a1f7c44 Docs: fix space-before-blocks correct code for "classes": "never" (#11391)
  • 14f58a2 Docs: fix grammar in object-curly-spacing docs (#11389)
  • d3e9a27 Docs: fix grammar in “those who says” (#11390)
  • ea8e804 Docs: Add note about support for object spread (fixes #11136) (#11395)
  • 95aa3fd Docs: Update README team and sponsors
  • 51c4972 Update: Behavior of --init (fixes #11105) (#11332)
  • ad7a380 Docs: Update README team and sponsors

There are 38 commits in total.

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.


Your Greenkeeper Bot 🌴

Categories

It will be nice if there will be way to group rules by their categories.

meta.docs.category field

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.