Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/riophae/eslint-config-riophae

The customized ESLint config for the development of my open-source projects.
https://github.com/riophae/eslint-config-riophae

eslint eslint-config eslint-rules nodejs

Last synced: 7 days ago
JSON representation

The customized ESLint config for the development of my open-source projects.

Awesome Lists containing this project

README

        

# eslint-config-riophae [![npm](https://badgen.now.sh/npm/v/eslint-config-riophae)](https://www.npmjs.com/package/eslint-config-riophae) [![Build](https://badgen.now.sh/travis/riophae/eslint-config-riophae)](https://travis-ci.org/riophae/eslint-config-riophae) [![Known vulnerabilities](https://snyk.io/test/npm/eslint-config-riophae/badge.svg)](https://snyk.io/test/npm/eslint-config-riophae)

The customized ESLint shareable configs for the development of my open-source projects.

## Usage

First, install this package and its peer dependencies. The command to run is depending on your npm version.



npm Version
Command
Notes




v7 or later
npm install --save-dev eslint-config-riophae
npm will automatically install peer deps for you.


prior to v6
npm install --save-dev eslint eslint-plugin-node eslint-plugin-unicorn eslint-plugin-import eslint-config-riophae


Secondly, choose a preset from the following:


Preset Name
Description
Notes


riophae
For linting ES6+.



riophae/vue-v3 for Vue 3
For linting ES6+ & .vue files.
Install one more dependency:
eslint-plugin-vue


riophae/vue-v2 for Vue 2


riophae/legacy
For linting ES5.

Thirdly and lastly, add the preset you just chose to your ESLint config file in the `extends` field:

```js
{
"extends": [ "riophae" ],
"rules": {
// override if necessary
}
}
```

## License

MIT © [Riophae Lee](https://github.com/riophae)