必须用apm develop创建插件骨架,手动建目录易漏字段致Atom不识别;改代码后需Ctrl+Alt+R重载窗口,不可仅重启;require第三方模块须apm install而非npm install;调试必查开发者工具Console与Sources。

用 apm develop 创建插件骨架,别手动建文件夹
直接在 ~/.atom/packages/ 下新建文件夹、手写 package.json 和 lib/main.js,容易漏掉关键字段或结构错位,导致 Atom 根本不识别。正确做法是用 Atom 自带的 apm develop 命令生成合规模板:
- 终端执行
apm develop my-cool-plugin(my-cool-plugin是你起的名字) - 它会自动创建目录
~/.atom/packages/my-cool-plugin,含完整结构:package.json、lib/main.js、keymaps/、menus/等 -
package.json中已预置"main": "./lib/main.js"和"version": "0.0.0",且engines.atom匹配当前 Atom 版本
改完代码必须 reload,不能只重启 Atom
插件开发中频繁修改 lib/main.js 后,仅关闭再打开 Atom 不会重新加载新代码——Atom 会复用已激活的模块实例。必须触发热重载:
- 快捷键
Ctrl+Alt+R(Windows/Linux)或Cmd+Alt+R(macOS)执行Application: Reload Window - 或打开命令面板(
Ctrl+Shift+P),输入并运行Window: Reload - 如果插件有语法错误,重载后控制台(
Ctrl+Shift+I→ Console)会直接报错,比如Cannot find module 'fs-plus',说明package.json的dependencies没声明或没装
本地依赖要用 apm install,不是 npm install
你在 lib/main.js 里写了 require('season'),但运行时报 Cannot find module 'season'?这不是 Node.js 路径问题,而是 Atom 插件生态不认 npm install:
- 进入插件目录:
cd ~/.atom/packages/my-cool-plugin - 执行
apm install season(不是npm install season) -
apm install会把包装进node_modules/,同时校验engines.atom兼容性,并执行插件自定义的postinstall脚本(如有) - 若跳过这步,直接
require第三方模块,90% 情况下启动即失败
调试时打开开发者工具看 console 和 sources
插件逻辑没触发、activate() 方法没执行?别猜,直接看证据:
- 按
Ctrl+Shift+I打开开发者工具,切到Console标签页:是否有Failed to activate package 'my-cool-plugin'或TypeError: Cannot read property 'onDidStopChanging' of undefined - 切到
Sources标签页,在左侧文件树展开webpack://.→~/.atom/packages/my-cool-plugin/lib/main.js,确认断点能命中 - 常见陷阱:
package.json的"main"字段拼错路径(如写成"./src/main.js"但实际是"./lib/main.js"),或activate()里漏了this.subscriptions = new CompositeDisposable()导致后续事件监听失效
apm develop?那必须先在同版本 Atom 的联网机上跑一遍,生成含 node_modules 的完整目录,再拷过去——源码本身不等于可运行插件。

















