基于VSCode插件开发定制专属的代码风格强制检查工具

风强吖_1689

风强吖_1689

2026-10-28

453人浏览

原创

ESLint/Prettier插件不够用,因无法满足团队硬性规范(如console.log需带模块前缀、.ts禁any但.d.ts允许),且VSCode仅提示不执行AST校验;自定义规则需发包维护,协作成本高,难以深度绑定保存修复与提交拦截。

基于vscode插件开发定制专属的代码风格强制检查工具

为什么直接用 ESLint / Prettier 插件不够用

因为团队内部有硬性规范:比如所有 console.log 必须带模块前缀(console.log('[auth]', 'login success')),或禁止在 .ts 文件里出现 any 类型但允许在 .d.ts 中使用——这类规则 ESLint 默认不覆盖,插件市场也找不到现成匹配项。

VSCode 自身只做编辑器层提示,不执行自定义 AST 校验逻辑;而直接改 ESLint 规则需要发布独立配置包、维护共享依赖,协作成本高且无法与 VSCode 编辑行为深度绑定(比如保存时自动修复 + 禁止提交)。

  • ESLint 的 context.report() 无法控制 VSCode 的「问题面板」分类(如标为「错误」还是「警告」)
  • 第三方插件如 eslint-plugin-unicorn 不支持按文件后缀动态启用/禁用规则
  • VSCode 的 workspace.onDidSaveTextDocument 事件触发时机早于 ESLint 的缓存解析,容易漏检刚键入的代码

用 vscode-languageclient + ts-morph 实现轻量级实时校验

不用重写语言服务器,也不用 fork TypeScript Server。核心思路是:监听文件保存 → 用 ts-morph 解析 AST → 遍历节点执行自定义断言 → 调用 vscode.languages.createDiagnosticCollection 注入问题。

关键点在于绕过 ESLint 的配置加载和规则注册流程,把校验逻辑收归到插件内部,便于条件化控制:

  • 对 console.log 检查:匹配 CallExpression 节点,判断 expression.getFullText() 是否以 'console.log' 开头,再检查第一个参数是否为字符串字面量且含方括号
  • 对 any 类型检查:遍历 TypeReferenceNode,取 type.getText(),排除 node.getSourceFile().fileName.endsWith('.d.ts') 的情况
  • 性能优化:仅对 document.languageId === 'typescript' 或 'javascript' 的文件触发,跳过 node_modules 和 dist 目录路径

如何让违规代码无法被 Git 提交

VSCode 插件本身无权拦截 git commit,但可通过 git.hooks 配合本地 pre-commit 脚本联动。插件需暴露一个 CLI 入口供脚本调用,例如 npx vscode-custom-linter --files src/**/*.{ts,js}。

VSCode
VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载

这个 CLI 不依赖 VSCode 环境,底层复用同一套 ts-morph 校验逻辑,返回标准 JSON 格式错误列表(含 file、line、message)。pre-commit 脚本捕获非零退出码并打印错误,阻断提交:

#!/bin/sh
npx vscode-custom-linter --files $(git diff --cached --name-only --diff-filter=ACM | grep -E '\.(ts|js)$') || exit 1
  • 必须用 git diff --cached 而非 git status,否则会误检未暂存的修改
  • CLI 中需设置 project.addSourceFilesAtPaths() 时忽略 node_modules,否则首次运行极慢
  • VSCode 插件 UI 层显示的错误行号要和 CLI 输出严格一致,否则开发者无法定位——这要求两者共用同一版 ts-morph 和相同 CompilerOptions

调试时 AST 节点类型总对不上怎么办

常见现象:写了 node.isKind(ts.SyntaxKind.CallExpression) 却始终不进分支,实际是节点类型为 ts.SyntaxKind.ExpressionStatement 包裹了 CallExpression。TS 的 AST 结构比直觉深一层。

正确做法永远先打印节点全貌:

console.log(node.getFullText().substring(0, 100));
console.log(node.getKindName()); // 不要用 node.kind,它返回数字
  • 不要依赖 node.getText() 判断内容,它可能包含换行或空格;优先用 node.getKindName() + node.getFullText().trim()
  • node.getParent() 可能返回 undefined,需判空;深层嵌套建议用 node.forEachDescendant() 替代递归遍历
  • 测试用例必须覆盖单行/多行字符串、模板字面量、带注释的语句——这些场景下 getFullText() 返回值差异极大

最易被忽略的是:ts-morph 默认使用项目根目录下的 tsconfig.json,但如果工作区打开的是子文件夹,需显式传入 tsConfigFilePath: path.join(workspaceFolder, 'tsconfig.json'),否则类型解析失败导致节点缺失。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
vscode是什么_vscode怎么安装配置
vscode是什么_vscode怎么安装配置

VS Code(Visual Studio Code)是一款免费、开源的跨平台代码编辑器,由微软开发和维护。它被广泛用于软件开发和编程,支持多种编程语言和框架。VS Code 同时提供了丰富的功能和扩展性,使开发者可以高效地编写、编辑和调试代码。

2023.06.30

1475

18

vscode怎么运行代码
vscode怎么运行代码

vscode是一个运行于MacOS X、Windows和Linux之上的,针对于编写现代Web和云应用的跨平台源代码编辑器;vscode免费而且功能强大,对JavaScript和NodeJS的支持非常好,自带很多功能,例如代码格式化,代码智能提示补全、Emmet插件等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.21

3132

3

vscode使用的框架介绍
vscode使用的框架介绍

VSCode是一款跨平台代码编辑器,它基于Electron框架和Monaco Editor构建。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

2049

12

vscode一般用来写什么语言
vscode一般用来写什么语言

VSCode是一款功能强大的代码编辑器,支持多种编程语言和文件格式。它内置对 JavaScript、Python、Java、C++、TypeScript、HTML/CSS、Go 等语言的支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1747

8

vscode可以写什么语言
vscode可以写什么语言

vscode是一款强大的代码编辑器,支持多种编程语言的开发。通过安装扩展,可以为 JavaScript/TypeScript、Python、Java、C#、PHP、Go、Ruby、Rust、HTML/CSS 等语言提供智能代码补全、调试和格式化等功能。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

2627

12

vscode中文设置方法
vscode中文设置方法

方法一:在设置页面中,搜索“locale”,并选择“zh-cn”。方法二:按“Ctrl Shift P”快捷键,输入“Configure Display Language”,将语言修改为“zh-cn”。如果上述方法无效,可考虑安装中文插件。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1838

14

vscode用途介绍
vscode用途介绍

Visual Studio Code(VSCode)是一款由 Microsoft 开发的多功能文本编辑器,适用于各种编程语言。作为一款开源软件,VSCode 拥有代码高亮、自动补全、调试、Git 集成等强大功能,成为程序员不可或缺的工具。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1262

10

vscode和visualstudio的区别
vscode和visualstudio的区别

Visual Studio是一款功能强大的集成开发环境(IDE),适用于专业开发人员进行复杂项目的构建。而VSCode则是一款轻量级的代码编辑器,更适合各种规模的项目开发。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1136

8

vscode设置中文界面不生效解决方法
vscode设置中文界面不生效解决方法

vscode设置中文界面不生效解决方法:安装中文语言包、通过命令面板设置语言、检查 locale.json 设置、重新安装中文语言包、检查 VSCode 版本和更新、排除插件冲突、检查系统语言设置、查看 VSCode 日志和错误消息、重置 VSCode 设置、查看官方文档和社区支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

534

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程