brownsugar/eslint-config

Preferred ESLint configs for myself.

ESLint Config

Preferred ESLint configs for myself.

Install

yarn add -D @brownsugar/eslint-config
# or
pnpm add -D @brownsugar/eslint-config

For TypeScript

The base config, inherits below rule sets with some custom rules.

• ESLint recommended
• ESLint Stylistic recommended
• TypeScript recommended
• TypeScript Stylistic

eslint.config.cjs

const brownsugarConfig = require('@brownsugar/eslint-config/typescript')
module.exports = brownsugarConfig

eslint.config.mjs

import brownsugarConfig from '@brownsugar/eslint-config/typescript'
export default brownsugarConfig

For Vue 3

The config to use with TypeScript, inherits @brownsugar/eslint-config/typescript with Vue 3 recommended.

eslint.config.cjs

const brownsugarConfig = require('@brownsugar/eslint-config/vue')
module.exports = brownsugarConfig

eslint.config.mjs

import brownsugarConfig from '@brownsugar/eslint-config/vue'
export default brownsugarConfig

For Nuxt 3

The config to use with TypeScript, inherits @brownsugar/eslint-config/vue with Nuxt 3 config.

eslint.config.cjs

// Not supported

eslint.config.mjs

import brownsugarConfig from '@brownsugar/eslint-config/nuxt'
export default brownsugarConfig({
  // Nuxt ESLint options
  dirs: {
    src: ['src'],
  },
})