Eslint-config-zzjtnb-ts NPM

eslint-config-zzjtnb-ts

ESLint suggestions configuration aimed to have balanced aspects. A part of eslint-config-zzjtnb.

Single quotes, no semi
Auto fix for formatting (aimed to be used standalone without Prettier)
Designed to work with TypeScript out-of-box
Lint also for json, yaml, markdown
Sorted imports, dangling commas for cleaner commit diff
Reasonable defaults, best practices, only one-line of config

Usage

Install

pnpm add -D eslint eslint-define-config eslint-config-zzjtnb-ts

TypeScript Aware Rules

Type aware rules are enabled when a tsconfig.json is found in the project root, which will introduce some stricter rules into your project. If you want to enable it while have no tsconfig.json in the project root, you can change tsconfig name by modifying ESLINT_TSCONFIG env or creat a tsconfig.json.

.eslintrc.js

found tsconfig.json

/* eslint-env node */
// @ts-check
const { defineConfig } = require('eslint-define-config')

module.exports = defineConfig({
  root: true,
  extends: [
    'zzjtnb-ts',
  ],
})

change tsconfig name

/* eslint-env node */
// @ts-check
const { defineConfig } = require('eslint-define-config')

process.env.ESLINT_TSCONFIG = 'tsconfig.eslint.json'
module.exports = defineConfig({
  root: true,
  extends: [
    'zzjtnb-ts',
  ],
})

You don't need .eslintignore normally as it has been provided by the preset.

Add script for package.json

For example:

{
  "scripts": {
    "lint": "eslint .",
    "lint:fix": "eslint . --fix"
  }
}

Config VS Code auto fix

Install VS Code ESLint extension and create .vscode/settings.json

{
  "prettier.enable": false,
  "editor.formatOnSave": true,
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
  },
  "eslint.validate": [
    "javascript",
    "typescript",
    "html",
    "vue",
    "markdown",
    "json",
    "jsonc",
    "yaml",
    "yml"
  ]
}