https://github.com/robole/eslint-config-node-roboleary
Config for ESLint for a Node environment
https://github.com/robole/eslint-config-node-roboleary
eslint-node eslint-prettier-node node nodejs
Last synced: 3 months ago
JSON representation
Config for ESLint for a Node environment
- Host: GitHub
- URL: https://github.com/robole/eslint-config-node-roboleary
- Owner: robole
- Created: 2021-07-28T07:42:47.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-25T14:02:57.000Z (about 1 year ago)
- Last Synced: 2024-12-30T10:52:41.430Z (5 months ago)
- Topics: eslint-node, eslint-prettier-node, node, nodejs
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/eslint-config-roboleary-node
- Size: 39.1 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# eslint-config-node-roboleary
These are my settings for using ESLint and Prettier happily together for a Node environment.
It includes the following:
- My base config [eslint-config-roboleary-base](https://www.npmjs.com/package/eslint-config-roboleary-base) config for a core collection of rules.
- The [eslint-plugin-node](https://www.npmjs.com/package/eslint-plugin-node) for a set of rules for node.
- The [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) config to turn off the ESLint rules that conflict or are unnecessary when using Prettier. Ensure this is the last config included.
## Usage
1. Install this package, ESLint (peer dependency) and Prettier (peer dependency) as *devDependencies* with the command `npm i --save-dev eslint prettier eslint-config-node-roboleary`.
1. Create an eslint config file in the root of your project directory e.g. *.eslintrc*. Add the following:
```json
{
"extends": ["eslint-config-node-roboleary"]
}
```
Alternatively, you can put a reference to the config in your *package.json* under the property `eslintConfig`.
1. You can add scripts to your *package.json* to lint, fix, and format your code from the command-line.
```json
{
"scripts": {
"lint": "eslint .",
"lint:fix": "npm run lint -- --fix",
"format": "prettier src test --check",
"format:fix": "npm run prettier -- --write",
},
}
```