atom右键菜单功能需修改对应系统菜单配置文件,windows为menus/win32.cson;command须在main.js中用atom.commands.add()注册;文本处理应优先用settextinbufferrange()精准替换;图标、分隔线等由cson字段控制,但无运行时条件显示能力。

右键菜单添加功能必须改 menus/win32.cson(Windows)
Atom 的右键菜单不走系统注册表,也不靠插件自动注入,所有自定义项都必须写进对应操作系统的菜单配置文件。Windows 用户路径是 ~/.atom/packages/your-package-name/menus/win32.cson,不是 ~/.atom/menu.cson 或其他位置——放错地方就完全不生效。
这个文件用 CSON 格式(类似 JSON 但支持注释和省略引号),结构必须严格匹配选择器。常见错误包括:顶层 key 写成 'context-menu' 而不是 'atom-text-editor',或把命令塞进 menu 数组里而非 context-menu 下的子数组。
-
'atom-text-editor':绑定到编辑器内容区右键(最常用) -
'.tree-view':绑定到左侧文件树右键(适合“在终端打开当前目录”类操作) -
'atom-workspace':绑定到整个窗口空白处(慎用,易误触)
command 必须提前注册,不能只写名字
菜单项里的 command 字段只是个字符串标识符,比如 'my-text-utils:upper-case',它本身不会执行任何逻辑。你必须在插件主文件(如 lib/main.js)中用 atom.commands.add() 显式绑定函数,否则右键点了没反应,控制台也无报错。
例如:
atom.commands.add('atom-text-editor', {
'my-text-utils:upper-case'() {
const editor = atom.workspace.getActiveTextEditor();
if (!editor) return;
const selection = editor.getSelectedText();
if (!selection) return;
editor.insertText(selection.toUpperCase());
}
});
注意作用域:上面绑在 'atom-text-editor' 上,所以只在编辑器区域右键时可用;如果想在文件树里也触发,得额外加一行 atom.commands.add('.tree-view', { ... })。
文本处理类命令要小心选中范围与光标位置
直接调 editor.getSelectedText() 只能拿到当前选中内容,但用户右键时可能没选任何东西(比如想把光标所在单词转大写)。这时候得自己解析:
- 用
editor.getWordUnderCursor()拿当前词(默认空格分隔) - 用
editor.lineTextForBufferRow(editor.getCursorBufferPosition().row)拿整行 - 用
editor.selectAll()配合判断是否已选中,避免误操作全文件
更关键的是:处理完文本后,editor.insertText() 会把光标移到插入末尾,而 editor.setTextInBufferRange() 才能精准替换原选区——后者才是安全做法,尤其对大小写转换、缩进调整等操作。
图标、分隔线、禁用状态全靠 CSON 结构控制
CSON 文件里每条菜单项是一个对象,支持 label、command、icon、enabled、type: 'separator' 等字段。但 enabled 是布尔值,不能写成字符串 "false";icon 值必须是 Atom 内置图标名(如 'icon-file-text'),不支持自定义路径。
常见陷阱:
- 加了
type: 'separator'却漏掉逗号,导致整个 CSON 解析失败,菜单消失 - 用
icon: 'fa-cut'这类 Font Awesome 名称——Atom 不识别,图标变空白 - 想根据是否有选中文本动态禁用菜单项,但 CSON 不支持运行时逻辑,只能靠
command函数内部返回早退(视觉上仍显示,点下去才无响应)
真正需要条件显示的场景(比如“仅当有选中文本时才显示‘反转字符串’”),得用 atom.contextMenu.add() 动态注册,而不是静态 CSON。











