Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/merkle-open/eslint-config
Default configurations for eslint
https://github.com/merkle-open/eslint-config
es2015 eslint eslintconfig eslintrc flow flowtype node react
Last synced: 2 months ago
JSON representation
Default configurations for eslint
- Host: GitHub
- URL: https://github.com/merkle-open/eslint-config
- Owner: merkle-open
- License: mit
- Created: 2016-06-16T13:58:47.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-02-23T16:25:47.000Z (11 months ago)
- Last Synced: 2024-04-23T20:53:46.191Z (9 months ago)
- Topics: es2015, eslint, eslintconfig, eslintrc, flow, flowtype, node, react
- Language: JavaScript
- Homepage:
- Size: 1.14 MB
- Stars: 13
- Watchers: 11
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ESLint config
[](https://github.com/merkle-open/eslint-config/actions)
[](https://www.npmjs.com/package/@merkle-open/eslint-config)
[](https://github.com/merkle-open/eslint-config)
## Installation
```bash
$ npm install --save-dev eslint eslint-plugin-import @merkle-open/eslint-config
```
## Usage Typescript (recommended)
- `@merkle-open/eslint-config/configurations/typescript-browser` - typescript + browser
- `@merkle-open/eslint-config/configurations/typescript-react` - typescript + react
- `@merkle-open/eslint-config/configurations/typescript-node` - typescript + node
_package.json_
```json
{
"scripts": {
"lint:ts": "eslint . --ext .jsx,.js,.ts,.tsx"
}
}
```
_Enabling ESLint on TS files in VSCode_
You need to update the eslint.validate setting to:
```json
"eslint.validate": [
"javascript",
"javascriptreact",
"typescript",
"typescriptreact"
]
```
## Usage ES8 (ES2017)
- `@merkle-open/eslint-config/configurations/es8-browser` - ES8 + browser
- `@merkle-open/eslint-config/configurations/es8-react` - ES8 + react
- `@merkle-open/eslint-config/configurations/es8-node` - ES8 + node
## Usage ES7 (ES2016)
- `@merkle-open/eslint-config/configurations/es7-browser` - ES7 + browser (deprecated)
- `@merkle-open/eslint-config/configurations/es7-react` - ES7 + react (deprecated)
- `@merkle-open/eslint-config/configurations/es7-node` - ES7 + node
## Usage ES6 (ES2015) - deprecated
- `@merkle-open/eslint-config/configurations/es6-browser` - ES6 + browser (deprecated)
- `@merkle-open/eslint-config/configurations/es6-react` - ES6 + react (deprecated)
- `@merkle-open/eslint-config/configurations/es6-node` - ES6 + node (deprecated)
## Usage with Prettier
- [configuration with prettier](./documentation/with-prettier.md)
### .eslintrc.js (add globals here if needed)
```
module.exports = {
extends: require.resolve('@merkle-open/eslint-config/configurations/es8-browser.js'),
};
```
### .eslintignore
```
/.idea/
/node_modules/
```
### package.json
```
"scripts": {
"lint": "npm run lint:js",
"lint:js": "eslint ."
},
```
then run `npm run lint`
### Example usage in project tree
- .eslintrc.js (es8-react)
- .eslintignore
- src
- app.jsx
- test
- .eslintrc.js (es8-node)
- index.js
- scripts
- .eslintrc.js (es6-node)
- index.js
## Documentation
- [Best practices](./documentation/best-practices.md) (ES5/6/7/8)
- [Style](./documentation/style.md) (ES5/6/7/8)
- [Variables](./documentation/variables.md) (ES5/6/7/8)
- [Errors](./documentation/errors.md) (ES5/6/7/8)
- [Node](./documentation/node.md) (ES5/6/7/8)
- [ES6](./documentation/es6.md) (ES6/7/8)
- [ES8](./documentation/es8.md) (ES8)
- [Imports](./documentation/imports.md) (ES6/7/8)
- [React](./documentation/react.md) (ES6/7/8)
- [React A11y](./documentation/react-a11y.md) (ES6/7/8)
- [React hooks](./documentation/react-hooks.md) (ES6/7/8)
- [Typescript](./documentation/typescript.md) (typescript)
## Build release
1. Create feature or bugfix branch based on master
2. Make changes and create pull request, add reviewer, wait for approval
3. Merge pull request into master
4. Prepare release notes, adjust package.json to next version ([Semantic Versioning](semantic versioning))
5. Run `npm publish` (locally) to create npm version
6. Create and push git tag for version
7. Add release notes on GitHub
## Thanks to
- [Merkle](https://www.merkleinc.ch/)
- [ESLint](https://github.com/eslint/eslint) for ESLint and the documentation [eslint.org](http://eslint.org/)
- [Walmart](https://github.com/walmartlabs) for sharing their config in [eslint-config-walmart](https://github.com/walmartlabs/eslint-config-walmart)
- [AirBnB](https://github.com/airbnb) for sharing their eslint config in [JavaScript Style Guide](https://github.com/airbnb/javascript)
## License
[MIT License](./LICENSE)
## Changelog
Please see the [Releases](https://github.com/merkle-open/eslint-config/releases)