https://github.com/paralect/eslint-config
Paralect eslint config for Javascript products
https://github.com/paralect/eslint-config
paralect-stack
Last synced: 6 months ago
JSON representation
Paralect eslint config for Javascript products
- Host: GitHub
- URL: https://github.com/paralect/eslint-config
- Owner: paralect
- License: mit
- Created: 2017-10-06T08:03:59.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-07-05T13:33:20.000Z (over 6 years ago)
- Last Synced: 2024-04-24T04:11:53.896Z (over 1 year ago)
- Topics: paralect-stack
- Language: JavaScript
- Homepage:
- Size: 8.79 KB
- Stars: 1
- Watchers: 12
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# ESLint config
ESLint configuration. Currently based on [eslint-config-airbnb](https://github.com/airbnb/javascript).
### Usage
Our default export contains all of our ESLint rules, including ECMAScript 6+ and React. It requires `eslint`, `babel-eslint`, `eslint-plugin-import`, `eslint-plugin-react`, and `eslint-plugin-jsx-a11y`.
1. Install the correct versions of each package, which are listed by the command:
```bash
npm info "@paralect/eslint-config@latest" peerDependencies
```
Linux/OSX users can run
```bash
(
export PKG=@paralect/eslint-config;
npm info "$PKG@latest" peerDependencies --json | command sed 's/[\{\},]//g ; s/: /@/g' | xargs npm install --save-dev "$PKG@latest"
)
```
Which produces and runs a command like:
```bash
npm install --save-dev @paralect/eslint-config eslint@#.#.# babel-eslint@#.#.# eslint-plugin-import@#.#.# eslint-plugin-react@#.#.# eslint-plugin-jsx-a11y@#.#.#
```
Windows users can either install all the peer dependencies manually, or use the [install-peerdeps](https://github.com/nathanhleung/install-peerdeps) cli tool.
```bash
npm install -g install-peerdeps
install-peerdeps --dev @paralect/eslint-config
```
The cli will produce and run a command like:
```bash
npm install --save-dev @paralect/eslint-config eslint@#.#.# babel-eslint@#.#.# eslint-plugin-import@#.#.# eslint-plugin-react@#.#.# eslint-plugin-jsx-a11y@#.#.#
```
2. Add `"extends": "@paralect/eslint-config"` to your .eslintrc
```javascript
module.exports = {
"extends": "@paralect/eslint-config"
}
```
This configuration of the ESLint can be changed. See how to configure ESLint on the [official site](https://eslint.org/docs/user-guide/configuring).