configuration

Contribution Points are a set of JSON declarations that you make in the contributes field of the package.json Extension Manifest. The following is a list of extension points currently supported by HBuilderX:

configuration

The configuration extension point will register the extended configuration items in the global visualization configuration of HBuilderX Settings-Plugins.

configuration attributes list

title

The configuration of each extension is assigned to the same group. The title is the name of the group and usually the name of the extension.

title

The configuration of each extension is assigned to the same group. The title refers to the name of the group, and usually the name of the extension.

properties

The configuration in the properties is a jsonobject object, the key of the object represents the id of the configuration item to be extended, and the value is a conformity to JSON Schema canonical jsonobject, currently supported fields include:

• type: string or boolean or number
• description
• default
• enum Optional value, only string or number

configuration exmpale

    "contributes": {
        "configuration":{
            "title":"eslint-js",
            "properties":{
                "eslint-js.autoFixOnSave":{
                    "type":"boolean",
                    "default":true,
                    "description":"Automatically fix when saving"
                },
                "eslint-js.validateOnDocumentChanged":{
                    "type":"boolean",
                    "default":false,
                    "description":"Enable real-time verification"
                }
            }
        }
    }

As follows：

commands

Contribute the UI for a command consisting of a title and (optionally) an icon, category, and enabled state. Presentation of contributed commands depends on the containing menu.

Note: When a command is invoked, it will emit an activationEvent onCommand:${commandId}.

Example

    "contributes": {
        "commands": [
          {
            "command": "extension.firstExtension",
            "title": "Hello World"
          }
        ]
    }

keybindings

Supported from HBuilderX 3.1.22+

Contribute a key binding rule defining what command should be invoked when the user presses a key combination.

Example

"keybindings":[
    {
        "command":"extension.firstExtension", 
        "key":"Ctrl+Shift+C",
        "when":"", 
        "macosx":"command+Shift+C"
    }
]

snippets

Contribute snippets for a specific language, See [here] for the list of extensible programming language Id (/ExtensionDocs/Api/other/languageId). The extended sample code is as follows:

    "contributes": {
        "snippets": [
          {
            "language": "css",
            "path": "./snippets/css.json"
          },
          {
            "project":"uni-app",
            "language": "css",
            "path": "./snippets/condition_comment.json"
          }
        ]
    }

Attribute list

Snippets format

The description of each configuration item is as follows:

Example

// ./snippets/javascript.json
{
    "console.log": {
        "prefix": "logtwo",
        "body": [
            "console.log('$1');",
            "\tconsole.log('${2:foo/bar}');"
        ],
        "triggerAssist": false,
        "description": "Log output to console twice"
    }
}

viewsContainers

Contribute a view container into which Custom views can be contributed. The complete extended view process reference How to register a new view?

Attribute list

Example

   "contributes": {
       "viewsContainers": {
           "activitybar": [{
               "id": "demoview",
               "title": "DemoView"
           }],
           "rightside":[{
                   "id":"rightsideContainerId",
                   "title":"rightside Container Title"
          }]
       },
       "views": {
           "demoview": [{
               "id": "extensions.treedemo",
               "name": "DemoView"
           }]
       },
       ...
    }

ViewsContainerDef

views

Extend the new view, you must specify an identifier and name for the view.

TreeView and WebView are supported, and a view container (viewsContainers) only supports binding one view (view).

After the extension point is declared, you need to pass the API to:window.createTreeView or window.createWebView. The complete extended view process reference How to register a new view?

TreeView Example

    //NOTE：package.json are not supported comments, you need to delete the comments when using the following code
   "contributes": {
       "views": {
           "demoview": [{
               //The id needs to be consistent with the viewId parameter in window.createTreeView
               "id": "extensions.treedemo",
               "name": "DemoView"
           }]
       }
    }

WebView Example

Supported from HBuilderX 2.8.1+

 "contributes": {
        "viewsContainers": {
            "rightside":[
                {
                    "id":"containerId",
                    "title":"Container Title"
                }
            ]
        },
        "views": {
            "containerId":[
                {
                    //The id needs to be consistent with the viewId parameter in window.createTreeView
                    "id":"viewId",
                    "title":"Custom View Title"
                }
            ]
        },
        ...
     }

menus

Contribute a menu item for a command to the editor or Explorer. The menu item definition contains the command that should be invoked when selected and the condition under which the item should show.

The key in the object configured under the menus node refers to which pop-up menu to register to. The currently supported key value list is as follows:

• editor/context ：Editor right-click menu
• explorer/context ：Project Explorer right-click menu
• view/item/context ：Right-click menu of View extended by views extension point（Supported from HBuilderX 2.7.12+）
• menubar/file : The File menu of the top menu
• menubar/edit : The Edit menu of the top menu
• menubar/select : The Select menu of the top menu
• menubar/find : The Find menu of the top menu
• menubar/goto : The Goto menu of the top menu
• menubar/run : The Run menu of the top menu
• menubar/publish : The Build menu of the top menu
• menubar/view : The View menu of the top menu
• menubar/tool : The Tool menu of the top menu
• menubar/help : The Help menu of the top menu

Menus Attribute list

When the attributes title and command are both empty, it will be recognized as a dividing line.

Example

   "contributes": {
       "menus": {
         "editor/context": [
           {
             "id":"sep",
             "group": "z_commands"
           },
           {
             "command": "extension.firstExtension",
             "group": "z_commands",
             "when":"editorTextFocus"
           }
         ]
       }
    }

Register secondary menu

The secondary menu is implemented by setting the group to %menuId%@1, %menuId%@2, where menuId refers to the id field in the menu extension. The code example is as follows:

   "contributes": {
       "menus": {
         "editor/context": [
           {
             "id":"foo",
             "title": "Menu with submenu",
             "group": "z_commands",
           },
           {
             "command": "extension.firstExtension",
             "group": "foo@1",
             "when":"editorTextFocus"
           }
         ]
       }
    }

group

The group in each pop-up menu is different, and all the groups available under the pop-up menu are listed below.

Note: To put the extended menu at the end of the pop-up menu, you can set the group to 0_foot

• editor/context
  • copy
  • goto
  • copyPath
  • assist
  • z_commands

As shown below:

• explorer/context: Project manager right-click menu
  • new
  • openInExplorer
  • nature
  • cutcopy
  • rename
  • z_commands

As shown below:

• menubar/file : File menu
  • new
  • tab
  • save
  • openInExplorer

As shown below:

• menubar/edit : Edit menu
  • undo
  • copy
  • format
  • line
  • delete

As shown below:

• menubar/select : Select menu
  • selectAll
  • area
  • word
  • line
  • colum
  • 0_cursor
  • 1_cursor

As shown below:

• menubar/find : Find menu
  • findFile
  • findWord
  • findSymbol

As shown below:

• menubar/goto : Goto menu
  • system_goto
  • line_goto
  • define_goto

As shown below:

• menubar/run : Run menu
  • 0_foot

The corresponding position is at the end of the menu.

• menubar/publish : Publish menu
  • 0_foot

The corresponding position is at the end of the menu.

• menubar/view : View menu
  • min_window
  • focus_editor
  • show_lineno
  • view_split
  • scroll
  • plus_font

As shown below:

• menubar/tool : Tool menu
  • shortcuts
  • snippets
  • ext_settings

As shown below:

• menubar/help : Help menu
  • documents
  • checkupdate
  • license

As shown below:

when

The when expression is used to dynamically determine whether a certain condition is satisfied (that is, the result of the expression is true or false). It is currently used to control whether a menu is displayed. The currently supported expression operators are as follows:

The current HBuilderX built-in variable list is as follows:

customEditors

The customEditors contribution point is how your extension tells HBuilderX about the custom editors that it provides. For example, HBuilderX needs to know what types of files your custom editor works with as well as how to identify your custom editor in any UI.

Complete reference for the process of extending a custom editor How to extend a custom editor?

For example:

 "contributes": {
        "customEditors": [{
            "viewType": "catEdit.catScratch",
            "displayName": "Cat Scratch",
            "selector": [{
                "fileNamePattern": "*.cscratch"
            }],
            "priority": "default"
        },
        ...]
    }

Attributes List

EditorSelctor