扩展清单

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

字段

另请查看 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": "[email protected]"
  },
  "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. 字数统计
2. MD 工具

提供良好的显示名称和描述。 这对于 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": "[email protected]"
  },
  "repository": {
    "type": "git",
    "url": "https://github.com/microsoft/vscode-wordcount.git"
  }
}

为你的扩展设置 category。 同一 category 中的扩展在 Marketplace 上分组在一起，从而改进了筛选和发现。

注意： 仅使用对你的扩展有意义的值。 允许的值为 [编程语言, 代码片段, 代码检查器, 主题, 调试器, 格式化程序, 键盘映射, SCM 提供程序, 其他, 扩展包, 语言包, 数据科学, 机器学习, 可视化, 笔记本, 教育, 测试]。 将 编程语言 用于通用语言功能，如语法突出显示和代码完成。 类别 语言包 保留用于显示语言扩展（例如，本地化的保加利亚语）。

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

已批准的徽章

由于安全问题，我们仅允许来自受信任服务的徽章。

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

• api.bintray.com
• api.travis-ci.com
• api.travis-ci.org
• app.fossa.io
• badge.buildkite.com
• badge.fury.io
• badge.waffle.io
• badgen.net
• badges.frapsoft.com
• badges.gitter.im
• badges.greenkeeper.io
• cdn.travis-ci.com
• cdn.travis-ci.org
• 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
• gemnasium.com
• github.com（仅限工作流）
• gitlab.com
• godoc.org
• goreportcard.com
• img.shields.io
• isitmaintained.com
• marketplace.visualstudio.com
• nodesecurity.io
• opencollective.com
• snyk.io
• travis-ci.com
• travis-ci.org
• visualstudio.com
• vsmarketplacebadges.dev
• www.versioneye.com

注意：将 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 属性现在同时包含 编程语言 和 代码片段，以便在 Marketplace 上轻松发现和筛选。

提示： 确保你合并的贡献使用相同的标识符。 在上面的示例中，所有三个贡献都使用“latex”作为语言标识符。 这使 VS Code 知道着色器 (grammars) 和代码片段用于 LaTeX 语言，并且在编辑 LaTeX 文件时将处于活动状态。

扩展包

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

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

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

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

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

扩展包应在 扩展包 Marketplace 类别中分类

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

要创建扩展包，你可以使用 yo code Yeoman 生成器并选择新建扩展包选项。 有一个选项可以使用你当前在 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 的更多信息