https://github.com/mutoe/eslint-config-preset
https://github.com/mutoe/eslint-config-preset
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mutoe/eslint-config-preset
- Owner: mutoe
- License: mit
- Created: 2021-12-28T17:40:56.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-12-08T18:27:32.000Z (over 2 years ago)
- Last Synced: 2025-06-06T12:52:41.140Z (12 months ago)
- Language: JavaScript
- Size: 2.37 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @mutoe/eslint-config-preset
> Import from [@osdoc-dev](https://github.com/osdoc-dev/eslint-config-preset), Thanks.
## Version
### `eslint-config-standard`
[](https://github.com/standard/eslint-config-standard)
## Usage
### install package
```bash
pnpm i -D eslint @mutoe/eslint-config-preset
# or
pnpm add -D eslint @mutoe/eslint-config-preset-vue # vue project
pnpm add -D eslint @mutoe/eslint-config-preset-react # react project
pnpm add -D eslint @mutoe/eslint-config-preset-ts # nodejs project
```
### use in config js
Config list (choose one):
- `@mutoe/eslint-config-preset-basic` (basic javascript + json + yaml lint rules)
- `@mutoe/eslint-config-preset-ts` (support basic + typescript rules)
- `@mutoe/eslint-config-preset-react` (support typescript + react + accessibility rules)
- `@mutoe/eslint-config-preset-vue` (support typescript + vue rules)
- `@mutoe/eslint-config-preset-jest` (support jest rules)
- `@mutoe/eslint-config-preset` (support all above rules)
```javascript .eslintrc.js
module.exports = {
"extends": [
"@mutoe/eslint-config-preset-react",
"@mutoe/eslint-config-preset-jest",
]
}
```
or using with typescript advanced rules (need typescript parser)
> This will slow down your lint process in large project. Please use with caution.
```javascript .eslintrc.js
// If your tsconfig not the default `tsconfig.json`, you can using following command to assign a tsconfig to parse your typescript project
// process.env.ESLINT_TSCONFIG = 'tsconfig.build.json'
module.exports = {
"extends": [
"@mutoe/eslint-config-preset-ts/with-parser",
"@mutoe/eslint-config-preset-react"
]
}
```
### Configurable rules
```javascript .eslintrc.js
// your .eslintrc.js
process.env.ESLINT_INDENT = 4 // default 2
process.env.ESLINT_SEMI = 'always' // default 'never'
process.env.ESLINT_SPACE_BEFORE_FUNCTION_PAREN = 'never' // default 'always'
module.exports = {
"extends": [
"@mutoe/eslint-config-preset",
]
}
```
## Development
```bash
pnpm link
```
## Release
```bash
pnpm release
```
This will be auto generate CHANGELOG by your commits (via --conventional-commits in lerna) and publish version to npm and git repository.