extension definition

Overview

The extension definition defines information related to the entire extension.

Extension definition elements

key	value description	required
name	any name that is unique across all extensions	required
displayName	extension display name 1	-
description	extension description 1	-
icon	extension icon 1	-
version	Extension version 1	-
publisher	Publisher of the extension 1	-
license	extension license 1	-
homepage	Extension homepage URL1	-
categories	Array of category names to which the extension belongs 1	-
env	Extension operating environment 1	-
main	File name (script or DLL) that is the entry point of the execution program	Required
lifecycle	Extension lifecycle. Either application or project.	required
baseprofile	The profile name of the project for which the extension is enabled. If valid for multiple profiles, list those profile names separated by commas. If you specify the profile name in the format of *.package name, the profile that has that package name in the first layer of the profile will be enabled (example: *.UML). If there is no baseprofile setting, or if the value is *, it is valid for all projects.	-
extensionPoints	extension point definitions for extensions	-
runtime	Extension execution environment definition	-

Definition example for each lifecycle

For Application Lifecycle

manifest.json

{
    "name": "Hello World",
    "displayName": "Hello World",
    "description": "Displays Hello World on the screen.",
    "main": "entrypoint.cs",
    "lifecycle": "application", //application lifecycle
    "extensionPoints": {
        ...
    }
}

For Project Lifecycle

manifest.json

{
    "name": "Hello World",
    "displayName": "Hello World",
    "description": "Displays Hello World on the screen.",
    "main": "entrypoint.cs",
    "lifecycle": "project", //project lifecycle
    "baseprofile": "target profile name", //profile name of the project for which the extension is enabled

    "extensionPoints": {
        ...
    }
}

Definition example for each implementation method

For C# scripts

manifest.json

{
    "name": "Hello World",
    "displayName": "Hello World",
    "description": "Displays Hello World on the screen.",
    "main": "main.cs", //specify script file
    "lifecycle": "project",
    "baseprofile": "target profile name",
    "extensionPoints": {
        ...
    }
}

For .NET DLLs

manifest.json

{
    "name": "HelloWorld",
    "displayName": "Hello World",
    "description": "Displays Hello World on the screen.",
    "main": "helloworld.dll", //specify DLL file
    "lifecycle": "project",
    "baseprofile": "target profile name",

    "extensionPoints": {
        ...
    }
}

Detailed definition example

manifest.json

{
    "name": "HelloWorld",
    "displayName": "Hello World",
    "description": "Displays Hello World on the screen.",
    "icon": "resources/About.png",
    "version": "1.1.0",
    "publisher": "DENSO CREATE INC",
    "license": "According to the Next Design License Agreement. Copyright (C) 2019 DENSO CREATE INC.",
    "homepage": "https://www.denso-create.jp",
    "categories": [ "Common" ],
    "env": {
        "nextdesign": "1.1.0"
    },

    "main": "main.cs", //specify script file
    "lifecycle": "project",
    "baseprofile": "target profile name",

    "extensionPoints": {
        ...
    },

    "runtime" : {
        ...
    }
}

Footnotes

1. In the current version it does not affect the behavior of the extension and is not displayed. ↩ ↩² ↩³ ↩⁴ ↩⁵ ↩⁶ ↩⁷ ↩⁸ ↩⁹