Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lumigu/eslint-config-lumigu
ESLint configuration for Lumigu ECMAScript projects.
https://github.com/lumigu/eslint-config-lumigu
config eslint eslint-config
Last synced: 12 days ago
JSON representation
ESLint configuration for Lumigu ECMAScript projects.
- Host: GitHub
- URL: https://github.com/lumigu/eslint-config-lumigu
- Owner: lumigu
- License: mit
- Created: 2019-02-14T01:52:56.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-02-11T15:55:18.000Z (almost 3 years ago)
- Last Synced: 2024-12-27T09:28:49.677Z (about 1 month ago)
- Topics: config, eslint, eslint-config
- Language: JavaScript
- Size: 96.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# eslint-config-lumigu
ESLint configuration for Lumigu ECMAScript projects.
## Install
Add the `eslint-config-lumigu` module and its peer dependencies to `devDependencies`:
```sh
$ npm install eslint-config-lumigu eslint eslint-plugin-import eslint-plugin-node -D
```## Usage
[Shareable configurations](https://eslint.org/docs/developer-guide/shareable-configs) are meant to be used with the `extends` feature in `.eslintrc` files. First, in the root of your project create a new `.eslintrc` file:
```sh
$ touch .estlingrc
```Second, open your new `.eslintrc` file in your favorite editor, and the following JSON object:
```json
{
"extends": "lumigu"
}
```You can add your own customization by adding overrides to the `rules` property.
Finally, you can validate your ECMAScript project by adding an NPM script to your `package.json` file:
```json
{
"scipts": {
"lint": "eslint . --config=eslintrc",
}
}
```