Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/suddi/eslint-config-suddi
Eslint configurations for Node.js, Angular.js and React.js development (https://www.npmjs.com/package/eslint-config-suddi)
https://github.com/suddi/eslint-config-suddi
eslint linting linting-rules nodejs react reactjs
Last synced: 25 days ago
JSON representation
Eslint configurations for Node.js, Angular.js and React.js development (https://www.npmjs.com/package/eslint-config-suddi)
- Host: GitHub
- URL: https://github.com/suddi/eslint-config-suddi
- Owner: suddi
- License: mit
- Created: 2016-09-04T03:39:37.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-04-07T10:49:57.000Z (almost 5 years ago)
- Last Synced: 2024-10-17T02:44:57.763Z (4 months ago)
- Topics: eslint, linting, linting-rules, nodejs, react, reactjs
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/eslint-config-suddi
- Size: 195 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# eslint-config-suddi
[](https://circleci.com/gh/suddi/eslint-config-suddi)
[](https://codecov.io/gh/suddi/eslint-config-suddi)
[](https://www.codacy.com/app/Suddi/eslint-config-suddi)
[](https://www.npmjs.com/package/eslint-config-suddi)
[](https://www.npmjs.com/package/eslint-config-suddi)
[](https://david-dm.org/suddi/eslint-config-suddi)
[](https://david-dm.org/suddi/eslint-config-suddi?type=dev)
[](https://raw.githubusercontent.com/suddi/eslint-config-suddi/master/LICENSE)
[](https://codecov.io/gh/suddi/eslint-config-suddi)
````
npm install --save-dev eslint eslint-config-suddi
````
## Rulesets
There are multiple rulesets provided:
- [suddi/angular](angular.js) - rules for angular@^1.0.0 development
- [suddi/backend](backend.js) - rules for node.js development using 4-space indentation
- [suddi/frontend](frontend.js) - rules for react development
- [suddi/node-tab](node-tab.js) - rules for node.js development using tab indentation
- [suddi/react](react.js) - rules for react development
## Usage
- Add ESLint config to your `package.json`, for running on backend code:
````
npm install --save-dev eslint eslint-config-suddi
````
```json
{
"scripts": {
"lint": "eslint ."
},
"devDependencies": {
"eslint": "^6.0.0",
"eslint-config-suddi": "^5.0.0"
},
"eslintConfig": {
"extends": "suddi/backend"
}
}
```
- Add ESLint config to your `package.json`, for running on React.js code:
````
npm install --save-dev eslint eslint-config-suddi eslint-plugin-react
````
```json
{
"scripts": {
"lint": "eslint ."
},
"devDependencies": {
"eslint": "^6.0.0",
"eslint-config-suddi": "^5.0.0",
"eslint-plugin-react": "^7.0.0"
},
"eslintConfig": {
"extends": "suddi/react"
}
}
```
- Add ESLint config to your `package.json`, for running on Angular code:
````
npm install --save-dev eslint eslint-config-suddi eslint-plugin-angular
````
```json
{
"scripts": {
"lint": "eslint ."
},
"devDependencies": {
"eslint": "^6.0.0",
"eslint-config-suddi": "^5.0.0",
"eslint-plugin-angular": "^4.0.0"
},
"eslintConfig": {
"extends": "suddi/angular"
}
}
```
- Then apply the linter with `npm run lint`.
## Examples
For examples on use cases and validation samples, please see:
* [For angular rules](test/angular/fixtures)
* [For backend rules](test/backend/fixtures)
* [For frontend rules](test/frontend/fixtures)
* [For node-tab rules](test/node-tab/fixtures)
* [For node rules](test/node/fixtures)
* [For react rules](test/react/fixtures)
## Setup for different editors
### Sublime Text
- Add the following to your `~/.bashrc` or `~/.zshrc`:
````sh
export NVM_DIR="$HOME/.nvm"
if [ -s $NVM_DIR/nvm.sh ]; then
source $NVM_DIR/nvm.sh
fi
````
- Install [`Package Control`](https://packagecontrol.io/installation)
- Install `SublimeLinter` and `SublimeLinter-contrib-eslint` via `Package Control`
- Run `npm install -g eslint eslint-config-suddi eslint-plugin-react eslint-plugin-angular`
- Restart Sublime Text
### Atom
- Install `linter` and `linter-eslint` from within the available packages
- Run `npm install -g eslint eslint-config-suddi eslint-plugin-react eslint-plugin-angular`
- Restart Atom
### Webstorm
- Install [`ESLint`](https://plugins.jetbrains.com/plugin/7494-eslint)
- Run `npm install -g eslint eslint-config-suddi eslint-plugin-react eslint-plugin-angular`
- Restart Webstorm
### Visual Studio Code
- Select `Shell Command: Install ‘code’ command in PATH` via `Command Palette`
- Install `ESLint` package from within the available extensions
- Run `npm install -g eslint eslint-config-suddi eslint-plugin-react eslint-plugin-angular`
- Restart Visual Studio Code