https://github.com/subwaytime/eslint-config
https://github.com/subwaytime/eslint-config
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/subwaytime/eslint-config
- Owner: Subwaytime
- License: mit
- Created: 2023-02-12T14:16:11.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-28T14:35:51.000Z (about 3 years ago)
- Last Synced: 2025-07-06T23:39:47.775Z (12 months ago)
- Language: JavaScript
- Size: 131 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @subwaytime/eslint-config
- Single quotes
- Auto fix for formatting (aimed to be used standalone without Prettier)
- Designed to work with TypeScript, Vue out-of-box
- Lint also for json, yaml, markdown
- Sorted imports, dangling commas
- Reasonable defaults, best practices, only one-line of config
- **Style principle**: Minimal for reading, stable for diff
## Usage
### Install
```bash
pnpm add -D eslint @subwaytime/eslint-config
```
### Config `.eslintrc`
```json
{
"extends": "@subwaytime"
}
```
> You don't need `.eslintignore` normally as it has been provided by the preset.
### Add script for package.json
For example:
```json
{
"scripts": {
"lint": "eslint .",
"lint:fix": "eslint . --fix"
}
}
```
### Config VS Code auto fix
Install [VS Code ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) and create `.vscode/settings.json`
```json
{
"prettier.enable": false,
"editor.formatOnSave": false,
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true
}
}
```
### TypeScript Aware Rules
Type aware rules are enabled when a `tsconfig.eslint.json` is found in the project root, which will introduce some stricter rules into your project. If you want to enable it while have no `tsconfig.eslint.json` in the project root, you can change tsconfig name by modifying `ESLINT_TSCONFIG` env.
```js
// .eslintrc.js
process.env.ESLINT_TSCONFIG = 'tsconfig.json'
module.exports = {
extends: '@subwaytime'
}
```
## License
[MIT](./LICENSE) License © 2023-PRESENT [Leon Langer](https://github.com/subwaytime)