@boughtbymany/eslint-config-bbm
v6.0.1
Published
Bought By Many ESLint Config
Downloads
57
Maintainers
Readme
Bought By Many - ESLint Config
Goals
- Catch mistakes as they are made.
- Flag areas where code can be improved.
- Promote consistency in code style & structure.
Quickstart
Install the package:
npm i -D @boughtbymany/eslint-config-bbm
Install peer dependencies (npm v5/6 only - npm v7 will install peer dependencies automatically)
npx install-peerdeps --dev @boughtbymany/eslint-config-bbm
Add the desired configuration to your
.eslintrc.js
module.exports = { extends: [ '@boughtbymany/eslint-config-bbm', // or '@boughtbymany/eslint-config-bbm/<config name>', // e.g. '@boughtbymany/eslint-config-bbm/vue' ], }
Installation
npm i -D \
@boughtbymany/eslint-config-bbm \
@babel/core \
@babel/eslint-parser \
eslint \
eslint-config-prettier \
eslint-plugin-jsdoc \
eslint-plugin-prettier \
eslint-plugin-import \
prettier
You may also need to install additional peer dependencies (the dependencies required will depend on the configuration being used). To list the peer dependencies:
npm info @boughtbymany/eslint-config-bbm peerDependencies
Configuration
To use the standard configuration for JavaScript, create an .eslintrc.js
file
with the following contents:
module.exports = {
extends: [
'@boughtbymany/eslint-config-bbm',
],
}
You can also set up an .eslintignore
file to ignore any files that shouldn't
be linted:
/dist/
The node_modules
directory is always ignored.
Multiple Configurations
This package also exposes other configurations. Note that you will likely have
to install extra dev dependencies (as noted in the Installation
section of this readme) when using these rules as they make use of extra
plugins that are listed in this package's peerDependencies
.
Vue.js
To lint Vue.js single-file components (*.vue
), add the
following to the .eslintrc.js
file:
module.exports = {
extends: ["@boughtbymany/eslint-config-bbm/vue"],
}
Nuxt.js
To lint Nuxt.js projects, add the following to the
.eslintrc.js
file:
module.exports = {
extends: ["@boughtbymany/eslint-config-bbm/nuxt"],
}
Node.js
To lint Node.js scripts add the following to the
.eslintrc.js
file:
module.exports = {
extends: ["@boughtbymany/eslint-config-bbm/node"],
}
Jest
To lint Jest test scripts, add the following to the
.eslintrc.js
file:
module.exports = {
extends: ["@boughtbymany/eslint-config-bbm/jest"],
}
HTML Scripts
To lint inline scripts contained within HTML files, add the following to the
.eslintrc.js
file:
module.exports = {
extends: ["@boughtbymany/eslint-config-bbm/html"],
}
Cucumber
To lint Cucumber test scripts, add the following to the
.eslintrc.js
file:
module.exports = {
extends: ["@boughtbymany/eslint-config-bbm/cucumber"],
}
How to use
Command line
Add package.json
scripts, e.g:
{
"scripts": {
"lint:js": "eslint --ext .js,.vue src",
"lint:js:fix": "npm run lint:js -- --fix"
}
}
You will then be able to lint your codebase by running the command
npm run lint:js
and fix many issues with npm run lint:js:fix
.
In a vue-cli
project that'll use eslint
as part of the standard lint
process, the scripts should be more like:
{
"scripts": {
"lint": "vue-cli-service lint --no-fix src tests",
"lint:fix": "vue-cli-service lint src tests",
}
}
IDE Integrations
Atom
apm install linter-eslint
Go to Settings > Packages > linter-eslint > Settings and set the list of scopes to:
source.js, source.babel, source.vue, text.html.vue, text.html.basic
Visual Studio Code
code --install-extension dbaeumer.vscode-eslint
To enable Vue templates to be linted by the extension, add the following to your settings:
{
"eslint.validate": [
"javascript",
"vue"
]
}
To enable automatic fixing of errors on save first we turn of auto formatting on
save if that's enabled and then enable the eslint extension's fixAll
code
action:
{
"editor.formatOnSave": false,
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true
}
}
If you are having issues with ESLint configuration rules not being respected by the editor, you may need to disable Vetur's template validation.
Tips
Migrating old codebases
Run npm run lint --fix
to clean up everything that can be cleaned up
automatically and then commit those changes by themselves. If there are a lot of
additional warnings that you'd rather not deal with straight away, then override
them in the .eslintrc.js
file as follows:
module.exports = {
extends: [
'@boughtbymany/eslint-config-bbm',
],
rules: {
// FIXME: Temporarily disabled – please clean up.
'some-inconvenient-rule': 'off',
}
}
Remember to clean up these warnings as and when it's convenient.
Version control
Don't mix logical changes with lint changes in the same commit – if you are implementing a feature in an older codebase that doesn't already follow these lint rules, then commit any lint clean ups first, then implement the feature, or vice-versa.
If your editor has a feature like "automatically fix errors on save", be aware that you may have to therefore partially add files to your commits. If this is too much effort for you, then you can/should disable the automatic fixing of errors so you don't have this situation.
Excluding code from linting
If there's an exceptional situation where a rule that should normally be followed should be ignored in that specific case, disable that rule for that specific section of code.
Try to limit the size and scope of the exclusion as much as possible.
Do not just disable eslint
altogether - always provide a rule name and,
where useful, give a reason as to why you're disabling it.
Disabling rules for a single line
// eslint-disable-next-line no-new
new Foo() // This code would normally generate a warning.
Or:
new Foo() // eslint-disable-line no-new
But preferably the next-line
variant as it's easier to read and doesn't
interfere with a true code line.
Disabling rules for larger sections
/* eslint-disable no-new */
// These three lines would normally generate a warning.
new Foo()
new Bar()
new Baz()
/* eslint-enable no-new */
If you disable a rule for an entire file, ensure you re-enable it at the end of the file to make sure that you aren't inadvertently disabling the rule for any code that ends up concatenated with it.
See: ESLint Documentation § Disabling Rules with Inline Comments
If you have to disable a rule in more than a couple of cases, it may be the case that the rule is too noisy, or you may be doing something incorrectly. Consider whether the rule should be removed from this configuration, or if there's a better way of writing the code in question.
Adding new rules
New rules should be added when they stand a chance of catching a mistake, push developers to write better code, or if they make the code more consistently styled. Avoid rules that force developers to jump through hoops just to keep the linter happy.
Sometimes new rules get added to this package's dependencies. It's worth reviewing the changes when updating these dependencies to see if there are any useful additions we can enable.
Removing rules
If there's a rule that is generating too much noise in code that is otherwise perfectly fine, consider removing it from this configuration. Before doing so, take the time to understand why the rule exists and whether there's a better way of writing the code in question.