Extension definition

Overview

The extension definition defines information related to the extension as a whole.

Extension definition elements

Key Value Description
Required
name Any name that is unique to all extensions. Required
displayName Display name of extension 1 -
description Description of the extension 1 -
icon Extension icon 1 -
version Extension version 1 -
publisher Extension provider 1 -
license Extension license 1 -
homepage Homepage URL for extensions 1 -
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 executable program Required
lifecycle Extension lifecycle. One of application or project. Required
baseprofile The profile name of the project for which the extension is enabled. Valid in all projects if baseprofile is not set or if the value is *. If it is valid for multiple profiles, enumerate them with commas. -
extensionPoints Extension extension points definition -

Definition example

Definition examples for each life cycle

For application life cycle

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

    "main": "entrypoint.cs",
    "lifecycle": "application", //application lifecycle

    "extensionPoints": {
        ...
    }
}

For the project life cycle

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

    "main": "entrypoint.cs",
    "lifecycle": "project", //project lifecycle
    "baseprofile": "Target profile name", //Profile name of the project in which the extension is enabled

    "extensionPoints": {
        ...
    }
}

Definition examples for each implementation method

For C# scripts

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

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

    "extensionPoints": {
        ...
    }
}

For .NET DLLs

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

    "main": "helloworld.dll", //specify the DLL file
    "lifecycle": "project",
    "baseprofile": "Target profile name",

    "extensionPoints": {
        ...
    }
}

  1. -In the current version, it does not affect the behavior of the extension and is not displayed.