✨ Extension Manifest

[jasonplatts]

Overview

All extensions should include a JSON manifest file in the root directory of the extension. The file provides information used to display the extension in the "marketplace" when published and also information required to successfully run the extension, such as the location of the main entry point to the extension (eg: main.js) and dependencies.

Example Manifest

{
  "name": "helloworld",
  "displayName": "Hello World!",
  "description": "The Hello World extension is available to CodeEdit users wishing to display the phrase 'Hello World' in an endless loop.",
  "version": "1.0",
  "publisher": "Extensions-R-Us",
  "repository": "https://github.com/extensions-r-us/helloworld",
  "homepage": "https://extensionsrus.com/helloworld",
  "bugs": "https://github.com/extensions-r-us/helloworld",
  "categories": ["Snippets, Testing, Other"],
  "icon": "images/icon.png"
  "activationEvents": ["onCommand:helloworld.helloWorld", "onLanguage:markdown"],
  "main": "./out/extension.js",
  "contributes": {
    "commands": [
      {
        "command": "helloworld.helloWorld",
        "title": "Hello World"
      }
    ]
  },
  "scripts": {
    "vscode:prepublish": "npm run compile",
    "compile": "tsc -p ./",
    "watch": "tsc -watch -p ./"
  },
  "devDependencies": {
    "@types/node": "^8.10.25",
    "@types/vscode": "^1.51.0",
    "tslint": "^5.16.0",
    "typescript": "^3.4.5"
  }
}

Resources

https://code.visualstudio.com/api/get-started/extension-anatomy#extension-manifest
https://code.visualstudio.com/api/references/extension-manifest