扩展清单

每个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"
}

市场展示技巧

这里有一些提示和建议，使您的扩展在 VS Code 市场上展示得更加美观。

始终使用最新版本vsce所以npm install -g @vscode/vsce确保你拥有它。

请将以下网页文本翻译成中文，只输出翻译结果，不输出任何其他解释，若文本已经是中文了，则直接用中文复述一遍。翻译结果保持格式不变。输入：Have a自述文件.md在您的扩展根文件夹中创建一个Markdown文件，我们将在扩展详情的主体中包含其内容（在市场中）。您可以在其中提供相对路径图像链接。自述文件.md输入：.

以下是一些示例：

1. 字数统计
2. MD 工具

提供一个良好的显示名称和描述。这对于市场和产品展示都很重要。这些字符串还用于 VS Code 中的文本搜索，拥有相关的关键词会很有帮助。

    "displayName": "字数统计",
    "description": "Markdown字数统计示例 - 报告Markdown文件中的字数。",

图标和对比鲜明的横幅颜色在市场页面标题上看起来很棒。主题属性是指横幅中使用的字体 -暗或光输入：.

{
  "图标": "images/icon.png",
  "画廊横幅": {
    "颜色": "#C80000",
    "主题": "暗色"
  }
}

有多个可选链接 (虫子，主页，仓库) 您可以设置并这些将在资源部分的市场中显示。

{
  "许可": "请参阅LICENSE.txt中的许可",
  "主页": "https://github.com/microsoft/vscode-wordcount/blob/main/README.md",
  "错误": {
    "网址": "https://github.com/microsoft/vscode-wordcount/issues",
    "电子邮件": "sean@contoso.com"
  },
  "仓库": {
    "类型": "git",
    "网址": "https://github.com/microsoft/vscode-wordcount.git"
  }
}

设置一个类别为您的扩展。相同的扩展类别在市场中将它们分组在一起，可以改进过滤和发现。

注意： 只能使用对您的扩展有意义的值。允许的值是 [编程语言, 代码片段, 代码检查工具, 主题, 调试器, 格式化工具, 键盘映射, 版本控制系统提供者, 其他, 扩展包, 语言包, 数据科学, 机器学习, 可视化, 笔记本, 教育, 测试]. 使用编程语言用于诸如语法高亮和代码补全等通用语言功能。类别语言包保留用于显示语言扩展（例如，本地化的保加利亚语）。

{
  "分类": ["代码检查工具", "编程语言", "其他"]
}

已批准徽章

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

我们允许以下 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
• codeco.io
• coveralls.io
• david-dm.org
• deepscan.io
• dev.azure.com
• docs.rs
• flat.badgen.net
• 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
• visualstudio.com
• vsmarketplacebadges.dev

注意：将 vsmarketplacebadge.apphb.com 标牌替换为 vsmarketplacebadges.dev 标牌。

如果您有其他徽章希望使用，请在GitHub上提交问题，我们会很乐意查看。

合并扩展贡献

该你的代码生成器可以轻松地将 TextMate 主题、颜色化和片段打包并创建新的扩展。当运行生成器时，它会为每个选项创建一个完整的独立扩展包。然而，通常将多个贡献合并到一个扩展中会更方便。例如，如果您正在添加对新语言的支持，您希望向用户提供语言定义、颜色化以及片段，甚至调试支持。

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

以下是扩展配置文件，包括LaTex语言定义（语言标识符和文件扩展名）、颜色化语法), 和片段。

{
  "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"
      }
    ]
  }
}

注意扩展清单类别属性现在包括两者编程语言和片段以便在市场中轻松发现和筛选。

提示： 确保您的合并贡献使用相同的标识符。在上面的示例中，所有三个贡献都使用"latex"作为语言标识符。这告诉 VS Code 颜色化工具 (语法) 和片段是用于 LaTeX 语言，并且在编辑 LaTeX 文件时将生效。

扩展包

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

扩展包使用 扩展包属性在package.json文件。

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

{
  "extensionPack": ["xdebug.php调试", "zobo.php智能感知"]
}

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

扩展包应归类于扩展包市场类别：

{
  "分类": ["扩展包"]
}

要创建一个扩展包，您可以使用你的代码 Yeoman 生成器并选择 新的扩展包 选项。有一个选项可以将你当前在 VS Code 实例中安装的扩展集初始化到扩展包中。通过这种方式，你可以轻松创建一个包含你最喜欢的扩展的扩展包，发布到市场，并与他人分享。

扩展包与其捆绑的扩展之间不应有任何功能依赖，捆绑的扩展应能够独立于扩展包进行管理。如果一个扩展依赖于另一个扩展，该依赖应使用扩展依赖属性。

扩展卸载挂钩

如果您的扩展在从 VS Code 卸载时需要进行一些清理工作，您可以注册一个节点脚本到卸载挂钩vscode:卸载在脚本在扩展的 package.json 中的 section。

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

此脚本在 VS Code 重启（关闭并启动）后，扩展被卸载时执行，即 VS Code 重新启动时，扩展被完全卸载时。

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

有用的 Node 模块

有多个Node.js模块可以在npmjs上找到，以帮助编写VS Code扩展。您可以在扩展中包含这些模块。依赖关系部分。

• 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 激活事件参考
• 扩展市场 - 了解更多关于 VS Code 扩展市场的信息