繁體中文

English
日本語

繁體中文

English
日本語

Appearance

Linting ​

AI生成摘要

本文介紹了如何在項目中設置和使用ESLint進行代碼檢查和格式化，包括安裝和配置ESLint、設置pre-commit鉤子以及在VSCode中整合ESLint。

安裝Linter ​

我使用@antfu/eslint-config，lint之外還能format

bash
npm i -D eslint eslint-plugin-format @antfu/eslint-config

設定ESLint ​

新增eslint.config.mjs

javascript
import antfu from "@antfu/eslint-config"

export default antfu({
  formatters: true,
  stylistic: {
    indent: 2,
    quotes: "double",
  },
  yaml: false,
  jsonc: false,
  vue: true,
  typescript: {
    tsconfigPath: "tsconfig.json",
  },
  ignores: [
    "**/node_modules",
    "**/.vitepress/cache",
    "**/.vitepress/dist",
  ],
})

在package.json中增加設定

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

執行formatter

bash
npm run lint:fix

TODO: 忽略code block內容 ​

我不希望在.md中檢查code block的內容，但不知道怎麼設定比較好。等我找到方法再回來更新。

設定pre-commit ​

可以設定pre-commit，以後在git commit時自動format

安裝lint-staged, simple-git-hooks

bash
npm i -D lint-staged simple-git-hooks

在package.json裡新增設定：

json
{
  // ...
  "simple-git-hooks": {
    "pre-commit": "npx lint-staged"
  },
  "lint-staged": {
    "*": "eslint . --fix"
  }
}

執行一次simple-git-hooks完成設定

bash
npx simple-git-hooks

整合VSCode ​

在.vscode/settings.json中追加設定

json
{
  "vue.server.hybridMode": true,
  "vue.server.includeLanguages": ["vue", "markdown"],
  // Disable the default formatter, use eslint instead
  "editor.formatOnSave": false,

  // Auto fix
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": "explicit",
    "source.organizeImports": "never"
  },

  // Silent the stylistic rules in you IDE, but still auto fix them
  "eslint.rules.customizations": [
    { "rule": "style/*", "severity": "off", "fixable": true },
    { "rule": "format/*", "severity": "off", "fixable": true },
    { "rule": "*-indent", "severity": "off", "fixable": true },
    { "rule": "*-spacing", "severity": "off", "fixable": true },
    { "rule": "*-spaces", "severity": "off", "fixable": true },
    { "rule": "*-order", "severity": "off", "fixable": true },
    { "rule": "*-dangle", "severity": "off", "fixable": true },
    { "rule": "*-newline", "severity": "off", "fixable": true },
    { "rule": "*quotes", "severity": "off", "fixable": true },
    { "rule": "*semi", "severity": "off", "fixable": true }
  ],

  // Enable eslint for all supported languages
  "eslint.validate": [
    "javascript",
    "javascriptreact",
    "typescript",
    "typescriptreact",
    "vue",
    "html",
    "markdown",
    "json",
    "json5",
    "jsonc",
    "yaml",
    "toml",
    "xml",
    "gql",
    "graphql",
    "astro",
    "css",
    "less",
    "scss",
    "pcss",
    "postcss"
  ]
}