eslint-config-protect-me-from-my-stupidity
A very opinionated configuration for ESLint that shall protect you from your stupidity when writing JavaScript.
Usage
You can use this in your ESLint configuration file, like so:
import protectMeFromMyStupidity from 'eslint-config-protect-me-from-my-stupidity';
export default [
...protectMeFromMyStupidity
];
The base configuration configures all core rules, as of 9.15.0
, and all the rules for the following plugins (which are peer dependencies):
Plugin | Minimum Version |
---|
eslint-plugin-promise | 7.1.0 |
eslint-plugin-import | 2.31.0 |
@stylistic/eslint-plugin-js | 2.11.0 |
ESLint is configured to parse code as the the latest version of ECMAScript and to treat all .js
and .mjs
files as ES modules and .cjs
files as CommonJS modules.
Configuration extensions
In addition to the base configuration you can use configuration extensions, these are available as seperate exports.
Name | Export | Required Plugins | Description |
---|
Node | and/from-writing-stupid-vue-components | eslint-plugin-vue@9.31.0 | Introduces additional rules for .vue component files. |
Vue | and/from-writing-stupid-node-applications | eslint-plugin-n@17.13.2 | Introduces additional rules for Node.js code files. |
Please Note: The plugins required by the configuration extensions are optional peer dependencies.
Semantic versioning
This project follows a semantic versioning policy that aims not to surprise you.
Patch release
- Updating an existing rule that will result in ESLint reporting fewer errors.
Minor release
- Updating an existing rule that will result in ESLint reporting different or more errors.
- Adding a new rule.
- Removing support for a minor or patch version of ESlint or a plugin.
Major release
- Adding support for a new plugin.
- Removing support for a major version of ESLint or a plugin.
- Adding or removing configuration extensions.
Note: It is advised that you only take patch versions using tilde ranges.
Getting started
This project is available through the Node Package Manager (NPM), so you can install it like so:
npm install eslint-config-protect-me-from-my-stupidity --save-dev
Disclaimer
Finally, if you get offended by my use of the word stupid. It is just a joke.