eslint-config-caixiejs-base

CaixieJS's base eslint config presets

• Auto fix for formatting with prettier
• lint JavaScript
• Lint also for JSON, yaml, markdown
• Sorted imports, dangling commas for cleaner commit diff
• Reasonable defaults, best practices, only one-line of config
• Default Alias mapping "@" => "src", "~" => "./"

Usage

Install

pnpm i -D eslint eslint-config-caixiejs-base

Config eslint (.eslintrc | .eslintrc.js | .eslintrc.json)

{
  "extends": "caixiejs-base"
}

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

add import alias

{
  "settings": {
    "import/resolver": {
      "alias": { // default alias
        "map": [
          ["~", "."],
          ["@", "./src"]
        ],
        "extensions": [".js", ".jsx", ".mjs", ".ts", ".tsx", "mts", ".d.ts"]
      }
    }
  }
}

Add scripts for package.json

For example:

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