Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kainstar/eslint-config
My personal eslint config.
https://github.com/kainstar/eslint-config
Last synced: about 1 month ago
JSON representation
My personal eslint config.
- Host: GitHub
- URL: https://github.com/kainstar/eslint-config
- Owner: kainstar
- License: mit
- Created: 2024-01-15T02:53:52.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-03-19T03:11:43.000Z (8 months ago)
- Last Synced: 2024-09-27T09:19:28.704Z (about 2 months ago)
- Language: TypeScript
- Size: 460 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @kainstar/eslint-config
[![npm package][npm-img]][npm-url] [![Build Status][build-img]][build-url] [![Downloads][downloads-img]][downloads-url] [![Issues][issues-img]][issues-url] [![Commitizen Friendly][commitizen-img]][commitizen-url] [![Semantic Release][semantic-release-img]][semantic-release-url]
ESLint config for kainstar projects
Thanks antfu's [eslint-config](https://github.com/antfu/eslint-config), this project references it a lot, and do some changes to fit my needs.
- All plugins as dependencies, don't need to install them manually
- TypeScript is basic, so remove or off some rules that can be checked by the TypeScript compiler.
- Stop check style (should use stylelint) and other file types not used usually.
## Usage
### Install
```bash
pnpm i -D eslint @kainstar/eslint-config
```
### Create config file
With [`"type": "module"`](https://nodejs.org/api/packages.html#type) in `package.json` (recommended):
```js
// eslint.config.js
import kainstar from '@kainstar/eslint-config';
export default kainstar();
```
## 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 `.vscode/settings.json`:
```jsonc
{
// Enable the ESlint flat config support
"eslint.experimental.useFlatConfig": true,
// Auto fix
"editor.codeActionsOnSave": {
"source.fixAll.eslint": "explicit",
"source.organizeImports": "never",
},
// Silent the stylish related rules in you IDE, but still auto fix them
"eslint.rules.customizations": [
{ "rule": "prettier/prettier", "severity": "off" },
{ "rule": "*-indent", "severity": "off" },
{ "rule": "*-spacing", "severity": "off" },
{ "rule": "*-order", "severity": "off" },
{ "rule": "*-newline", "severity": "off" },
],
// Enable eslint for all supported languages
"eslint.validate": [
"javascript",
"javascriptreact",
"typescript",
"typescriptreact",
"vue",
"html",
"markdown",
"yaml",
],
}
```
[build-img]: https://github.com/kainstar/eslint-config/actions/workflows/release.yml/badge.svg
[build-url]: https://github.com/kainstar/eslint-config/actions/workflows/release.yml
[downloads-img]: https://img.shields.io/npm/dt/@kainstar/eslint-config
[downloads-url]: https://www.npmtrends.com/@kainstar/eslint-config
[npm-img]: https://img.shields.io/npm/v/@kainstar/eslint-config
[npm-url]: https://www.npmjs.com/package/@kainstar/eslint-config
[issues-img]: https://img.shields.io/github/issues/kainstar/eslint-config
[issues-url]: https://github.com/kainstar/eslint-config/issues
[semantic-release-img]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
[semantic-release-url]: https://github.com/semantic-release/semantic-release
[commitizen-img]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
[commitizen-url]: http://commitizen.github.io/cz-cli/