eslint-config-mitmaro

eslint-config-mitmaro

This package provides MitMaro's shared extensible ESLint config.

Usage

There are two ESLint configurations for your usage.

General Setup

1. npm install --save-dev eslint-config-mitmaro eslint-plugin-filenames eslint-plugin-promise eslint-plugin-security eslint

eslint-config-mitmaro

The default export contains a set of common ESLint rules, including ECMAScript 6+.

1. add "extends": "mitmaro" to your ESLint config file

eslint-config-mitmaro/config/babel

Adds support for eslint-babel and the ESLint babel plugin.

1. Ensure you have installed the dependencies from General Setup
2. npm install --save-dev babel-eslint eslint-plugin-babel
3. add "extends": ["mitmaro", "mitmaro/config/babel"] to your ESLint config file

eslint-config-mitmaro/config/chai

1. Ensure you have installed the dependencies from General Setup
2. add "extends": "mitmaro/config/chai" to your ESLint config file

eslint-config-mitmaro/config/ecmascript-6

Adds support for ECMAScript 6 features and sets the source type to module.

1. add "extends": ["mitmaro", "mitmaro/config/ecmascript-6"] to your ESLint config file

eslint-config-mitmaro/config/ecmascript-7

Adds support for ECMAScript 7 features. This config automatically brings in eslint-config-mitmaro/config/ecmascript-6.

1. Ensure you have installed the dependencies from General Setup
2. add "extends": ["mitmaro", "mitmaro/config/ecmascript-7"] to your ESLint config file

eslint-config-mitmaro/config/ecmascript-8

Adds support for ECMAScript 8 features. This config automatically brings in eslint-config-mitmaro/config/ecmascript-7.

1. Ensure you have installed the dependencies from General Setup
2. add "extends": ["mitmaro", "mitmaro/config/ecmascript-8] to your ESLint config file

eslint-config-mitmaro/config/mocha

Adds support for mocha, disabling certain rules and adding the ESLint mocha plugin.

1. Ensure you have installed the dependencies from General Setup
2. npm install --save-dev eslint-plugin-mocha
3. add "extends": "mitmaro/config/mocha" to your ESLint config file

eslint-config-mitmaro/config/node

1. Ensure you have installed the dependencies from General Setup
2. add "extends": "mitmaro/config/node" to your ESLint config file

Note: You should config after include this after ecmascript-* configurations.

eslint-config-mitmaro/config/react

1. Ensure you have installed the dependencies from General Setup
2. npm install --save-dev eslint-plugin-react
3. add "extends": "mitmaro/config/react" to your ESLint config file

Versioning

This project follows as closely as possible Semantic Versioning. A MAJOR change would be caused by including a rule that could cause a passing code base to fail. A MINOR change is a modification or removal of a rule that would not cause existing passing code to fail. A PATCH would be any fix that doesn't cause any changes to rules.

Contributing

Add new rule definitions under the files located in rules ensuring to keep the rule correctly categorized and in the same order as defined on the ESLint rules page.

This project self-lints and ensure that all file paths are correct. You can run these checks with the npm run test command.

License

This project is released under the ISC license. See LICENSE.