注册命令需在activate中调用vscode.commands.registerCommand,ID须与package.json中contributes.commands.command完全一致,并在deactivate中返回清理函数。

怎么注册一个命令并让它在命令面板里出现
插件最基础的交互入口就是命令(registerCommand),不注册就无法被用户触发。VSCode 启动时会在 activate 函数中执行初始化逻辑,这里必须调用 vscode.commands.registerCommand,传入唯一字符串 ID 和回调函数。
常见错误是 ID 写错或没导出:ID 必须和 package.json 的 contributes.commands.command 字段完全一致;回调函数里如果用了 this,记得用箭头函数或手动 bind,否则上下文丢失。
-
package.json中要声明:"contributes": { "commands": [{ "command": "myExtension.sayHello", "title": "Say Hello" }] } - 在
extension.ts里注册:vscode.commands.registerCommand('myExtension.sayHello', () => vscode.window.showInformationMessage('Hello!')); - 别忘了在
deactivate里返回一个清理函数(哪怕为空),否则某些场景下热重载会失败
如何读取当前打开的文件内容并做简单处理
编辑器内容不是靠 fs.readFile 直接读磁盘路径——那是不安全且可能过期的。正确方式是通过 vscode.window.activeTextEditor 获取编辑器实例,再用 document.getText() 拿到最新缓存内容。
注意:activeTextEditor 可能为 undefined(比如没打开文件、焦点在终端或设置页),必须判空;另外 getText() 返回的是整个文档字符串,如需操作某一行,用 document.lineAt(lineNumber) 更可靠。
- 获取当前选中文本:
const editor = vscode.window.activeTextEditor; const selection = editor?.selection; const text = editor?.document.getText(selection);
- 修改文本需走
TextEdit+WorkspaceEdit流程,不能直接赋值document.text - 大文件(>10MB)下
getText()可能卡顿,建议加if (document.lineCount 做轻量级保护
为什么插件安装后命令不显示,或者点不动
最常踩的坑是 package.json 配置不全或格式错误。VSCode 不报错也不提示,只是静默忽略整个 contributes 段。尤其注意:activationEvents 必须包含触发条件(比如 onCommand:myExtension.sayHello),否则插件根本不会被激活。
1、架构轻盈,完全免费与开源采用轻量MVC架构开发,兼顾效率与拓展性。全局高效缓存,打造飞速体验。 2、让简洁与强大并存强大字段自定义功能,完善的后台开关模块,不会编程也能搭建各类网站系统。 3、顶级搜索引擎优化功能纯静态、伪静态,全部支持自由设置规则,内容、栏目自由设置URL格式。 4、会员、留言、投稿、支付购物神马一个不能少不断升级完善的模块与插件,灵活的组装与自定义设置,满足你的多样需求。
另一个高频问题是扩展 ID 冲突:如果你在 package.json 里写了 "name": "my-extension",但发布时用了别人已注册的 ID(publisher.name 组合),本地调试没问题,打包上传后会被 Marketplace 拒绝,导致你反复重装却始终看不到效果。
- 检查
activationEvents是否包含对应命令:"activationEvents": ["onCommand:myExtension.sayHello"]
- 确保
main字段指向编译后的 JS 入口(如./out/extension.js),而不是 TS 源码 - 运行
Developer: Toggle Developer Tools,看 Console 有没有Cannot find module或Extension host terminated报错
调试插件时断点不生效或控制台没输出
VSCode 插件运行在独立的 Extension Host 进程里,不是直接跑在主窗口进程。所以不能像普通 Node 脚本那样 F5 启动,必须依赖 .vscode/launch.json 的 Attach to Extension Host 配置。
断点失效往往是因为源码映射(source map)没对齐:TypeScript 编译后路径变了,但 launch.json 里的 outFiles 没配对,或者 tsconfig.json 里 sourceMap 关了。控制台没输出则可能是 console.log 被吞了——插件里请统一用 vscode.window.showInformationMessage 或写日志到 vscode.workspace.createFileSystemWatcher 监听的临时文件。
- 确认
tsconfig.json含:"sourceMap": true, "outDir": "./out", "rootDir": "./src"
-
launch.json的outFiles应为["${workspaceFolder}/out/**/*.js"] - 不要依赖
console.log查变量,改用debugger;配合断点,更准
dispose(),会导致内存泄漏;或者在 deactivate 里没清理定时器,下次启动时多个实例叠加执行。这些不会立刻报错,但上线后用户反馈“VSCode 越来越卡”,排查起来非常耗时。









