VSCode插件开发示例_手把手教你做一个代码统计插件

小丽大大_6132

小丽大大_6132

2026-04-13

467人浏览

原创

vs code代码行数统计插件漏统计的主因是仅监听ondidchangetextdocument而忽略文件打开、切换等场景;须同时监听ondidopentextdocument、ondidchangeactivetexteditor(需判空)和ondidchangetextdocument,并逐行扫描lineat()计算非空非注释行。

vscode插件开发示例_手把手教你做一个代码统计插件

为什么 vscode.workspace.onDidChangeTextDocument 会漏统计?

代码行数统计插件最常犯的错,就是只监听文档变更却忽略文件打开、关闭、切换标签页等场景。比如用户刚打开一个 .js 文件,此时 onDidChangeTextDocument 根本不会触发——它只响应内容修改,不响应加载。结果插件显示“0 行”,用户一脸问号。

正确做法是三路并进:

  • vscode.workspace.onDidOpenTextDocument 捕获新打开的文件
  • vscode.window.onDidChangeActiveTextEditor 捕获编辑器切换(比如从 A.ts 切到 B.py)
  • 再配合 onDidChangeTextDocument 响应实时编辑

注意:这三者返回的 TextDocument 对象结构一致,但 onDidChangeActiveTextEditor 的回调参数可能为 null(比如焦点切到终端),必须判空。

怎么安全获取当前文件的有效代码行数?

直接用 document.lineCount 是错的——它包含空行、注释行,也把 /* */ 多行注释中间的空行算进去。真实需求往往是“非空非注释行”,得自己扫描。

关键点有三个:

  • 逐行调用 document.lineAt(i).text.trim(),跳过全空白行
  • 用正则判断单行注释:/^\s*\/\/.*$/,注意要匹配行首可能的空白
  • 多行注释状态需手动维护:遇到 /* 开启,遇到 */ 关闭,期间所有行都视为注释(包括空行)

别用 document.getText().split('\n') 全局拆分——大文件(>10MB)会卡顿甚至 OOM;逐行 lineAt() 是 VS Code 官方推荐的流式访问方式。

状态栏显示数字后,为什么点击没反应?

很多人加了 vscode.window.createStatusBarItem() 并设了 text,但忘了绑定点击事件。VS Code 的状态栏项默认不可交互,必须显式调用 item.command = 'extension.showStats',再在 package.jsoncontributes.commands 里注册同名命令。

VSCode
VSCode

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

下载

常见疏漏:

  • 命令 ID 写错大小写(showstatsshowStats
  • 没在 activate() 里调用 vscode.commands.registerCommand()
  • 状态栏项未调用 item.show() —— 即使设置了 text,不 show 就不渲染

调试技巧:在命令回调里加 vscode.window.showInformationMessage('clicked'),快速验证是否绑对了。

打包发布前,为什么本地跑得好,别人装了就报 Cannot find module './extension'

这是 vsce package 打包时路径解析出错的典型表现。根本原因是 package.jsonmain 字段写的是 ./src/extension.ts,但 VS Code 运行时只认编译后的 JS,而 vsce 默认不执行 tsc 编译。

必须做两件事:

  • 确保 tsconfig.jsonoutDir 设为 ./out,且 rootDir 指向 ./src
  • package.jsonmain 改成 ./out/extension.js

顺手加个 npm script:"package": "tsc && vsce package"。否则每次改完代码都要手动 tscvsce,极易漏编译。

复杂点在于:TypeScript 类型声明、node_modules 依赖、以及 webpack 打包方案会进一步改变输出结构——但纯 TS 插件起步阶段,守住 out/extension.js 这条线就够了。

相关文章

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

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

下载

相关标签:

vscode vscode插件开发

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

相关专题

更多
TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

2026.02.13

232

17

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

2026.02.25

460

17

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

2026.03.13

311

19

TypeScript 全栈开发进阶指南
TypeScript 全栈开发进阶指南

面向有 JavaScript 基础的开发者,深入讲解 TypeScript 的类型系统与全栈开发实践。

2026.06.03

226

29

TypeScript Node.js 全栈工程化与Monorepo架构实践
TypeScript Node.js 全栈工程化与Monorepo架构实践

本专题围绕 TypeScript 在 Node.js 全栈开发中的工程化实践展开,系统讲解 Monorepo 架构设计、包管理策略、模块复用机制以及服务端与前端统一类型系统的构建方法。通过真实项目案例,帮助开发者提升大型全栈项目的可维护性与协作效率。

2026.06.16

458

8

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

2023.08.07

1955

5

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.23

2622

1

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

2023.10.13

916

3

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

2025.09.10

2939

7

热门下载

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

精品课程

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