ESLint Config Namchee

Personal and opinionated ESLint shareable configuration. Uses ESLint Stylistic, why?.

Installation

Install this config with your favorite package manager:

# 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, 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:

// with "type": "module" in package.json
import config from '@namchee/eslint-config';

export default [...config];

// 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:

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

{
    "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