需协调eslint(逻辑质量检查)与prettier(外观格式化)协同工作:一、安装eslint、prettier、eslint-config-prettier、eslint-plugin-prettier等依赖;二、配置eslint.config.js,extends中末尾加入'plugin:prettier/recommended';三、创建.prettierrc定义格式规则;四、vscode中启用formatonsave与source.fixall.eslint;五、通过eslint --fix和prettier --check验证集成效果。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

如果您在QoderWake项目中希望实现统一的代码规范检查与格式化,则需协调ESLint(负责逻辑质量与潜在错误检测)与Prettier(专注代码外观强制统一)的协同工作。以下是完成该集成的具体配置流程:
一、安装核心依赖
需在项目根目录下安装ESLint与Prettier及其协作插件,确保二者职责分离且无规则冲突。其中eslint-config-prettier用于关闭ESLint中所有格式化类规则,eslint-plugin-prettier则将Prettier作为ESLint的一条可执行规则嵌入检查流程。
1、运行以下命令安装全部必需开发依赖:
2、使用pnpm(推荐)执行:pnpm add -D eslint prettier eslint-config-prettier eslint-plugin-prettier @typescript-eslint/parser @typescript-eslint/eslint-plugin
3、若项目为纯JavaScript,可省略TypeScript相关包;若含Vue,需额外添加eslint-plugin-vue及对应解析器。
二、创建ESLint主配置文件
通过标准配置文件声明规则继承链与自定义项,关键在于将plugin:prettier/recommended置于extends数组末尾,以确保其优先级最高并覆盖冲突规则。
1、在项目根目录新建eslint.config.js(或.eslintrc.json)。
2、写入如下基础配置(适配TypeScript项目):
3、module.exports = { extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'plugin:prettier/recommended'], parser: '@typescript-eslint/parser', parserOptions: { ecmaVersion: 2022, sourceType: 'module' }, rules: { 'no-console': 'warn', 'semi': ['error', 'always'] } };
4、保存后,ESLint即启用Prettier接管格式化职责,同时保留类型与逻辑检查能力。
三、配置Prettier规则文件
独立定义代码外观参数,避免硬编码于ESLint配置中,提升可维护性与复用性。该文件被eslint-plugin-prettier直接读取并执行格式化动作。
1、在项目根目录创建.prettierrc文件。
代码编辑 CLI 工具集合:Cursor CLI(agent)和 Qoder CLI(qodercli),用于代码修改、重构、Code Review 及自动化代码任务。
2、填入标准化格式选项:
3、{ "semi": true, "singleQuote": true, "tabWidth": 2, "trailingComma": "all", "printWidth": 80, "endOfLine": "lf" }
4、如需忽略构建产物或第三方库,同步创建.prettierignore并填入dist/、node_modules/等路径。
四、配置VSCode编辑器行为
使本地开发环境响应项目级规则,在保存时自动触发ESLint检查与Prettier格式化,形成“所见即合规”的实时反馈闭环。
1、在VSCode扩展市场安装官方插件:ESLint 与 Prettier - Code formatter。
2、打开工作区设置(.vscode/settings.json),写入以下内容:
3、{ "editor.formatOnSave": true, "editor.defaultFormatter": "esbenp.prettier-vscode", "editor.codeActionsOnSave": { "source.fixAll.eslint": true }, "eslint.validate": ["javascript", "typescript", "vue"] }
4、禁用VSCode内置JavaScript格式化器及任何可能覆盖Prettier行为的第三方格式化插件。
五、验证集成效果
通过终端命令与实际文件操作双重校验工具链是否按预期协同运行,确认ESLint不报格式类错误、Prettier能正确重写代码结构。
1、在终端执行:npx eslint src --ext .ts,.js --fix,观察输出是否仅含逻辑类警告(如no-console),无缩进或引号类报错。
2、手动修改一个源文件,故意删除分号或混用引号,保存后检查是否自动补充分号、转换单引号并调整换行。
3、运行:npx prettier --check src/**/*.ts,确认返回Code style issues found时能被--write修复,且与ESLint --fix结果一致。










