eslint-config-mia

The ESLint Shareable Config for Mia-Platform JavaScript Style

Getting Started

Install

The package require eslint to work, to list the correct version you can run:

npm info "@mia-platform/eslint-config-mia@latest" peerDependencies

NPM 5+

You can run this command:

npx install-peerdeps --dev @mia-platform/eslint-config-mia

NPM <5

Linux/macOS

You can run this command:

(
export PKG="@mia-platform/eslint-config-mia";
  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:

npm install --save-dev @mia-platform/eslint-config-mia eslint@^#.#.#

Windows

If using npm < 5, Windows users can either install all the peer dependencies manually, or use the install-peerdeps cli tool.

npm install -g install-peerdeps
install-peerdeps --dev @mia-platform/eslint-config-mia

The cli will produce and run a command like:

npm install --save-dev @mia-platform/eslint-config-mia eslint@^#.#.#

How to use it

ESLint Shareable Configs are meant to work with the extends feature of the .eslintrc file.
You can learn more about Shareable Config on the official ESLint website.

To set up the config add a file named .eslintrc with this content:

{
  "extends": "@mia-platform/eslint-config-mia"
}

Then you can override settings from the shareable configuration by adding them directly into your .eslintrc file.

Or you can add this snippet in your package.json and add the override inside the eslintConfig object:

"eslintConfig": {
  "extends": "@mia-platform/eslint-config-mia"
}

Then you can add a new script in your package.json like this:

"scripts": {
  "lint": "eslint . --ignore-path .gitignore"
}

The --ignore-path can be ignored (🙃) if you already have a .eslintignore file. We raccomend to use it for avoiding to parse and lint files that will not be committed.

Badge

You want to show that you use this in your project? Feel free to add this badge to your README file.

[![javascript style guide](https://img.shields.io/badge/code_style-standard--mia-orange.svg)](https://github.com/mia-platform/eslint-config-mia)