插件目录名称

插件的目录名称就是插件的唯一ID,不能和其他插件冲突,名称只能用英文单词,不支持用空格分割。

package.json

所有的插件在根目录都要有一个package.json文件,该文件继承npm规范,并扩展了部分字段,以下列出各个字段的含义:

字段名称 类型 是否必须 描述
name String 插件名称
displayName String 用于展示在插件列表中的名称
version String 插件版本号,检查升级时会用到
engines Object 该Object的属性至少要包含HBuilderX,属性值为兼容的主版本号,如果HBuilderX的版本低于该版本,将会提示用户升级HBuilderX。例如:{“HBuilderX”:”^2.7.0”}。
description String 简短的插件描述,不要超过30个字
main String 插件代码入口文件,配置型插件可不填
activationEvents Array 激活事件的列表,如为空,则表示该插件不会懒加载
contributes Object 插件的配置扩展点
extensionDependencies Array 该插件依赖的其他插件id

示例

  1. {
  2. "name": "helloworld",
  3. "displayName":"简单的插件示例",
  4. "description": "简单的插件示例,用于测试插件API",
  5. "version": "1.0.0",
  6. "publisher": "coder",
  7. "engines": {
  8. "HBuilderX": "^2.7.0"
  9. },
  10. "categories": [
  11. "Other"
  12. ],
  13. "main": "./extension",
  14. "activationEvents": [
  15. "onCommand:extension.helloWorld",
  16. "onView:extensions.treedemo"
  17. ],
  18. "contributes": {},
  19. "extensionDependencies": [
  20. "foo1","bar1"
  21. ],
  22. "dependencies": {}
  23. }