https://github.com/leedomjs/eslint-config

🔧「ESLint配置预设」Leedom's ESLint config presets
https://github.com/leedomjs/eslint-config

eslint eslint-config

Last synced: 6 months ago
JSON representation

🔧「ESLint配置预设」Leedom's ESLint config presets

Host: GitHub
URL: https://github.com/leedomjs/eslint-config
Owner: leedomjs
License: mit
Created: 2023-08-18T10:05:30.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2025-04-29T15:48:31.000Z (8 months ago)
Last Synced: 2025-06-11T09:21:38.169Z (6 months ago)
Topics: eslint, eslint-config
Language: JavaScript
Homepage:
Size: 192 KB
Stars: 1
Watchers: 0
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# @leedomjs/eslint-config

> Inspired by [@antfu/eslint-config](https://github.com/antfu/eslint-config)

[![npm](https://img.shields.io/npm/v/@leedomjs/eslint-config?color=333&label=)](https://www.npmjs.com/package/@leedomjs/eslint-config)

- Support Vue 2 & 3
- Single quotes, no semi
- Auto fix for formatting
- Also lint for TypeScript, json
- Order tailwindcss classnames
- Only one-line of config

## Usage

### Install

```bash
pnpm add -D eslint @leedomjs/eslint-config
```

### Config `.eslintrc`

```json
{
"extends": "@leedomjs"
}
````

### Add scripts for `package.json`

For example:

```json
{
"scripts": {
"lint": "eslint .",
"lint:fix": "eslint . --fix"
}
}
```

### VS Code support (auto fix)

Install [VS Code ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)

Add the following settings to your `settings.json`:

```jsonc
{
"editor.formatOnSave": false,
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true,
"source.organizeImports": false
},

// The following is optional.
// It's better to put under project setting `.vscode/settings.json`
// to avoid conflicts with working with different eslint configs.
"eslint.validate": [
"javascript",
"javascriptreact",
"typescript",
"typescriptreact",
"vue",
"html",
"vue-html",
"jsx",
"json",
"jsonc",
"json5",
"markdown",
"yaml"
]
}
```

### Lint and auto-fix before every commit

If you want to apply lint and auto-fix before every commit, you could do this:

#### 1. [husky](https://github.com/typicode/husky) + [`lint-staged`](https://github.com/okonet/lint-staged)

```bash
pnpm dlx husky-init && pnpm install -D husky lint-staged
```

and add the following to your `package.json`:

```jsonc
{
"scripts": {
// This script will be added automatically when husky is installed successfully.
"prepare": "husky install"
},
"lint-staged": {
"*": "eslint --fix"
}
}
```

then add the following to your `pre-commit`:

> .husky/pre-commit

```sh
#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

# remove the default script
# npx test

# add this script
npx lint-staged
```

#### 2. [simple-git-hooks](https://github.com/toplenboren/simple-git-hooks) + [`lint-staged`](https://github.com/okonet/lint-staged)

If your project is small-sized, and you need quickly set up hooks and forget about it, `simple-git-hook` will be a good choice.

```bash
pnpm install -D simple-git-hooks lint-staged
```

and add the following to your `package.json`:

```jsonc
{
"simple-git-hooks": {
"pre-commit": "npx lint-staged"
},
"lint-staged": {
"*": "eslint . --fix"
}
}
```

then run the CLI script to update the git hooks with the commands from the config:

```bash
# [Optional] These 2 steps can be skipped for non-husky users
git config core.hooksPath .git/hooks/
rm -rf .git/hooks

# Update ./git/hooks
npx simple-git-hooks
```

## Tips

You can override the rules in your `.eslintrc` file.

```jsonc
{
"extends": "@leedomjs",
"rules": {
// your rules...
}
}
```

No framework used, just for javascript, you can also use the package `@leedomjs/eslint-config-basic`
```jsonc
// .eslintrc
{
"extends": "@leedomjs/eslint-config-basic"
}
```

If you are using `tailwindcss` , you can also add the package `@leedomjs/eslint-config-tailwindcss` which depend on [`eslint-plugin-tailwindcss`](https://github.com/francoismassart/eslint-plugin-tailwindcss) , so you don't need to add [`prettier-plugin-tailwindcss`](https://github.com/tailwindlabs/prettier-plugin-tailwindcss) and [`prettier`](https://github.com/prettier/prettier) extra.
```jsonc
// .eslintrc
{
"extends": [
"@leedomjs/eslint-config-tailwindcss",
...
]
}
```

## License
[MIT](https://github.com/leedomjs/eslint-config/blob/main/LICENSE) License © 2023-present [Leedom](https://github.com/leedom92)

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/leedomjs/eslint-config

Awesome Lists containing this project

README