Skip to content

ESLint executable and configuration for SEAL Systems

License

Notifications You must be signed in to change notification settings

goloroden/node-eslint-config-es

Repository files navigation

@sealsystems/eslint-config-es

ESLint executable and configuration for SEAL Systems

Installation

npm install --save-dev @sealsystems/eslint-config-es

Quick start

Create a file with the name .eslintrc.json in the root directory of your project. It should contain at least the following lines:

{
  "extends": "@sealsystems/eslint-config-es"
}

ESLint is installed as a dependency of @sealsystems/eslint-config-es. So you can call eslint from the root directory of your project:

$(npm bin)/eslint **/*.js

Please note:

  • In order to install all dependencies directly in the project's node_modules folder, you may need to delete package-lock.json before adding this package.

The package also provides 3 CLI executables:

  • bot runs the following checks:

    • ESLint

    • Unit Tests by calling npm run test

    • Missing or unused dependencies (aborts the test run only if package.json does not contain a dependency)

    • Outdated dependencies (never aborts the test run)

    In case of an error, the returned status code indicates the number of the failed test

  • lint runs ESLint

  • lint-fix runs ESLint with the option --fix

Please note:

  • ESLint ignores all files and directories listed in the project's .gitignore.

To use these binaries, add some scripts to your package.json:

...
"scripts": {
  "bot": "bot",
  "lint": "lint",
  "lint:fix": "lint-fix"
}
...

And call them via npm run:

npm run bot
npm run lint
npm run lint:fix

Implementation details

Please note: This module is part of the build and release infrastructure. In order to prevent endless loops when automatically updating dependencies, Dependabot is not enabled.

About

ESLint executable and configuration for SEAL Systems

Resources

License

Stars

Watchers

Forks

Packages

No packages published