1.0.0 • Published 7 years ago

@fczbkk/eslint-config v1.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
7 years ago

Default ESLint config for personal projects of Riki Fridrich

How to add to project

Add module @fczbkk/eslint-config as a dev dependency to your project:

npm install @fczbkk/eslint-config --save

Then extend your ESLint config with @fczbkk. For example, if you use .eslintrc.json, it could look like this:

{
    "extends": "@fczbkk"
}

Different linting for development and build

The rules in this config use warn instead of error. This allows you to bash out ugly code while developing, but it will force you to clean it up before you do the build. Here's what you should do:

Create two linter tasks in your project. One for regular development (e.g. eslint) and one for build (e.g. eslint:build):

{
  "scripts": {
      "eslint": "eslint ./src/**/*.js",
      "eslint:build": "npm run eslint -- --max-warnings 0"
  }
}

This way you can use the regular lint task while developing (e.g. as a part of your test watcher task) and it will allow you to do all kinds of stuff (e.g. using console.log), but then you should use the build lint task when building (e.g. as a part of preversion task) and it will prevent you to create a build that contains debug or mis-formatted code.