eslint-config-protect-me-from-my-stupidity

Protect Me From My Stupidity

An opinionated configuration for ESLint that shall protect you from your stupidity when writing JavaScript.

Usage

Add this to your ESLint configuration.

{
  "extends" : "protect-me-from-my-stupidity"
}

You can use configuration extensions to further cater for more specific scenarios, for example:

{
  "extends" : [
    "protect-me-from-my-stupidity",
    "protect-me-from-my-stupidity/but/let-my-code-look-stupid"
  ]
}

Configuration extensions

Configuration	Usage
and/from-writing-stupid-vue-components	Introduces additional rules for Vue components.
but/let-my-code-look-stupid	Stops all code style checks.
but/let-me-write-stupid-tests	Loosens up some rules for writing test specifications.
but/let-my-vue-components-look-stupid	Stops all code style checks for Vue components.

Parser

This project configures ESLint to parse JavaScript with the following in mind:

• All features up to ECMAScript 2020 are enabled.
• JSX is enabled.
• Modules, as defined by ECMAScript 2015, are enabled.
• Global strict mode is enabled.

Note: This project makes no assumption about your JavaScript environment, you must configure that yourself. See https://eslint.org/docs/user-guide/configuring#specifying-environments.

Plugins

This project currently includes configuration for the following plugins:

Plugin	Required dependency
eslint-plugin-import	Yes
eslint-plugin-promise	Yes
eslint-plugin-vue	Only when using vue related configuration.

Note: You will have to install the above plugins yourself as they are 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.

Major release

• Removing support for an old version of ESLint.
• Adding support for a new plugin.
• Removing support for an old version of an existing plugin.
• Adding a new configuration.

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

Disclaimer

Finally, if you get offended by my use of the word stupid. It is just a joke.

Changelog

5.0.0 - 2020-01-25

Added

• Switched the default-case rule on to prohibit switch statements without a default clause.
• Switched the default-param-last rule on to enforce that defaults are only defined for tail parameters.
• Switched the grouped-accessor-pairs rule on to enforce that getter/setter pairs are defined adjacently with the getter defined first.
• Switched the no-constructor-return rule to to prohibit return statements in constructors.
• Switched the no-dupe-else-if rule on to prohibit duplicate conditions in if-else-if chains.
• Switched the no-dupe-keys rule on to prohibit duplicate keys in object definitions.
• Switched the no-import-assign rule on to prohibit import bindings being assigned.
• Switched the no-setter-return rule on to prohibit setters from returning a value.
• Switched the no-useless-computed-key rule on to prohibit pointless computed keys.
• Switched the no-useless-constructor rule on to prohibit constructors that do nothing.
• Switched the prefer-exponentiation-operator rule to enforce the use of the ** operator instead of Math.pow().
• Switched the prefer-regex-literals rule on to prohibit the use of the RegExp constructor for non-dynamic regular expressions.
• Introduced new rule configurations for writing Vue components: protect-me-from-my-stupidity/and/from-writing-stupid-vue-components and protect-me-from-my-stupidity/but/let-my-vue-components-look-stupid.

Changed

• Switched the spaced-comment, padded-blocks, line-comment-position, max-classes-per-file, prefer-object-spread, import/group-exports and promise/no-callback-in-promise rules off in the protect-me-from-my-stupidity configuration.
• Updated the ECMAScript version to 11 (2020).
• Moved the protect-me-from-my-stupidity/but-let-me-write-stupid-tests configuration to protect-me-from-my-stupidity/but/let-me-write-stupid-tests.
• Moved the protect-me-from-my-stupidity/but-let-my-code-look-stupid configuration to protect-me-from-my-stupidity/but/let-my-code-look-stupid.
• Switched the arrow-spacing and dot-location rules off in the protect-me-from-my-stupidity/but/let-my-code-look-stupid configuration.

Removed

• Removed the valid-jsdoc, no-catch-shadow and require-jsdoc deprecated rules.