uni-app HBuilderX 使用eslint实时校验、自动修复代码错误(适用于HBuilderX 2.6.8+)

发布于 1周前 作者 caililin 来自 Uni-App

uni-app HBuilderX 使用eslint实时校验、自动修复代码错误(适用于HBuilderX 2.6.8+)

HBuilderX 2.6.8+版本起,新增eslint 实时校验、自动修复错误的功能

注意:此文不适用于2.6.8之前的版本

插件下载地址


1. eslint 文件保存,实时校验、自动修复错误功能说明

  • 使用此功能,必须安装eslint-jseslint-vue插件。
  • vue-cli项目,需要安装eslint库,并配置eslint规则.
  • 若满足上述条件,当编写完代码,保存时,若代码中存在错误,自动修复;

2. 插件设置

2.6.11版本,支持自定义配置:保存时自动修复启用实时校验;见下图

特别说明: 实时校验功能,默认未开启,需要手动开启此功能

eslint设置


3. 特别说明

特别说明: eslint自动修复功能,并不能修复所有的语法错误。 比如定义了某个变量,但未使用,eslint校验保存,自动修复功能并不能修复此类错误。


4. 普通项目:eslint规则配置

点击菜单【工具】【插件配置】【eslint-js】,编辑.eslintrc.js文件

eslint规则:https://eslint.org/docs/rules/

.eslintrc.js配置文件示例

module.exports = {  
    "plugins": [  
        "html"  
    ],  
    "parserOptions": {  
        "ecmaVersion": 2018,  
        "sourceType": "module",  
        "ecmaFeatures": {  
            "jsx": true  
        },  
        "allowImportExportEverywhere": false  
    },  
    rules: {  
        "no-alert": 0,  
        "semi": [2, "always"],  
        "no-multi-spaces": "error",  
       "quotes": ["error", "single"]  
    }  
}

示例:使用eslint, 删除多余的空格

删除多余空格


5. vue-cli项目:eslint安装、配置

$ npm install --save eslint eslint-plugin-vue eslint-plugin-html eslint-config-standard eslint-plugin-import eslint-plugin-node eslint-plugin-promise eslint-plugin-standard

安装完成后,在vue-cli项目根目录,创建.eslintrc.js文件

备注:(注意:项目下eslint规则会覆盖HBuilderX编辑器eslint插件中的规则

eslint-plugin-vue配置文件与规则:eslint-plugin-vue官方教程

.eslintrc.js配置文件示例

module.exports = {  
    extends: [  
        'plugin:vue/recommended'  
    ],  
    rules: {  
        "no-alert": 0,  
        "no-multi-spaces": "error", // 禁止多个空格   
        "semi": [2, "always"] ,// 自动补充分号  
       "quotes": ["error", "single"] // 使用单引号  
    }  
}

示例:使用eslint, 自动补充分号

自动补充分号


6. 以uni-app项目为例,配置eslint规则,校验vue文件

特别说明:

  • vue文件,校验规则,需要从eslint-vue插件中配置。
  • 菜单【工具】【插件配置】【eslint-vue】【.eslintrc.js】,编辑.eslintrc.js文件

配置eslint规则


7. vue-cli 项目demo

附件中的zip包,为vue-cli项目demo。因为node_modules太大,所以未包含node_modules。解压zip后,请执行npm install安装node_modules

下载vue-cli项目demo


1 回复

在HBuilderX中集成ESLint以实现实时校验和自动修复代码错误,可以极大地提高代码质量和开发效率。以下是如何在HBuilderX 2.6.8及以上版本中配置和使用ESLint的步骤,包括必要的代码示例。

1. 安装ESLint及相关依赖

首先,确保你的项目根目录下已经安装了ESLint。如果还没有安装,可以通过npm进行安装:

npm install eslint --save-dev
npm install eslint-plugin-vue --save-dev  # 如果你的项目包含Vue文件

2. 配置ESLint

在项目根目录下创建一个.eslintrc.js文件,用于配置ESLint规则。以下是一个简单的配置示例:

module.exports = {
    root: true,
    env: {
        node: true,
    },
    extends: [
        'eslint:recommended',
        'plugin:vue/vue3-recommended',  // 根据Vue版本调整
    ],
    parserOptions: {
        ecmaVersion: 2020,
    },
    rules: {
        'no-console': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
        'no-debugger': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
    },
};

3. 在HBuilderX中启用ESLint

打开HBuilderX,进入工具 -> 设置 -> 代码检查,然后勾选启用ESLint。确保HBuilderX能够正确识别你的.eslintrc.js配置文件。

4. 自动修复代码错误

HBuilderX支持ESLint的自动修复功能。你可以在保存文件时自动修复代码错误,或者在代码编辑器中手动触发修复。

  • 自动保存时修复:确保在工具 -> 设置 -> 编辑器中,勾选保存时自动格式化代码,并且选择ESLint作为格式化工具。

  • 手动触发修复:在代码编辑器中,右键点击代码区域,选择ESLint Fix,HBuilderX将尝试根据ESLint规则自动修复代码中的错误。

5. 验证配置

创建一个包含潜在ESLint错误的测试文件,例如test.js

console.log("Hello, World!");
var unusedVar = "This is unused";

保存文件后,HBuilderX应该会在问题面板中显示ESLint错误,并且如果启用了自动修复,部分错误可能会被自动修复。

通过上述步骤,你就可以在HBuilderX 2.6.8及以上版本中成功集成ESLint,实现实时校验和自动修复代码错误的功能。这不仅能提高代码质量,还能减少潜在的bug,提升开发效率。

回到顶部