@goliafrs/eslint-config

Installation

npm install --save-dev eslint @goliafrs/eslint-config

pnpm add --save-dev eslint @goliafrs/eslint-config

To work with this package, you need to install eslint at least as a dev dependency.

Available Configs

| Name | Purpose | | ------------ | ---------------------------------------------------------------------- | | javascript | Base JS + stylistic + import rules | | typescript | Adds TypeScript-specific rules (requires typescript-eslint & tsconfig) | | vue | Vue (SFC) rules (recommended + project overrides) | | vueJs | Vue + plain JS | | vueTs | Vue + TypeScript | | commonjs | CommonJS files (*.cjs) | | cypress | Cypress test files under cypress/ |

Usage

Create a eslint.config.js file in the root of your project and add the following:

JavaScript only

import { defineConfig } from 'eslint/config'
import configs from '@goliafrs/eslint-config'

export default defineConfig([ configs.javascript ])

TypeScript

import { defineConfig } from 'eslint/config'
import configs from '@goliafrs/eslint-config'

export default defineConfig([ configs.javascript, configs.typescript ])

Vue + TypeScript

import { defineConfig } from 'eslint/config'
import configs from '@goliafrs/eslint-config'

export default defineConfig([
  configs.javascript,
  configs.typescript,
  configs.vue
])

Cypress (include only in end-to-end test projects)

import { defineConfig } from 'eslint/config'
import configs from '@goliafrs/eslint-config'

export default defineConfig([
  configs.javascript,
  configs.cypress
])

CommonJS

import { defineConfig } from 'eslint/config'
import configs from '@goliafrs/eslint-config'

export default defineConfig([
  configs.commonjs
])

Unused Imports

The rule unused-imports/no-unused-imports is enabled (error). Your IDE (VSCode) may also remove unused imports automatically; there is no conflict. To disable in your project:

// eslint.config.js
import { defineConfig } from 'eslint/config'
import configs from '@goliafrs/eslint-config'

export default defineConfig([
  configs.javascript,
  { rules: { 'unused-imports/no-unused-imports': 'off' } }
])

Override Examples

import { defineConfig } from 'eslint/config'
import configs from '@goliafrs/eslint-config'

export default defineConfig([
  configs.javascript,
  {
    files: [ 'src/legacy/**/*.js' ],
    rules: { 'no-console': 'off' }
  }
])

sideEffects

"sideEffects": false in package.json enables better tree-shaking.

Engines

Supported: Node >= 18.18.0, ESLint >= 9.

Usable commands

You can use the following commands to lint your code:

{
  "scripts": {
    "lint": "npx eslint src",
    "lint:fix": "npx eslint src --fix",
    "lint:inspect": "npx @eslint/config-inspector",
  }
}

npm run lint
npm run lint:fix
npm run lint:inspect

• lint: Lint your code
• lint:fix: Lint and fix your code
• lint:inspect: Inspect your code and show the rules that are being used