https://github.com/js-devtools/eslint-config
Opinionated JSDevTools ESLint configuration for JavaScript, TypeScript, and JSX
https://github.com/js-devtools/eslint-config
eslint eslint-config eslint-rules javascript jsx nodejs typescript
Last synced: 12 days ago
JSON representation
Opinionated JSDevTools ESLint configuration for JavaScript, TypeScript, and JSX
- Host: GitHub
- URL: https://github.com/js-devtools/eslint-config
- Owner: JS-DevTools
- License: mit
- Created: 2020-07-13T09:30:04.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-05-11T17:04:43.000Z (about 3 years ago)
- Last Synced: 2024-03-25T20:07:21.341Z (about 1 year ago)
- Topics: eslint, eslint-config, eslint-rules, javascript, jsx, nodejs, typescript
- Language: JavaScript
- Homepage: https://jstools.dev/eslint-config/
- Size: 1.09 MB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
ESLint Config
==============================================
### Opinionated JSDevTools ESLint config for JavaScript, TypeScript, and JSX
[](https://github.com/JS-DevTools/eslint-config/actions)
[](https://github.com/JS-DevTools/eslint-config/actions)
[](https://coveralls.io/github/JS-DevTools/eslint-config2)
[](https://david-dm.org/JS-DevTools/eslint-config)
[](https://www.npmjs.com/package/@jsdevtools/eslint-config)
[](LICENSE)
[](https://plant.treeware.earth/JS-DevTools/eslint-config)
This is a [shareable config](https://eslint.org/docs/developer-guide/shareable-configs) for [ESLint](https://eslint.org/) that's used for [JSDevTools projects](https://jstools.dev). It's highly opinionated and tailored to the types of projects we build, so it's probably not relevant to you. But nonetheless, it could be a good starting point for creating your own custom shareable config.
This config uses [ESLint's `overrides` feature](https://eslint.org/docs/user-guide/configuring#configuration-based-on-glob-patterns) to apply different rulesets to different files based on glob patterns. It currently includes rulesets for JavaScript, TypeScript, and JSX files, as well more relaxed rulesets for test files in any of those languages.
Related Projects
-----------------------
- [eslint-config-modular](https://jstools.dev/eslint-config-modular/)
Modular ESLint configuration
- [tslint-modular](https://jstools.dev/tslint-modular/)
Modular TSLint configuration for TypeScript projects
Installation
-----------------------
Run the following [npm](https://docs.npmjs.com/about-npm/) command to install [ESLint](https://eslint.org/) and our ESLint config as dev-dependencies of your project:
```bash
npm install eslint @jsdevtools/eslint-config --save-dev
```
Usage
-----------------------
Shareable configs are designed to work with the `extends` feature of `.eslintrc` files. You can learn more about
[Shareable Configs](https://eslint.org/docs/developer-guide/shareable-configs) on the official ESLint website.
To use our ESLint config in your project, create an `.eslintrc.yml` file with the following contents:
**.eslintrc.yml**
```yaml
root: true
extends: "@jsdevtools"
rules:
# You can override any rules here
```
License
--------------------------
Our ESLint config is 100% free and open-source, under the [MIT license](LICENSE). Use it however you want.
This package is [Treeware](http://treeware.earth). If you use it in production, then we ask that you [**buy the world a tree**](https://plant.treeware.earth/JS-DevTools/eslint-config) to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.
Big Thanks To
--------------------------
Thanks to these awesome companies for their support of Open Source developers ❤
[](https://github.com/open-source)
[](https://www.npmjs.com/)
[](https://coveralls.io)
[](https://travis-ci.com)
[](https://saucelabs.com)