Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mia-platform/eslint-config-mia
ESLint Config for JavaScript Mia-Platform Style
https://github.com/mia-platform/eslint-config-mia
development ecmascript es2018 eslint-config javascript linter-config mia-platform nodejs style-guide
Last synced: 4 months ago
JSON representation
ESLint Config for JavaScript Mia-Platform Style
- Host: GitHub
- URL: https://github.com/mia-platform/eslint-config-mia
- Owner: mia-platform
- License: mit
- Created: 2017-08-02T16:32:17.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-03T16:23:59.000Z (almost 2 years ago)
- Last Synced: 2024-04-27T02:40:47.267Z (9 months ago)
- Topics: development, ecmascript, es2018, eslint-config, javascript, linter-config, mia-platform, nodejs, style-guide
- Language: JavaScript
- Homepage: https://www.mia-platform.eu
- Size: 50.8 KB
- Stars: 11
- Watchers: 9
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# eslint-config-mia
[![Build Status][travis-svg]][travis-org]
[![javascript style guide][standard-mia-svg]][standard-mia]
[![NPM version][npmjs-svg]][npmjs-com]
**The ESLint [Shareable Config][share-config] for Mia-Platform JavaScript Style**
## Getting Started
### Install
The package require `eslint` to work, to list the correct version you can run:
```sh
npm info "@mia-platform/eslint-config-mia@latest" peerDependencies
```
### NPM 5+
You can run this command:
```sh
npx install-peerdeps --dev @mia-platform/eslint-config-mia
```
### NPM <5
#### Linux/macOS
You can run this command:
```sh
(
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:
```sh
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](https://github.com/nathanhleung/install-peerdeps) cli tool.
```sh
npm install -g install-peerdeps
install-peerdeps --dev @mia-platform/eslint-config-mia
```
The cli will produce and run a command like:
```sh
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][share-config] on the official ESLint website.
To set up the config add a file named `.eslintrc` with this content:
```json
{
"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:
```json
"eslintConfig": {
"extends": "@mia-platform/eslint-config-mia"
}
```
Then you can add a new script in your `package.json` like this:
```json
"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][standard-mia-svg]][standard-mia]
```markdown
[](https://github.com/mia-platform/eslint-config-mia)
```
[travis-svg]: https://travis-ci.org/mia-platform/eslint-config-mia.svg?branch=master
[travis-org]: https://travis-ci.org/mia-platform/eslint-config-mia
[standard-mia-svg]: https://img.shields.io/badge/code_style-standard--mia-orange.svg
[standard-mia]: https://github.com/mia-platform/eslint-config-mia
[npmjs-svg]: https://img.shields.io/npm/v/@mia-platform/eslint-config-mia.svg?logo=npm
[npmjs-com]: https://www.npmjs.com/package/@mia-platform/eslint-config-mia
[share-config]: http://eslint.org/docs/developer-guide/shareable-configs