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

⚙️ A few reusable ESLint configurations.
https://github.com/gcoguiec/eslint-config

eslint eslint-config flat-config

Last synced: about 2 months ago
JSON representation

⚙️ A few reusable ESLint configurations.

• Host: GitHub
• URL: https://github.com/gcoguiec/eslint-config
• Owner: gcoguiec
• License: bsd-2-clause
• Created: 2023-01-23T18:30:24.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-06T17:00:47.000Z (4 months ago)
• Last Synced: 2024-10-07T19:37:45.336Z (3 months ago)
• Topics: eslint, eslint-config, flat-config
• Language: TypeScript
• Homepage: https://github.com/gcoguiec/eslint-config
• Size: 278 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

        
@gcoguiec/eslint-config



  A few reusable ESLint configurations.





  

    

  

  

    

  





## Table of Contents

- [Getting Started](#getting-started)

- [Additional Configurations](#additional-configurations)

- [License](#license)

## Getting Started

### ECMAScript

#### Install

```bash

pnpm add -D eslint eslint-plugin-import-x tslib eslint-plugin-perfectionist eslint-config-prettier @gcoguiec/eslint-config

```

#### Register the configuration with [eslint](https://eslint.org/)

```js

// eslint.config.js

import { ecmascript } from '@gcoguiec/eslint-config';

export default [...(await ecmascript())];

```

### TypeScript

#### Install

```bash

pnpm add -D eslint eslint-plugin-import-x tslib eslint-plugin-perfectionist eslint-config-prettier @typescript-eslint/eslint-plugin @typescript-eslint/parser @gcoguiec/eslint-config

```

#### Register the configuration with [eslint](https://eslint.org/)

```js

// eslint.config.js

import { typescript } from '@gcoguiec/eslint-config';

export default [...(await typescript())];

```

### Vue

#### Install

```bash

pnpm add -D eslint eslint-plugin-import-x tslib eslint-plugin-perfectionist eslint-config-prettier eslint-plugin-vue @gcoguiec/eslint-config

```

#### Install (TypeScript only)

```bash

pnpm add -D @typescript-eslint/eslint-plugin @typescript-eslint/parser

```

#### Register the configuration with [eslint](https://eslint.org/)

```js

// eslint.config.js

import { vue } from '@gcoguiec/eslint-config';

// ECMAScript

export default [...(await vue())];

// TypeScript

export default [...(await vue({ typescript: true }))];

```

## Additional Configurations

### Vitest

#### Install

```bash

pnpm add -D eslint-plugin-vitest

```

#### Register the configuration with [eslint](https://eslint.org/)

```js

// eslint.config.js

import { ecmascript, typescript, vitest } from '@gcoguiec/eslint-config';

// ECMAScript

export default [

  ...(await ecmascript()),

  ...(await vitest())

];

// TypeScript

export default [

  ...(await typescript()),

  ...(await vitest({ typescript: true }))

];

```

## License

This project is licensed under [BSD 2-Clause](https://spdx.org/licenses/BSD-2-Clause.html).