linter-js-standard-engine

A linter for GitHub's Atom Editor using the Linter Plugin, for use with the standard linter, and other linters based on standard-engine.

Installation

$ apm install linter-js-standard-engine

Or, Settings → Install → Search for linter-js-standard-engine.

Usage

linter-js-standard-engine recognizes the following linters if they're present in the devDependencies of your package.json file:

happiness
onelint
semistandard
standard
uber-standard

For example:

{
  "devDependencies": {
    "standard": "*"
  }
}

Additionally you can specify what linter to use using by setting standard-engine in your package.json file:

{
  "standard-engine": "@novemberborn/as-i-preach"
}

The value must be a reference to a Node.js module that implements standard-engine. The above example is for @novemberborn/as-i-preach.

When set, the standard-engine value takes precedence over any other linters discovered in the devDependencies.

The package.json file is discovered by walking up the file system, starting at the file being linted. The first package.json file found is the one that's used. The linter is invoked with its working directory set to the directory the package.json file is in. The package.json file's location and contents are cached.

If you have a project setup with multiple package.json files you can tell linter-js-standard-engine to ignore nested package.json files and keep walking up the file system:

{
  "standard-engine": {
    "skip": true
  }
}

This object format can also be used to specify the linter:

{
  "standard-engine": {
    "name": "@novemberborn/as-i-preach"
  }
}

Commands

Fix File

Run Standard Engine: Fix File to automatically fix linting issues.

Restart

Run Standard Engine: Restart to clear internal caches and restart linters.

What about `linter-js-standard`?

If you're using standard, semistandard or happiness then you could use another package called linter-js-standard.

The advantage of using linter-js-standard-engine however is that it utilizes the linter that is installed in your project, rather than bundling a particular linter version. We also support more linters, including any custom linter that's based on standard-engine.

License

This module is made public under the ISC License.

See the LICENSE file for additional details.

matt- / linter-js-standard-engine Goto Github PK