Eslint-config-zzjtnb-basic NPM

eslint-config-zzjtnb-basic

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 json, yaml, markdown out-of-box
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-basic

.eslintrc.js

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

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

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"
  ]
}