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

:wrench: My personal ESLint configuration. Designed to be used with TypeScript.
https://github.com/namchee/eslint-config-namchee

eslint eslint-config typescript

Last synced: 28 days ago
JSON representation

:wrench: My personal ESLint configuration. Designed to be used with TypeScript.

• Host: GitHub
• URL: https://github.com/namchee/eslint-config-namchee
• Owner: Namchee
• Created: 2021-05-16T05:18:20.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T15:37:33.000Z (3 months ago)
• Last Synced: 2024-11-03T04:02:54.062Z (3 months ago)
• Topics: eslint, eslint-config, typescript
• Language: JavaScript
• Homepage:
• Size: 303 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ESLint Config Namchee

Personal and opinionated ESLint shareable configuration. Uses [ESLint Stylistic](https://eslint.style/), [why?](https://github.com/eslint/eslint/issues/17522).

## Installation

Install this config with your favorite package manager:

```bash

# using npm

npm install @namchee/eslint-config -D

# using yarn

yarn add @namchee/eslint-config -D

# using pnpm

pnpm add @namchee/eslint-config -D

# using bun

bun add @namchee/eslint-config -D

```

> Since the introduction of [ESLint flat config][flat config], this config uses flat config for the latest package `@namchee/eslint-config`. For legacy config, please install `eslint-config-namchee` instead.

## Usage

To use the ESLint configuration, you can extend your configuration by importing the config directly:

```js

// with "type": "module" in package.json

import config from '@namchee/eslint-config';

export default [...config];

```

```js

// without "type": "module" in package.json

const config = require('@namchee/eslint-config');

module.exports = [...config];

```

> For legacy config, you can extend the config by specifying it using the `extends` keyword:

> ```js

> module.exports = {

>   extends: ['eslint-config-namchee'], // or 'namchee' for short 

> }

## VSCode Settings

If you're using VSCode, use the following settings for maximum DX with this configuration

```json

{

    "editor.codeActionsOnSave": {

        "source.fixAll.eslint": true

    },

    "eslint.experimental.useFlatConfig": true,

    "eslint.format.enable": true,

        "eslint.rules.customizations": [

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

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

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

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

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

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

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

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

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

    ],

    "eslint.validate": [

        "javascript",

        "javascriptreact",

        "typescript",

        "typescriptreact",

        "json",

        "jsonc",

        "yaml"

    ],

    "prettier.enable": false

}

```

## Supported Languages

- JavaScript - `.js`, `.mjs`, `.cjs`, `.jsx`

- TypeScript - `.ts`, `.mts`, `.tsx`

- JSON - `.json`, `.json5`, `.jsonc`

- YAML - `.yaml`, `.yml`

- Vue - *planned*

- Markdown - *planned*

## License

This project is licensed under the [MIT License](./LICENSE)

[flat config]: https://eslint.org/blog/2022/08/new-config-system-part-1/