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

Custom ESLint and Prettier config with sensible defaults
https://github.com/kouts/eslint-config

config eslint eslint-config eslint-plugin javascript prettier prettier-config standard typescript vue vue2 vue3

Last synced: 11 days ago
JSON representation

Custom ESLint and Prettier config with sensible defaults

• Host: GitHub
• URL: https://github.com/kouts/eslint-config
• Owner: kouts
• License: mit
• Created: 2022-04-28T16:13:24.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-27T08:28:16.000Z (12 days ago)
• Last Synced: 2024-10-27T09:28:49.833Z (12 days ago)
• Topics: config, eslint, eslint-config, eslint-plugin, javascript, prettier, prettier-config, standard, typescript, vue, vue2, vue3
• Language: TypeScript
• Homepage:
• Size: 1.12 MB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @kouts/eslint-config

> Custom ESLint and Prettier config with Vue.js support and sensible defaults

> [!NOTE]  

> Starting from v1, this ESLint config uses the [ESLint Flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new) and is only compatible with ESLint v9 or v8.50.0+.  

> If you're looking for the previous version, checkout the [README]('./README_V0.md') here.

## Installation

```bash

pnpm i -D @kouts/eslint-config eslint prettier

```

## Usage

### ESLint config

Add an `eslint.config.js` (or `eslint.config.cjs` if your project is CommonJS) that imports the `config` function:

```javascript

import { config } from '@kouts/eslint-config'

export default [

  ...config(),

  {

    // Add custom rules here

  },

]

```

#### Customizing the config

The configuration comes with default settings that extend the [neostandard config](https://github.com/neostandard/neostandard/tree/main?tab=readme-ov-file#configuration-options) config. You can further customize it by passing an object to the `config` function:

**Config settings defaults:**

| Option     | Type       | Description                   | Default |

| ---------- | ---------- | ----------------------------- | ------- |

| ts         | `boolean`  | Enable TypeScript support     | `true`  |

| noJsx      | `boolean`  | No jsx rules will be added    | `true`  |

| noStyle    | `boolean`  | No style rules will be added  | `true`  |

| semi       | `boolean`  | No semicolons                 | `false` |

| vue        | `boolean`  | Enable Vue.js support         | `true`  |

| vueVersion | `2` or `3` | Specify the version of Vue.js | `3`     |

| vitest     | `boolean`  | Enable Vitest support         | `true`  |

**Example:**

```javascript

config({

  ts: false,

  vue: true

  vueVersion: 3,

  vitest: false,

})

```

### Prettier config

Create a `prettier.config.js` file with the following content:

```javascript

import prettierConfig from '@kouts/eslint-config/prettier'

export default prettierConfig

```

### package.json scripts

Add the following ESLint commands to your `.package-json` for linting and autofixing:

```json

{

  "lint": "eslint \"**/*.{vue,ts,js}\"",

  "lint-fix": "eslint --fix \"**/*.{vue,ts,js}\""

}

```

### VS Code settings

Ad the following settings to your VS Code project settings for autofix on save:

`.vscode/settings.json`

```json

{

  "editor.formatOnSave": true,

  "editor.codeActionsOnSave": {

    "source.fixAll.eslint": true

  },

  "[javascript]": {

    "editor.defaultFormatter": "esbenp.prettier-vscode"

  },

  "[typescript]": {

    "editor.defaultFormatter": "esbenp.prettier-vscode"

  }

}

```

## Features

- Based on [neostandard](https://github.com/neostandard/neostandard)

- [Prettier](https://prettier.io) for code formatting

- Plugins

  - [eslint-plugin-html](https://github.com/BenoitZugmeyer/eslint-plugin-html) for linting inline scripts contained in HTML files

  - [eslint-plugin-vue](https://github.com/vuejs/eslint-plugin-vue/) for linting Vue.js files

  - [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) for disabling all rules that conflict with Prettier

  - [eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier) for using Prettier as a code formatter with `eslint --fix`

  - [eslint-plugin-simple-import-sort](https://github.com/lydell/eslint-plugin-simple-import-sort) for auto-fixing imports order

  - [eslint-plugin-import-x](https://github.com/lydell/eslint-plugin-simple-import-sort) for auto-fixing import/export syntax, and prevent issues with misspelling of file paths and import names

  - [eslint-plugin-vitest](https://github.com/vitest-dev/eslint-plugin-vitest) for linting Vitest test files

## License

[MIT](http://opensource.org/licenses/MIT)