跳转至

eslint相关

在 Vue2 项目中加入 ESLint 可以帮助你更好地维护代码规范和质量。以下是一个步骤详细的教程:

  1. 首先,你需要在你的项目中安装 ESLint。在你的项目根目录下打开终端,然后运行以下命令:
npm install eslint --save-dev
  1. 安装完成后,你需要初始化 ESLint。在你的项目根目录下运行以下命令:
./node_modules/.bin/eslint --init

这将启动一个向导,帮助你设置你的 ESLint 配置。选择你希望的选项,例如你的代码运行的环境、你使用的 ECMAScript 版本、你的代码风格等。

  1. 设置完成后,一个 .eslintrc.js.eslintrc.json 文件将会被创建在你的项目根目录下。这个文件包含你的 ESLint 配置。例如:
module.exports = {
    "env": {
        "browser": true,
        "es6": true
    },
    "extends": "eslint:recommended",
    "globals": {
        "Atomics": "readonly",
        "SharedArrayBuffer": "readonly"
    },
    "parserOptions": {
        "ecmaVersion": 2018,
        "sourceType": "module"
    },
    "rules": {
    }
};

"rules" 部分,你可以添加你自定义的 ESLint 规则。例如,你可以添加一个规则来强制在语句末尾使用分号:

"rules": {
    "semi": ["error", "always"]
}

这意味着 ESLint 将会在每次你没有在语句末尾使用分号时报错。

  1. 你还需要安装 ESLint 插件 vue-eslint-parser 和 eslint-plugin-vue 来支持 Vue.js。在你的项目根目录下运行以下命令:
npm install --save-dev vue-eslint-parser eslint-plugin-vue

然后在你的 ESLint 配置中添加这两个插件:

module.exports = {
    // ...
    "parser": "vue-eslint-parser",
    "plugins": [
        "vue"
    ],
    // ...
};
  1. 最后,你需要配置你的构建工具或编辑器来使用 ESLint。例如,如果你使用的是 Webpack,你可以添加一个 ESLint loader:
module.exports = {
    // ...
    module: {
        rules: [
            {
                test: /\.vue$/,
                loader: 'eslint-loader',
                enforce: 'pre',
                include: [resolve('src'), resolve('test')],
                options: {
                    formatter: require('eslint-friendly-formatter')
                }
            },
            // ...
        ]
    },
    // ...
};

如果你使用的是 VS Code,你可以安装 ESLint 插件并配置它来自动修复你的代码。

以上就是在 Vue2 项目中加入 ESLint 的详细教程。希望对你有所帮助!

其他

某些内容忽略校验

.eslintignore 文件是一个用于指定 ESLint 忽略检查的文件和目录的特殊文件。它的工作方式类似于 Git 的 .gitignore 文件。

.eslintignore 文件中,你可以添加一行行的模式来匹配你不希望 ESLint 检查的文件和目录。例如:

node_modules/
dist/

上述的 .eslintignore 文件告诉 ESLint 忽略 node_modules/dist/ 目录。

你也可以使用通配符来匹配多个文件或目录。例如:

*.min.js

上述的 .eslintignore 文件告诉 ESLint 忽略所有以 .min.js 结尾的文件。

注意,.eslintignore 文件应该放在项目的根目录下,这样 ESLint 才能找到它。如果 ESLint 找不到 .eslintignore 文件,它将不会忽略任何文件或目录。

初始化

sudo ./node_modules/.bin/eslint --init
 How would you like to use ESLint? · style
 What type of modules does your project use? · esm
 Which framework does your project use? · vue
 Does your project use TypeScript? · No / Yes
 Where does your code run? · browser
 How would you like to define a style for your project? · prompt
 What format do you want your config file to be in? · JavaScript
 What style of indentation do you use? · tab
 What quotes do you use for strings? · double
 What line endings do you use? · unix
 Do you require semicolons? · No / Yes
 Would you like to install them now? · No / Yes
 Which package manager do you want to use? · yarn