Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/moxystudio/eslint-config
MOXY eslint configuration to be used across several JavaScript projects
https://github.com/moxystudio/eslint-config
coding-standards coding-style eslint eslint-config javascript
Last synced: about 1 month ago
JSON representation
MOXY eslint configuration to be used across several JavaScript projects
- Host: GitHub
- URL: https://github.com/moxystudio/eslint-config
- Owner: moxystudio
- License: mit
- Created: 2017-02-04T15:05:36.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2021-07-13T09:24:47.000Z (over 3 years ago)
- Last Synced: 2024-10-04T21:32:46.440Z (about 2 months ago)
- Topics: coding-standards, coding-style, eslint, eslint-config, javascript
- Language: JavaScript
- Homepage:
- Size: 3.38 MB
- Stars: 13
- Watchers: 10
- Forks: 5
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# eslint-config
[![Build Status][travis-image]][travis-url] [![Coverage Status][codecov-image]][codecov-url]
[travis-url]:https://travis-ci.org/moxystudio/eslint-config
[travis-image]:https://img.shields.io/travis/moxystudio/eslint-config/master.svg
[codecov-url]:https://codecov.io/gh/moxystudio/eslint-config
[codecov-image]:https://img.shields.io/codecov/c/github/moxystudio/eslint-config/master.svg
MOXY's set of [ESLint](http://eslint.org/) configuration packages to be used across several JavaScript projects.
## How it works
This repository contains two sets of _ESLint_ configurations to be used in JavaScript projects:
- the **base** configuration, which defines the common ESLint rules, the ECMAScript version and the module system.
- the **enhancers**, which contain specific settings for different frameworks, like React or Vue.
By using one or more of these packages, you can enforce the desired code styles for each type of project.
For more information on how to use each package and their specific configurations, please read the package's README by following the links below. You may also check the examples listed in [Typical Configs](#typical-configs) to see how the packages may be combined for the most common scenarios.
### Base config
The base config is published as [`@moxy/eslint-config-base`](packages/eslint-config-base), check out its README to know how to use it.
### Enhancer configs
There are several **enhancer** packages, which are intended to be used in conjunction with the **base** configuration:
- [`@moxy/eslint-config-babel`](packages/eslint-config-babel/) - If you are going to use [Babel](https://babeljs.io/) to transpile source code.
- [`@moxy/eslint-config-jest`](packages/eslint-config-jest/) - If you are going to use [Jest](https://facebook.github.io/jest/) to develop tests.
- [`@moxy/eslint-config-react`](packages/eslint-config-react/) - If you are going to use [React](https://reactjs.org/).
- [`@moxy/eslint-config-react-web-a11y`](packages/eslint-config-react-web-a11y/) - If you want to detect accessibility issues in web projects based on [React](https://reactjs.org/).
- [`@moxy/eslint-config-vue`](packages/eslint-config-vue/) - If you are going to use [Vue](https://vuejs.org/).
- [`@moxy/eslint-config-react-native`](packages/eslint-config-react-native/) - If you are going to use [React Native](https://reactnative.dev/).
- [`@moxy/eslint-config-react-native-a11y`](packages/eslint-config-react-native-a11y/) - If you want to detect accessibility issues in [React Native](https://reactnative.dev/) apps.
## Typical configs
Standard JavaScript project
```json
{
"root": true,
"env": {
"browser": true
},
"extends": [
"@moxy/eslint-config-base/esm",
"@moxy/eslint-config-babel",
"@moxy/eslint-config-jest"
]
}
```
ℹ️ If your project is isomorphic / universal, you may want to enable the `node` environment as well.
React web project
```json
{
"root": true,
"env": {
"browser": true
},
"extends": [
"@moxy/eslint-config-base/esm",
"@moxy/eslint-config-babel",
"@moxy/eslint-config-react",
"@moxy/eslint-config-react-web-a11y",
"@moxy/eslint-config-jest"
]
}
```
ℹ️ If your project is Isomorphic / Universal, you may want to enable the `node` environment as well.
Node.js project
```json
{
"root": true,
"env": {
"node": true
},
"extends": [
"@moxy/eslint-config-base/cjs/es2019",
"@moxy/eslint-config-jest"
]
}
```
⚠️ In the above example, we choose the `es2019` version instead of the latest ECMAScript version because there's no Babel compilation and we are restricted to what the Node.js runtime supports. Please check [node.green](https://node.green/) and select the most appropriate ECMAScript version based on the Node.js version you are targeting.
React Native apps
```json
{
"root": true,
"extends": [
"@moxy/eslint-config-base/esm",
"@moxy/eslint-config-babel",
"@moxy/eslint-config-react",
"@moxy/eslint-config-react-native",
"@moxy/eslint-config-react-native-a11y",
"@moxy/eslint-config-jest"
]
}
```
## Older versions
If you want to read the changelog of an older version, please check [here](https://github.com/moxystudio/eslint-config/blob/v10.1.1/CHANGELOG.md).
## License
[MIT License](http://opensource.org/licenses/MIT)