扩展清单

每个 Visual Studio Code 扩展都需要一个位于扩展目录结构根目录下的清单文件 package.json。

字段

另请参阅 npm 的 package.json 参考。

示例

这是一个完整的 package.json

{
  "name": "wordcount",
  "displayName": "Word Count",
  "version": "0.1.0",
  "publisher": "ms-vscode",
  "description": "Markdown Word Count Example - reports out the number of words in a Markdown file.",
  "author": {
    "name": "sean"
  },
  "categories": ["Other"],
  "icon": "images/icon.png",
  "galleryBanner": {
    "color": "#C80000",
    "theme": "dark"
  },
  "pricing": "Free",
  "activationEvents": ["onLanguage:markdown"],
  "engines": {
    "vscode": "^1.0.0"
  },
  "main": "./out/extension",
  "scripts": {
    "vscode:prepublish": "node ./node_modules/vscode/bin/compile",
    "compile": "node ./node_modules/vscode/bin/compile -watch -p ./"
  },
  "devDependencies": {
    "@types/vscode": "^0.10.x",
    "typescript": "^1.6.2"
  },
  "license": "SEE LICENSE IN LICENSE.txt",
  "bugs": {
    "url": "https://github.com/microsoft/vscode-wordcount/issues",
    "email": "sean@contoso.com"
  },
  "repository": {
    "type": "git",
    "url": "https://github.com/microsoft/vscode-wordcount.git"
  },
  "homepage": "https://github.com/microsoft/vscode-wordcount/blob/main/README.md"
}

Marketplace 展示技巧

以下是一些建议和技巧，可以让您的扩展在 VS Code Marketplace 上看起来更棒。

始终使用最新的 vsce，即 npm install -g @vscode/vsce，以确保您拥有它。

在扩展的根文件夹中有一个 README.md Markdown 文件，我们将包含其内容作为扩展详细信息的正文（在 Marketplace 上）。您可以在 README.md 中提供相对路径的图片链接。

这里有一些示例

1. Word Count
2. MD Tools

提供一个好的显示名称和描述。这对 Marketplace 和产品显示都很重要。这些字符串也用于 VS Code 中的文本搜索，相关的关键词将非常有帮助。

    "displayName": "Word Count",
    "description": "Markdown Word Count Example - reports out the number of words in a Markdown file.",

一个图标和对比鲜明的横幅颜色在 Marketplace 页面标题上看起来很棒。theme 属性指的是横幅中使用的字体 - dark 或 light。

{
  "icon": "images/icon.png",
  "galleryBanner": {
    "color": "#C80000",
    "theme": "dark"
  }
}

有几个可选链接（bugs、homepage、repository）您可以设置，这些链接显示在 Marketplace 的资源部分下。

{
  "license": "SEE LICENSE IN LICENSE.txt",
  "homepage": "https://github.com/microsoft/vscode-wordcount/blob/main/README.md",
  "bugs": {
    "url": "https://github.com/microsoft/vscode-wordcount/issues",
    "email": "sean@contoso.com"
  },
  "repository": {
    "type": "git",
    "url": "https://github.com/microsoft/vscode-wordcount.git"
  }
}

为您的扩展设置一个 category。同一 category 下的扩展将在 Marketplace 上分组，从而改善过滤和发现。

注意：仅使用对您的扩展有意义的值。允许的值为 [Programming Languages, Snippets, Linters, Themes, Debuggers, Formatters, Keymaps, SCM Providers, Other, Extension Packs, Language Packs, Data Science, Machine Learning, Visualization, Notebooks, Education, Testing]。对于一般语言功能（如语法高亮和代码补全），请使用 Programming Languages。Language Packs 类别保留给显示语言扩展（例如，本地化的保加利亚语）。

{
  "categories": ["Linters", "Programming Languages", "Other"]
}

批准的徽章

出于安全考虑，我们只允许来自受信任服务的徽章。

我们允许来自以下 URL 前缀的徽章

• api.travis-ci.com
• app.fossa.io
• badge.buildkite.com
• badge.fury.io
• badgen.net
• badges.frapsoft.com
• badges.gitter.im
• cdn.travis-ci.com
• ci.appveyor.com
• circleci.com
• cla.opensource.microsoft.com
• codacy.com
• codeclimate.com
• codecov.io
• coveralls.io
• david-dm.org
• deepscan.io
• dev.azure.com
• docs.rs
• flat.badgen.net
• github.com (仅来自 Workflows)
• gitlab.com
• godoc.org
• goreportcard.com
• img.shields.io
• isitmaintained.com
• marketplace.visualstudio.com
• nodesecurity.io
• opencollective.com
• snyk.io
• travis-ci.com
• visualstudio.com
• vsmarketplacebadges.dev

注意：请将 vsmarketplacebadge.apphb.com 徽章替换为 vsmarketplacebadges.dev 徽章。

如果您有其他想要使用的徽章，请在 GitHub 上 提出 issue，我们将乐于审阅。

合并扩展贡献

yo code 生成器可让您轻松打包 TextMate 主题、着色器和代码片段，并创建新的扩展。当运行生成器时，它会为每个选项创建一个完整的独立扩展包。然而，通常更方便的是有一个扩展程序来组合多个贡献。例如，如果您正在为新语言添加支持，您将希望为用户提供语言定义（包括着色）以及代码片段，甚至可能是调试支持。

要合并扩展贡献，请编辑现有的扩展清单 package.json 并添加新的贡献和相关文件。

下面的扩展清单包括一个 LaTex 语言定义（语言标识符和文件扩展名）、着色（grammars）和代码片段。

{
  "name": "language-latex",
  "description": "LaTex Language Support",
  "version": "0.0.1",
  "publisher": "someone",
  "engines": {
    "vscode": "0.10.x"
  },
  "categories": ["Programming Languages", "Snippets"],
  "contributes": {
    "languages": [
      {
        "id": "latex",
        "aliases": ["LaTeX", "latex"],
        "extensions": [".tex"]
      }
    ],
    "grammars": [
      {
        "language": "latex",
        "scopeName": "text.tex.latex",
        "path": "./syntaxes/latex.tmLanguage.json"
      }
    ],
    "snippets": [
      {
        "language": "latex",
        "path": "./snippets/snippets.json"
      }
    ]
  }
}

请注意，扩展清单的 categories 属性现在同时包含 Programming Languages 和 Snippets，以便在 Marketplace 上轻松发现和过滤。

提示：确保您合并的贡献使用相同的标识符。在上面的示例中，所有三个贡献都使用“latex”作为语言标识符。这让 VS Code 知道着色器（grammars）和代码片段是为 LaTeX 语言准备的，并且将在编辑 LaTeX 文件时激活。

扩展包

您可以将单独的扩展捆绑在扩展包中。扩展包是一组将一起安装的扩展。这使用户能够轻松共享您最喜欢的扩展，或为特定场景（如 PHP 开发）创建一组扩展，以帮助 PHP 开发人员快速开始使用 VS Code。

扩展包使用 package.json 文件中的 extensionPack 属性来捆绑其他扩展。

例如，这里有一个用于 PHP 的扩展包，其中包含一个调试器和一个语言服务

{
  "extensionPack": ["xdebug.php-debug", "zobo.php-intellisense"]
}

安装扩展包时，VS Code 现在还会安装其扩展依赖项。

扩展包应在 Extension Packs Marketplace 类别中进行分类。

{
  "categories": ["Extension Packs"]
}

要创建扩展包，您可以使用 yo code Yeoman 生成器并选择New Extension Pack 选项。有一个选项可以使用您当前在 VS Code 实例中安装的扩展集来填充包。通过这种方式，您可以轻松创建包含您最喜欢的扩展的扩展包，将其发布到 Marketplace，并与他人共享。

扩展包不应与其捆绑的扩展有任何功能性依赖关系，并且捆绑的扩展应独立于包进行管理。如果一个扩展依赖于另一个扩展，则应使用 extensionDependencies 属性声明该依赖关系。

扩展卸载钩子

如果您的扩展在从 VS Code 卸载时需要进行一些清理，您可以向扩展的 package.json 中 scripts 部分下的卸载钩子 vscode:uninstall 注册一个 node 脚本。

{
  "scripts": {
    "vscode:uninstall": "node ./out/src/lifecycle"
  }
}

当扩展在 VS Code 中被完全卸载后（即扩展卸载后重启 VS Code 时），将执行此脚本。

注意：仅支持 Node.js 脚本。

有用的 Node 模块

npmjs 上有几个 Node.js 模块可以帮助编写 VS Code 扩展。您可以将它们包含在扩展的 dependencies 部分。

• vscode-nls - 支持外部化和本地化。
• vscode-uri - VS Code 及其扩展使用的 URI 实现。
• jsonc-parser - 一个扫描器和容错解析器，用于处理带或不带注释的 JSON。
• request-light - 一个支持代理的轻量级 Node.js 请求库
• vscode-extension-telemetry - VS Code 扩展的一致遥测报告。
• vscode-languageclient - 轻松集成遵循 语言服务器协议 的语言服务器。

后续步骤

要了解有关 VS Code 可扩展性模型的更多信息，请尝试以下主题

• 贡献点 - VS Code 贡献点参考
• 激活事件 - VS Code 激活事件参考
• 扩展 Marketplace - 了解更多关于 VS Code 扩展 Marketplace 的信息