Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/collaborne/eslint-config-collaborne
ES lint configuration for Collaborne projects
https://github.com/collaborne/eslint-config-collaborne
Last synced: 6 days ago
JSON representation
ES lint configuration for Collaborne projects
- Host: GitHub
- URL: https://github.com/collaborne/eslint-config-collaborne
- Owner: Collaborne
- License: apache-2.0
- Created: 2017-08-29T09:48:59.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-03-25T07:45:51.000Z (9 months ago)
- Last Synced: 2024-04-25T16:21:28.592Z (8 months ago)
- Language: JavaScript
- Size: 563 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# eslint-config-collaborne [](https://travis-ci.org/Collaborne/eslint-config-collaborne) [](https://greenkeeper.io/)
ES lint configuration for Collaborne projects
## Usage
1. Install dependencies
```sh
npm install --save-dev \
eslint-config-collaborne \
eslint@7 \
eslint-plugin-disable@2 \
eslint-plugin-import@2 \
eslint-plugin-node@11 \
eslint-plugin-prettier@3 \
eslint-plugin-promise@4 \
prettier@2
```
2. Add `.prettierrc` (configuration for prettier)
```json
{
"singleQuote": true,
"jsxSingleQuote": false,
"semi": true,
"tabWidth": 2,
"useTabs": true,
"bracketSpacing": true,
"jsxBracketSameLine": false,
"arrowParens": "avoid",
"trailingComma": "all"
}
```
3. Add `.eslintignore`
```text
node_modules
```
4. Add `.eslintrc.json`
```json
{
"extends": "collaborne"
}
```
5. Add linting scripts in `package.json`
```jsonc
{
// ...
"scripts": {
// ...
"lint": "npm run lint:ts",
"lint:ts": "eslint --report-unused-disable-directives $(node -p 'require("./tsconfig.json").include.map(include => `'\${include}.\{js,ts,tsx\}'`).join(" ")')"
// ...
}
// ...
}
```
_Note: This requires that `tsconfig.json` contains a `include` property, which should only directories, and in the format `dir/**/*`._
## Additional configuration
* Always use `overrides` to configure additional rules
* Try to document the reason for a override configuration in the commit message for traceability, and consider reporting the rule here as a future addition with the rationale