Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fausttobias/eslint-config
:mag: General purpose ECMAScript and TypeScript eslint config
https://github.com/fausttobias/eslint-config
code-quality eslint-config linter-config
Last synced: 22 days ago
JSON representation
:mag: General purpose ECMAScript and TypeScript eslint config
- Host: GitHub
- URL: https://github.com/fausttobias/eslint-config
- Owner: FaustTobias
- License: mit
- Created: 2020-01-21T22:58:23.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-05-12T20:41:10.000Z (over 4 years ago)
- Last Synced: 2024-12-15T05:26:57.459Z (25 days ago)
- Topics: code-quality, eslint-config, linter-config
- Language: JavaScript
- Homepage:
- Size: 19.5 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
@faustt/eslint-config
General purpose ECMAScript and TypeScript eslint config
## Introduction
This is a general purpose eslint config for ECMAScript and TypeScript projects. It enforces some coding standards I personally prefer over the default ones. Prettier is also included to allow advanced formatting. Feel free to peek into the index.js file to see the configuration. TODO: Document the rules used in this config, duh.
## Getting started
### Install the package
using npm:
```
npm i -D @faustt/eslint-config
```
or using yarn:
```
yarn add -D @faustt/eslint-config
```
### Install all peer dependencies
using npm:
```
npm i -D @typescript-eslint/[email protected] @typescript-eslint/[email protected] [email protected] [email protected] [email protected] [email protected] typescript
```
or using yarn:
```
yarn add -D @typescript-eslint/[email protected] @typescript-eslint/[email protected] [email protected] [email protected] [email protected] [email protected] typescript
```
### Add to eslint configuration
inside an .eslintrc file:
```
{
"extends": "@faustt"
}
```
or inside package.json:
```
{
"devDependencies": {
// ...
},
"eslintConfig": {
"extends": "@faustt"
}
}
```
### Configure Visual Studio Code
To configure Visual Studio Code to automatically fix on save install the [eslint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) and enable it in the .vscode/settings.json files. Note: I recommend committing the following two files into your repository since contributors may or may not have eslint enabled at all in their user configs.
```
{
"eslint.enable": true,
"eslint.validate": [
"javascript",
"typescript"
],
"editor.codeActionsOnSave": {
"source.fixAll": true
},
"[javascript]": {
"editor.formatOnSave": false
},
"[typescript]": {
"editor.formatOnSave": false
}
}
```
Add the eslint extension to the .vscode/extensions.json:
```
{
"recommendations": [
"dbaeumer.vscode-eslint"
]
}
```
### Add a tsconfig.json
This config requires a tsconfig.json in the root directory of the project as its rules require type information to be present. You can use your own or this one, doesn't really matter:
```
{
"compilerOptions": {
"strict": true,
"target": "ESNext",
"module": "CommonJS",
"moduleResolution": "node",
"esModuleInterop": true,
"allowSyntheticDefaultImports": true
},
"include": [
"src/**/*"
]
}
```
## Contributing
Issues or pull requests are welcome! \o/
## Maintainer
[Tobias Faust](https://github.com/FaustTobias)