eslint-config-mia

The ESLint Shareable Config for Mia-Platform JavaScript Style

Getting Started

Requirements

• Node.js 18+

Install

You can easily install the package with npm:

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

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

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

To be sure to install a compatible eslint-config-mia version, you can also check this table:

| eslint version | eslint-config-mia version | | -------------- | ------------------------- | | 6.8.0 | 3.0.0 | | 8.x | 8.0.0 | | 9.x | 9.0.0 |

How to use it

ESLint v9 (flat config)

This package exports an ESLint v9 flat config array. Spread it directly into your eslint.config.js:

const miaConfig = require('@mia-platform/eslint-config-mia')

module.exports = [
  ...miaConfig,
]

Adding a lint script

Add a lint script in your package.json:

"scripts": {
  "lint": "eslint ."
}

Then you can override rules by adding additional config objects to your eslint.config.js:

const miaConfig = require('@mia-platform/eslint-config-mia')

module.exports = [
  ...miaConfig,
  {
    rules: {
      // your overrides here
    },
  },
]

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)