请通过邮件订阅网站,随时获取最新动态!

# Vue 规范

Vue 代码规范可以帮你规避错误,能够在绝大多数工程中改善可读性和开发体验,并让你的代码保持一致性。

eslint-plugin-vue 是官方为 Vue.js 提供的 ESLint 插件,它允许我们使用 ESLint 检查 .vue 文件中的 <template><script>,以及 .js 文件中的 Vue 代码。

# 快速使用

如果你已经安装了 @startdt/eslint-config,则无需重复安装配置。请参阅:JavaScript 规范 > 快速使用

# 自动检查

# 保存时检查

在保存时格式化文件,需要配置 eslint.validate 选项来检查 .vue 文件,默认仅包含 *.js*.jsx 文件:





 



{
    "eslint.validate": [
        "javascript",
        "javascriptreact",
        "vue"
    ],
}

如果你使用 Vetur 插件,请设置 "vetur.validation.template": false 关闭 Vetur 默认的模板验证。

# 提交时检查

默认情况下,ESLint 只针对 .js 文件,你需要指定 .vue 文件进行代码检查:






 






{
    "gitHooks": {
        "pre-commit": "lint-staged"
    },
    "lint-staged": {
        "*.{js,vue}": [
            "eslint --fix", // 或 next-cli-service lint
            "git add"
        ]
    }
}

如果 ESLint 不能正确格式化 .vue 文件,请检查是否使用了 eslint-plugin-html 插件,因为它会导致 eslint-plugin-vue 无法解析 .vue 文件中的 <template><script> 代码。

# 代码风格

# 错误级别

  1. 默认情况下,所有启用的规则都是 "error" 级别的严重程度;
  2. 已启用规则,且支持 --fix 选项自动修复的规则都是 "warn" 级别的严重程度;
  3. 未启用规则,默认将值设置为 "off" 进行显式配置,不产生任何错误信息;
  4. 继承的规则,包括插件的规则都遵循以上错误级别;