eslint-config-mulesoft-base

Mulesoft's base JS ESLint config, following our styleguide

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
eslint-config-mulesoft-base
0.2.08 years ago8 years agoMinified + gzip package size for eslint-config-mulesoft-base in KB

Readme

eslint-config-mulesoft-base
npm version
This package provides Mulesoft's base JS .eslintrc as an extensible shared config.

Usage

We export two ESLint configurations for your usage.

eslint-config-mulesoft-base

Our default export contains all of our ESLint rules, including ECMAScript 6+. It requires eslint and eslint-plugin-import.
  1. Ensure packages are installed with correct version numbers by running:
```sh (
export PKG=eslint-config-mulesoft-base;
npm info "$PKG@latest" peerDependencies --json | command sed 's/[\{\},]//g ; s/: /@/g' | xargs npm install --save-dev "$PKG@latest"
) ```
Which produces and runs a command like:
```sh <<<<<<< 017dfa81fa2ffbb191ddb28240aa6098837b8d1b:packages/eslint-config-airbnb-base/README.md
npm install --save-dev eslint-config-airbnb-base eslint@^#.#.# eslint-plugin-import@^#.#.#
=======
npm install --save-dev eslint-config-mulesoft-base eslint@^3.0.1 eslint-plugin-import@^1.10.3
>>>>>>> airbnb -> mulesoft (#1):packages/eslint-config-mulesoft-base/README.md ```
  1. Add "extends": "airbnb-base" to your .eslintrc

eslint-config-mulesoft-base/legacy

Lints ES5 and below. Requires eslint and eslint-plugin-import.
  1. Ensure packages are installed with correct version numbers by running:
```sh (
export PKG=eslint-config-mulesoft-base;
npm info "$PKG" peerDependencies --json | command sed 's/[\{\},]//g ; s/: /@/g' | xargs npm install --save-dev "$PKG"
) ```
Which produces and runs a command like:
```sh npm install --save-dev eslint-config-mulesoft-base eslint@^3.0.1 eslint-plugin-import@^1.10.3 ```
  1. Add "extends": "mulesoft-base/legacy" to your .eslintrc

See Mulesoft's overarching ESLint config, Mulesoft's Javascript styleguide, and the ESlint config docs for more information.

Improving this config

Consider adding test cases if you're making complicated rules changes, like anything involving regexes. Perhaps in a distant future, we could use literate programming to structure our README as test cases for our .eslintrc?
You can run tests with npm test.
You can make sure this module lints with itself using npm run lint.