@mgsisk/eslint-config

Opinionated ESLint configurations for JavaScript development.

The @mgsisk/eslint-config package includes opinionated ESLint configurations for JavaScript development.

• @mgsisk/eslint-config – Standard configuration for general development.
• @mgsisk/eslint-config/babel – Configuration for development with Babel using @babel/eslint-parser and extra rules form @babel/eslint-plugin.
• @mgsisk/eslint-config/typescript – Configuration for TypeScript development using @typescript-eslint/parser and extra rules from @typescript-eslint/eslint-plugin.

Installation

npm install --save-dev @mgsisk/eslint-config

Usage

// .eslintrc.yml
extends: '@mgsisk/eslint-config'

Support resources are available if you need help with this project. Refer to individual plugin documentation for more information on how each works.

Contributing

Contributions are always welcome; please read the code of conduct before you begin. See the changelog for notable project changes, and report any security concerns you find.

Thanks

To the contributors that help to build, fund, and maintain this project; the other works that have contributed to and inspired this project; and anyone that has found this project useful.

License

ISC

Changelog

Notable project changes. Versions are semantic.

Unreleased

No unreleased changes.

[4.0.0][] - 2023-12-16

Added

• ecmaVersion: latest to standard config

Changed

• File formatting now handled by Prettier
• typescript config now uses @typescript-eslint/stylistic-type-checked and @typescript-eslint/strict-type-checked

Removed

• env option from standard config
• A significant number of deprecated rules
• WordPress ESlint configuration

3.0.0 - 2021-05-07

Added

• eslint-plugin-promise
• no-nonoctal-decimal-escape
• no-unsafe-optional-chaining
• babel config with @babel/eslint-parser and @babel/eslint-plugin
• typescript config with @typescript-eslint/parser and @typescript-eslint/eslint-plugin

Changed

• env to es2021
• strict to safe
• Project structure
• Replaced CodeClimate with Codacy
• Replaced Travis with Github Actions workflow

Removed

• ecmaVersion
• sourceType

2.0.0 - 2020-09-21

Added

• default-case-last
• default-case-last
• import/no-unused-modules
• jsdoc/rquire-throws
• no-loss-of-precision
• no-promise-executor
• no-useless-backreference
• no-useless-backreference
• prefer-regex-literals
• GitHub Packages deployment

Changed

• ecmaVersion to 12
• id-length is more lenient
• eslint peer dependency to >= 7

Removed

• Deprecated Node.js and CommonJSs
• Rules from eslint-plugin-import and eslint-plugin-jsdoc that are already included in the plugin's recommended configuration

1.0.0 - 2020-04-11

Changed

• Project structure

Removed

• jsdoc/require-returns-description
• import/no-internal-modules

0.9.0 - 2020-03-09

Added

• default-param-last
• function-call-argument-newline
• grouped-accessor-pairs
• no-constructor-return
• prefer-exponentiation-operator
• require-atomic-updates
• import/no-unused-modules
• jsdoc/check-property-names
• jsdoc/check-values
• jsdoc/empty-tags
• jsdoc/require-property-description
• jsdoc/require-property-name
• jsdoc/require-property-type
• jsdoc/require-property

Changed

• Using plugin:eslint-comments/recommended
• Using plugin:eslint-import/recommended
• Using plugin:jsdoc/recommended
• Using plugin:sonarjs/recommended
• max-nested-callbacks limit reduced to 8

0.8.1 - 2019-07-30

Removed

• jsdoc/require-description

0.8.0 - 2019-07-30

Added

• no-console
• jsdoc/check-alignment
• jsdoc/check-indentation
• jsdoc/check-syntax
• jsdoc/implements-no-classes
• jsdoc/require-description
• jsdoc/require-jsdoc
• sonarjs/no-one-iteration-loop
• sonarjs/no-collapsible-if

Changed

• Replaced eslint-config-wordpress with @wordpress/eslint-plugin
• Updated package dependencies
• Updated tests for new WordPress standards

0.7.0 - 2019-02-26

Added

• jsdoc/check-examples
• jsdoc/require-returns-check
• jsdoc/require-returns

Changed

• Replaced jsonlint-cli with jsonlint
• Updated eslint plugin dependencies

0.6.2 - 2018-12-09

Changed

• Replaced js-yaml with yaml-lint
• Replaced jsonlint with jsonlint-cli

Fixed

• Missing Code Climate report ID

0.6.1 - 2018-12-07

Added

• Tests with code coverage

Changed

• Moved npm deployment to Travis configuration
• Replaced markdownlint-cli with remark-lint

0.6.0 - 2018-12-07

Added

• Quote exception to avoid escaping

Changed

• Added quote exceptions to allow template literals and avoid escaping

0.5.0 - 2018-12-06

Added

• Same-line exception for object-property-newline

0.4.2 - 2018-12-06

Fixed

• Installation instructions in readme

0.4.1 - 2018-12-06

Added

• preversion script to run tests before version bump

Changed

• postversion script now publishes to npm on version bump

Fixed

• eslint scripts
• broken URL's in repo documentation

0.4.0 - 2018-12-06

Added

• editorconfig and git-legal checks to Code Climate

Changed

• Simplified npm scripts

Removed

• WordPress-specific editorconfig settings
• Code coverage badge and checks

0.3.1 - 2018-12-05

Fixed

• Changelog links

0.3.0 - 2018-12-05

Changed

• Simplified WordPress configuration

Removed

• iojs from Travis configuration

0.2.0 - 2018-12-05

Added

• Code Climate configuration
• Travis configuration
• .npmignore file

0.1.0 - 2018-12-05

Added

• Standard ESLint configuration
• WordPress ESlint configuration