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

Lucas's ESLint config presets
https://github.com/ycs77/eslint-config

Last synced: about 1 month ago
JSON representation

Lucas's ESLint config presets

• Host: GitHub
• URL: https://github.com/ycs77/eslint-config
• Owner: ycs77
• License: mit
• Created: 2022-06-16T20:51:37.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-27T07:14:05.000Z (about 2 months ago)
• Last Synced: 2024-09-28T11:42:35.740Z (about 2 months ago)
• Language: TypeScript
• Homepage:
• Size: 958 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @ycs77/eslint-config

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

[![NPM version][ico-version]][link-npm]

[![Software License][ico-license]](LICENSE)

[![GitHub Tests Action Status][ico-github-action]][link-github-action]

[![Total Downloads][ico-downloads]][link-downloads]

- Auto fix for formatting (aimed to be used standalone **without** Prettier)

- Reasonable defaults, best practices, only one line of config

- Designed to work with TypeScript, JSX, Vue, JSON, YAML, Toml, Markdown, etc. Out-of-box.

- Opinionated, but [very customizable](#customization)

- [ESLint Flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new), compose easily!

- **Style principle**: Minimal for reading, stable for diff, consistent

  - Sorted imports, dangling commas

  - Single quotes, no semi

  - Using [ESLint Stylistic](https://github.com/eslint-stylistic/eslint-stylistic)

- Respects `.gitignore` by default

- Requires ESLint v9.5.0+

## Usage

### Install

```bash

yarn add eslint @ycs77/eslint-config -D

```

### Create config file

Create `eslint.config.mjs` in your project root:

```js

// eslint.config.mjs

import ycs77 from '@ycs77/eslint-config'

export default ycs77()

```

### Add script 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 `.vscode/settings.json`:

```jsonc

{

  // Enable the ESlint flat config support

  // (remove this if your ESLint extension above v3.0.5)

  "eslint.experimental.useFlatConfig": true,

  // Disable the default formatter, use eslint instead

  "prettier.enable": false,

  "editor.formatOnSave": false,

  // Auto fix

  "editor.codeActionsOnSave": {

    "source.fixAll.eslint": "explicit",

    "source.organizeImports": "never"

  },

  // Silent the stylistic rules in you IDE, but still auto fix them

  "eslint.rules.customizations": [

    { "rule": "style/*", "severity": "off", "fixable": true },

    { "rule": "format/*", "severity": "off", "fixable": true },

    { "rule": "*-indent", "severity": "off", "fixable": true },

    { "rule": "*-spacing", "severity": "off", "fixable": true },

    { "rule": "*-spaces", "severity": "off", "fixable": true },

    { "rule": "*-order", "severity": "off", "fixable": true },

    { "rule": "*-dangle", "severity": "off", "fixable": true },

    { "rule": "*-newline", "severity": "off", "fixable": true },

    { "rule": "*quotes", "severity": "off", "fixable": true },

    { "rule": "*semi", "severity": "off", "fixable": true }

  ],

  // Enable eslint for all supported languages

  "eslint.validate": [

    "javascript",

    "javascriptreact",

    "typescript",

    "typescriptreact",

    "vue",

    "html",

    "markdown",

    "json",

    "jsonc",

    "yaml",

    "toml"

  ]

}

```

## Customization

Since v1.0, we migrated to [ESLint Flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new). It provides much better organization and composition.

Normally you only need to import the `ycs77` preset:

```js

// eslint.config.js

import ycs77 from '@ycs77/eslint-config'

export default ycs77()

```

And that's it! Or you can configure each integration individually, for example:

```js

// eslint.config.js

import ycs77 from '@ycs77/eslint-config'

export default ycs77({

  // Enable stylistic formatting rules

  // stylistic: true,

  // Or customize the stylistic rules

  stylistic: {

    indent: 2, // 4, or 'tab'

    quotes: 'single', // or 'double'

  },

  // TypeScript and Vue are auto-detected, you can also explicitly enable them:

  typescript: true,

  vue: true,

  // Disable jsonc and yaml support

  jsonc: false,

  yaml: false,

  // `.eslintignore` is no longer supported in Flat config, use `ignores` instead

  ignores: [

    './fixtures',

    // ...globs

  ],

})

```

The `ycs77` factory function also accepts any number of arbitrary custom config overrides:

```js

// eslint.config.js

import ycs77 from '@ycs77/eslint-config'

export default ycs77(

  {

    // Configures for ycs77's config

  },

  // From the second arguments they are ESLint Flat Configs

  // you can have multiple configs

  {

    files: ['**/*.ts'],

    rules: {},

  },

  {

    rules: {},

  },

)

```

More advanced you can see the [@antfu/eslint-config's customization](https://github.com/antfu/eslint-config#customization) for more details.

## Credit

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

## License

Under the [MIT LICENSE](LICENSE)

[ico-version]: https://img.shields.io/npm/v/@ycs77/eslint-config?style=flat-square

[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen?style=flat-square

[ico-github-action]: https://img.shields.io/github/actions/workflow/status/ycs77/eslint-config/ci.yml?branch=main&label=tests&style=flat-square

[ico-downloads]: https://img.shields.io/npm/dt/@ycs77/eslint-config?style=flat-square

[link-npm]: https://www.npmjs.com/package/@ycs77/eslint-config

[link-github-action]: https://github.com/ycs77/eslint-config/actions/workflows/ci.yml?query=branch%3Amain

[link-downloads]: https://www.npmjs.com/package/@ycs77/eslint-config