展开菜单
首页 精品内容 本月促销 装机必备 Windows PDF教程 macOS软件 IOS软件 Android AI 专题
全部分类

当前位置:

首页 > 编程开发 > VSCode插件开发示例_手把手教你做一个代码统计插件

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

VS Code代码行数统计插件漏统计的主因是仅监听onDidChangeTextDocument而忽略文件打开、切换等场景;须同时监听onDidOpenTextDocument、onDidChangeActiveTextEditor(需判空)和onDidChangeTextDocument,并逐行扫

本文目录

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

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

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

    开发过代码统计插件的朋友,大概率都踩过这个坑:插件明明运行着,可一打开新文件,行数显示却是个大大的“0”。用户难免会疑惑:是我的代码不配被统计吗?

    其实问题根源很明确:onDidChangeTextDocument 这个监听器,顾名思义,它只响应文档内容变更。当用户首次打开一个 .js 文件,或者从资源管理器直接点开时,文档只是被加载到编辑器里,内容并未修改,这个事件自然不会触发。插件没收到通知,自然也就不会去统计,结果就漏了。

    所以,正确的监听策略必须是“三管齐下”:

    • 用 vscode.workspace.onDidOpenTextDocument 捕获新文件打开的动作。
    • 用 vscode.window.onDidChangeActiveTextEditor 捕获用户在多个标签页之间切换焦点的行为(比如从 A.ts 切到 B.py)。
    • 最后,再用 onDidChangeTextDocument 来兜底,确保代码被编辑时,统计数据能实时更新。

    这里有个细节需要特别留意:onDidChangeActiveTextEditor 的回调参数,在某些情况下(例如用户把焦点从编辑器移到了终端面板)会是 null。如果不做判空处理,直接去访问其属性,插件就会崩溃。这是新手很容易疏忽的一个点。

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

    解决了“何时统计”的问题,接下来就是“如何统计”了。直接使用 document.lineCount 获取总行数?这显然不对,因为它会把空行、注释行(包括多行注释中间的空行)全都算进去。我们真正需要的,通常是“有效的、非注释的代码行数”。

    这就需要我们手动进行逐行扫描和判断,关键点有三个:

    • 逐行处理:调用 document.lineAt(i).text.trim() 获取每一行的内容并去除首尾空格。如果结果是空字符串,那就是空行,跳过。
    • 识别单行注释:使用正则表达式 /^\s*\/\/.*$/ 来判断。注意,行首可能存在的空格或制表符也要匹配进去。
    • 处理多行注释:这是稍微复杂的地方。需要维护一个状态变量,当遇到 /* 时,进入“注释模式”,在此之后直到遇到 */ 之前的所有行(包括其中的空行),都应被视为注释行而忽略。

    另外,性能上也要注意。切忌使用 document.getText().split(‘\n’) 这种方式一次性把整个文件内容拆分成数组。对于超过10MB的大文件,这种操作极易导致内存激增甚至卡死。VS Code官方推荐的流式访问方式,正是逐行调用 lineAt(),这对内存更加友好。

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

    好不容易把数字正确显示在状态栏了,用户想点击查看详情,却发现毫无反应。这多半是交互逻辑没配置完整。

    VS Code的状态栏项(StatusBarItem)默认只是一个被动的显示控件,要让它可点击,必须显式地为其指定一个命令。你需要:

    • 在创建状态栏项后,设置 item.command = ‘extension.showStats’(这里‘extension.showStats’是你自定义的命令ID)。
    • 在插件的 package.json 文件的 contributes.commands 部分,注册这个同名命令。
    • 在插件的激活函数 activate() 中,使用 vscode.commands.registerCommand() 来绑定这个命令ID和具体的处理函数。

    常见的疏漏包括:命令ID的大小写不一致(VS Code对此是敏感的)、忘记了注册命令,或者最基础的——没有调用 item.show() 方法。记住,即使你设置了 text 属性,不调用 show(),状态栏项就根本不会渲染出来。

    一个简单的调试技巧:在命令的处理函数里,先加上一行 vscode.window.showInformationMessage(‘clicked!’)。如果点击状态栏能弹出这个信息提示,就证明命令绑定成功了。

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

    这是使用TypeScript开发插件,在打包发布环节最经典的错误之一。本地测试一切正常,但用 vsce package 打包成 .vsix 文件给别人安装后,却报错找不到模块。

    问题的核心在于路径解析。你的 package.json 里 main 字段很可能写的是 ./src/extension.ts。然而,VS Code插件运行时加载的是Ja vaScript文件,而不是TypeScript源文件。vsce 这个打包工具默认不会帮你执行TypeScript编译。

    因此,必须确保两件事:

    • 首先,检查 tsconfig.json,确保输出目录 outDir 设置为 ./out,并且源代码根目录 rootDir 正确指向 ./src。
    • 然后,将 package.json 中的 main 字段修改为编译后的入口文件路径:./out/extension.js。

    为了避免每次打包前都忘记编译,一个非常实用的做法是在 package.json 的 scripts 里加一条命令:“package”: “tsc && vsce package”。这样,运行 npm run package 就能自动完成编译和打包。

    当然,随着插件变得复杂,可能会引入Webpack打包、处理 node_modules 依赖等更高级的方案,这些都会改变最终的输出结构。但对于一个纯TypeScript的插件起步阶段而言,牢牢守住“编译输出到 out 目录,并将 main 指向 out/extension.js”这条底线,就能避开这个最常见的发布陷阱。

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发
    相关文章 更多
    精品专题 更多
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    macOS软件

    正软商城macOS软件专区,精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具,提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。

    IOS软件

    正软商城iOS软件专区,精选适用于iPhone和iPad的办公、学习、影音、设计、效率及AI应用,提供功能介绍、适用设备、系统要求和正版获取方式等信息。

    AI

    正软商城AI软件专区,汇集AI写作、AI绘画、AI视频、AI办公、AI编程、AI翻译、智能客服和数据分析等人工智能工具,提供功能介绍、适用平台、收费方式及正版购买信息。

    Mac软件 更多
    IntelliJ IDEA macOS版
    IntelliJ IDEA macOS版

    IntelliJ IDEA 是 JetBrains 推出的专业集成开发环境,重点服务于 Java、Kotlin 与 JVM 项目开发。软件集成代码补全、静态检查、重构、调试、测试、版本控制及构建工具,并可借助插件扩展语言和框架支持。

    PyCharm macOS版
    PyCharm macOS版

    JetBrains PyCharm 是面向 Python 开发者的集成开发环境,提供智能补全、代码检查、重构、调试、测试、版本控制及虚拟环境管理功能。Mac 版兼容 Intel 与 Apple 芯片,核心功能可免费使用。

    WebStorm macOS版
    WebStorm macOS版

    JetBrains WebStorm 是面向 JavaScript、TypeScript 和现代 Web 技术的专业集成开发环境,可智能理解项目结构,提供代码补全、重构、错误检查、运行调试、测试及 Git 工具。

    After Effects macOS版
    After Effects macOS版

    Adobe After Effects 是面向动态图形、影视特效与视频合成的专业创作软件。它提供关键帧动画、遮罩抠像、运动跟踪、三维空间、文字动画和表达式等工具,并可与 Premiere Pro、Photoshop、Illustrator

    Audition macOS版
    Audition macOS版

    Adobe Audition 是面向播客、影视后期、音乐制作及内容创作者的专业音频工作站,提供波形精修、多轨录制与混音、频谱编辑、降噪修复、响度匹配和效果处理工具,并可与 Adobe Premiere 协同完成视频声音制作。

    Bridge macOS版
    Bridge macOS版

    Adobe Bridge 是面向摄影师、设计师及内容团队的免费数字资产管理工具,可集中预览照片、视频和 Adobe 项目文件,并利用评级、标签、关键词、元数据、筛选与收藏集完成分类检索。它还支持批量重命名、格式导出、相机导入及 Camera

    Illustrator macOS版
    Illustrator macOS版

    Adobe Illustrator 是 Adobe 推出的专业矢量图形设计软件,适合在 Mac 上制作标志、图标、插画、包装、信息图及印刷版面。它以路径和锚点构建可无损缩放的图形,并提供钢笔、形状、文字、图像描摹、渐变、画板及生成式功能。

    InDesign macOS版
    InDesign macOS版

    Adobe InDesign 是面向印刷品与数字出版物的专业版面设计软件,可在 Mac 上制作书籍、杂志、宣传册、海报、报告及交互式文档。它提供精细的文字样式、网格、母版、长文档管理和印前输出能力。

    Lightroom Classic macOS版
    Lightroom Classic macOS版

    Adobe Lightroom Classic 是面向桌面摄影工作流的照片管理与后期处理软件,可将原始照片保存在本地硬盘,通过目录、关键词、评分和收藏夹高效整理图库,并提供 RAW 冲印、蒙版、镜头校正、批量同步及多格式导出等功能。

    Media Encoder macOS版
    Media Encoder macOS版

    Adobe Media Encoder 是 Adobe 推出的专业音视频编码与转码工具,可通过队列、预设和监视文件夹批量完成格式转换、代理文件创建及多平台成片输出,并与 Premiere Pro、After Effects 等软件紧密协作。

    Photoshop macOS版
    Photoshop macOS版

    Adobe Photoshop 是面向摄影师、设计师和内容创作者的专业图像处理软件,提供图层、蒙版、选区、修复、调色、文字排版、智能对象及生成式编辑等能力。Mac 版支持 Intel 与 Apple Silicon 处理器。

    Premiere Pro macOS版
    Premiere Pro macOS版

    Adobe Premiere Pro 是面向专业视频制作的非线性剪辑软件,提供多轨时间线、调色、音频处理、字幕、代理工作流和多格式输出能力,并可与 After Effects、Audition、Photoshop 及 Frame.io 协同

    WINDOWS 更多
    IntelliJ IDEA Windows版
    IntelliJ IDEA Windows版

    JetBrains IntelliJ IDEA 是以 Java、Kotlin 和 JVM 项目为核心的专业集成开发环境,提供智能补全、代码检查、安全重构、调试、测试、版本控制及构建工具集成。统一发行版的核心功能可免费用于商业和非商业项目,

    PhpStorm Windows版
    PhpStorm Windows版

    PhpStorm 是 JetBrains 面向 PHP 与现代 Web 开发打造的专业集成开发环境,提供代码补全、静态检查、重构、调试、测试、数据库、版本控制及前端语言支持。Windows 用户可直接下载安装程序,

    PyCharm Windows版
    PyCharm Windows版

    PyCharm 是 JetBrains 推出的 Python 集成开发环境,提供智能代码补全、错误检查、重构、调试、测试、Git、终端及 Jupyter Notebook 支持。统一版安装后可体验 30 天 Pro 功能,

    WebStorm Windows版
    WebStorm Windows版

    WebStorm 是 JetBrains 面向 JavaScript、TypeScript 和现代 Web 技术打造的集成开发环境。它提供项目级代码分析、智能补全、安全重构、导航搜索,并集成调试、测试、终端、Git 与常用前端工具,

    Photoshop Windows版
    Photoshop Windows版

    Adobe Photoshop 是面向摄影师、设计师和内容创作者的专业图像处理工具,可在 Windows 上完成照片修饰、选区抠图、图层合成、文字排版、绘画及生成式编辑。软件采用订阅授权,由 Creative Cloud 管理安装、更新与许

    InDesign Windows版
    InDesign Windows版

    Adobe InDesign 是面向印刷与数字出版的专业页面排版工具,可制作书籍、杂志、宣传册、海报、交互式 PDF 和电子书。它提供精细的文字样式、多页面管理、印前检查及多格式输出能力,并能与 Photoshop、Illustrator

    Illustrator Windows版
    Illustrator Windows版

    Adobe Illustrator 是用于绘制矢量图形、插画、图标、徽标和版式的专业设计工具。它以路径和锚点为核心,作品放大后仍能保持清晰,并提供画板、文字、渐变、图像描摹及精确变换等功能,适合品牌视觉、印刷物料、数字界面和商业插画创作。

    Bridge Windows版
    Bridge Windows版

    Adobe Bridge 是 Adobe 推出的创意资产管理工具,可集中预览、分类和查找照片、视频、PDF及多种设计文件,并支持元数据、关键词、评级、批量重命名和格式导出。它可与 Photoshop、Illustrator 等应用衔接,

    Lightroom Classic Windows版
    Lightroom Classic Windows版

    Adobe Lightroom Classic 是面向 Windows 桌面摄影工作流的照片管理与无损编辑工具,可通过目录集中整理大型图库,并完成 RAW 显影、局部蒙版、批量调整、打印和多格式导出。它强调本地文件管理与精细控制,

    Acrobat Pro Windows版
    Acrobat Pro Windows版

    Adobe Acrobat Pro 是面向专业 PDF 工作的综合解决方案,可在 Windows 中创建、编辑、转换、比较、整理和保护文档,并支持表单、电子签名、扫描件文字识别及敏感信息永久遮盖。订阅还包含网页、移动服务和云端协作能力,

    After Effects Windows版
    After Effects Windows版

    Adobe After Effects 是面向动态图形、动画与影视视觉特效制作的专业工具,可完成关键帧动画、图层合成、遮罩跟踪、抠像、文字动画和二维三维元素整合。Windows 版通过 Adobe Creative Cloud 安装及更新,

    Media Encoder Windows版
    Media Encoder Windows版

    Adobe Media Encoder 是 Adobe 面向视频与音频制作流程提供的专业编码和转码工具,可批量处理媒体文件、创建代理、套用输出预设并监控文件夹自动执行任务。它与 Premiere、After Effects、Audition