vscode的 Eslint代码自动格式化

本文介绍了如何在VSCode中配置Eslint进行代码自动格式化,以提升代码质量和可读性,便于团队协作。

在生产开发过程中企业一般要求我们开Eslint,目的是为了提高代码的可读性和规范性便于在你离职后代码能让别人接手,

第一步

在这里插入图片描述

第二步

preferences找到Setting文件夹
点红框

第三步插入以下代码并阅读一下即可

{
    // #值设置为true时,每次保存的时候自动格式化;值设置为false时,代码格式化请按shift+alt+F
    "editor.formatOnSave": true,
    //设置tab的缩进为2
    "editor.tabSize": 2,
    // #每次保存的时候将代码按eslint格式进行修复
    "editor.codeActionsOnSave": {
        "source.fixAll.eslint": true,
    },
    // 添加 vue 支持
    "eslint.validate": [
        "javascript",
        "javascriptreact",
        {
            "language": "vue",
            "autoFix": true
        }
    ],
    //  #让prettier使用eslint的代码格式进行校验
    // vscode 更新后已经统一使用editor.codeActionsOnsave
    //  #去掉代码结尾的分号
    "prettier.semi": false,
    //  #使用带引号替代双引号
    "prettier.singleQuote": true,
    "prettier.tabWidth": 4,
    //  #让函数(名)和后面的括号之间加个空格
    "javascript.format.insertSpaceBeforeFunctionParenthesis": true,
    // #这个按用户自身习惯选择
    "vetur.format.defaultFormatter.html": "js-beautify-html",
    // #让vue中的js按"prettier"格式进行格式化
    "vetur.format.defaultFormatter.js": "prettier",
    "vetur.format.defaultFormatterOptions": {
        "js-beautify-html": {
            // #vue组件中html代码格式化样式
            "wrap_attributes": "force-aligned", //也可以设置为“auto”,效果会不一样
            "wrap_line_length": 200,
            "end_with_newline": false,
            "semi": false,
            "singleQuote": true
        },
        "prettier": {
            "semi": false,
            "singleQuote": true
        }
    },
    "[jsonc]": {
        "editor.defaultFormatter": "esbenp.prettier-vscode"
    },
    // 格式化stylus, 需安装Manta's Stylus Supremacy插件
    "stylusSupremacy.insertColons": false, // 是否插入冒号
    "stylusSupremacy.insertSemicolons": false, // 是否插入分号
    "stylusSupremacy.insertBraces": false, // 是否插入大括号
    "stylusSupremacy.insertNewLineAroundImports": false, // import之后是否换行
    "stylusSupremacy.insertNewLineAroundBlocks": false,
    "prettier.useTabs": true,
    "files.autoSave": "off",
    "explorer.confirmDelete": false,
    "[javascript]": {
        "editor.defaultFormatter": "esbenp.prettier-vscode"
    },
    "[json]": {
        "editor.defaultFormatter": "esbenp.prettier-vscode"
    },
    "diffEditor.ignoreTrimWhitespace": false,
    "[html]": {
        "editor.defaultFormatter": "esbenp.prettier-vscode"
    }
}
### 配置 VSCode 使用 ESLint 进行保存时自动格式化 为了使 VSCode 在保存文件时通过 ESLint 自动格式化代码,需按照以下方式调整 `settings.json` 文件中的配置项。 确保已安装必要的扩展插件如 Vetur 和 ESLint 后,在工作区或用户级别的 `settings.json` 中加入如下设置: #### 设置编辑器行为 启用保存时的自动格式化功能[^1]: ```json { "editor.formatOnSave": true, } ``` 指定默认格式化工具有助于防止不同工具间的冲突,对于 Vue 项目而言可以这样设定: ```json { "editor.defaultFormatter": "octref.vetur", } ``` 针对 JavaScript 不采用 Vetur 而是交给 ESLint 来处理格式化的工作: ```json { "vetur.format.defaultFormatter.js": "none" } ``` #### 开启 ESLint 的保存操作修正 为了让 ESLint 在每次保存时执行所有的修复动作并显式声明此意图,应添加下列选项[^2]: ```json { "editor.codeActionsOnSave": { "source.fixAll.eslint": "explicit" } } ``` 如果仅希望触发特定类型的修复而不想影响其他方面,则可简化为只包含 `"source.fixAll"` 键值对的形式: ```json { "editor.codeActionsOnSave": { "source.fixAll": true } } ``` #### 扩展 ESLint 功能覆盖范围 当涉及到多语言支持或多目录结构的应用程序时,可以通过定义多个工作目录来增强 ESLint 的适用性[^3]: ```json { "eslint.workingDirectories": ["./back", "./front"] } ``` 同时也要确认验证的目标语言列表是否涵盖了当前项目的实际需求: ```json { "eslint.validate": [ "javascript", "vue", "html" ] } ``` 最后,激活 ESLint 并允许其随打字实时运行有助于即时反馈编码标准上的偏差[^4]: ```json { "eslint.enable": true, "eslint.run": "onType" } ``` 以上就是完整的配置过程,这些更改将帮助开发者更高效地维护一致性的代码风格。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值