@yokots/eslint-config

Style Guide

USAGE

• Install

  npm install eslint @yokots/eslint-config -D

• Config

  在项目目录下新建 .eslintrc.json

  // for javascript web project
  {
    "extends": ["@yokots/eslint-config/base"],
    "ignorePatterns": [
      "docs/",
      "dist/",
      "coverage/",
      "node_modules/"
    ],
    "rules": {},
    "overrides": [
      {
        "files": ["*.spec.js", "*.test.js"],
        "extends": ["@yokots/eslint-config/jest"]
      }
    ]
  }
  
  // for javascript node project
  {
    "extends": [
      "@yokots/eslint-config/base",
      "@yokots/eslint-config/node"
    ],
    "ignorePatterns": [
      "docs/",
      "dist/",
      "coverage/",
      "node_modules/"
    ],
    "rules": {},
    "overrides": [
      {
        "files": ["*.spec.js", "*.test.js"],
        "extends": ["@yokots/eslint-config/jest"]
      }
    ]
  }
  
  // for typescript web project
  {
    "extends": [
      "@yokots/eslint-config/base",
      "@yokots/eslint-config/typescript"
    ],
    "ignorePatterns": [
      "docs/",
      "dist/",
      "coverage/",
      "node_modules/"
    ],
    "rules": {},
    "overrides": [
      {
        "files": ["*.spec.ts", "*.test.ts"],
        "extends": ["@yokots/eslint-config/typescript-jest"]
      }
    ]
  }
  
  // for typescript node project
  {
    "extends": [
      "@yokots/eslint-config/base",
      "@yokots/eslint-config/typescript",
      "@yokots/eslint-config/node"
    ],
    "ignorePatterns": [
      "docs/",
      "dist/",
      "coverage/",
      "node_modules/"
    ],
    "rules": {},
    "overrides": [
      {
        "files": ["*.spec.ts", "*.test.ts"],
        "extends": ["@yokots/eslint-config/typescript-jest"]
      }
    ]
  }

  eslint配置参考;

  typescript-eslint/parse配置参考

• Lint

  npx eslint --ext ts,js .