扩展清单文件 - package.json

每个VS Code扩展需要一个清单文件package.json，该文件位于扩展的根目录中。

字段

也可以查看npm's package.json参考文档.

范例

这里有一个完整的package.json：

{
	"name": "Spell",
	"displayName": "Spelling and Grammar Checker",
	"description": "Detect mistakes as you type and suggest fixes - great for Markdown.",
	"icon": "images/spellIcon.svg",
	"version": "0.0.19",
	"publisher": "seanmcbreen",
	"galleryBanner": {
		"color": "#0000FF",
		"theme": "dark"
	},
	"license": "SEE LICENSE IN LICENSE.md",
	"bugs": {
		"url": "https://github.com/Microsoft/vscode-spell-check/issues",
		"email": "smcbreen@microsoft.com"
	},
	"homepage": "https://github.com/Microsoft/vscode-spell-check/blob/master/README.md",
	"repository": {
		"type": "git",
		"url": "https://github.com/Microsoft/vscode-spell-check.git"
	},
	"categories": [
		"Linters", "Languages", "Other"
	],
	"engines": {
		"vscode": "0.10.x"
	},
	"main": "./out/extension",
	"activationEvents": [
		"onLanguage:markdown"
	],
	"contributes": {
		"commands": [
			{
				"command": "Spell.suggestFix",
				"title": "Spell Checker Suggestions"
			}
		],
		"keybindings": [
			{
				"command": "Spell.suggestFix",
				"key": "Alt+."
			}
		]
	},
	"scripts": {
		"vscode:prepublish": "node ./node_modules/vscode/bin/compile",
		"compile": "node ./node_modules/vscode/bin/compile -watch -p ./"
	},
	"dependencies": {
		"teacher": "^0.0.1"
	},
	"devDependencies": {
		"vscode": "^0.11.x"
	}
}

市场呈现要点

为了让你自己的扩展在[VS Code市场]中看起来更好，这里有几个要点和建议。

始终使用最新的vsce，即用npm install -g vsce可保证最新。

在你的扩展根目录中编写一个README.md的MAERKDOWN文档，这样我们会在市场中的扩展信息中显示其中的内容。你可以在README.md中提供图片的相对路径链接。

这里有几个例子做说明：

1. Spell-Checker
2. MD Tools

请提供一个良好的显示名称和描述。这对于市场和产品显示都非常重要。在VS Code中这些字符串能用于文本搜索，并且有相关关键字将有很大帮助。

	"displayName": "Spelling and Grammar Checker",
	"description": "Detect mistakes as you type and suggest fixes - great for Markdown.",

在市场页面头中，有一个图标以及对比色横幅也会让扩展看起来非常棒，theme属性指的是在横幅中使用的字体：dark或者是light。

	"icon": "images/spellIcon.svg",
	"galleryBanner": {
		"color": "#5c2d91",
		"theme": "dark"
	},

你也可以设置一些其他的链接(错误、主页、代码库)，他们会在市场中资源一栏所呈现出来。

	"license": "SEE LICENSE IN LICENSE.md",
	"bugs": {
		"url": "https://github.com/Microsoft/vscode-spell-check/issues"
	},
	"homepage": "https://github.com/Microsoft/vscode-spell-check/blob/master/README.md",
	"repository": {
		"type": "git",
		"url": "https://github.com/Microsoft/vscode-spell-check.git"
	}

为你的扩展设置category。在市场中，同一个category将会放在一起，这样就方便过滤和查找。

注意 为你的扩展使用正确的值，只能使用这些值[Languages, Snippets, Linters, Themes, Debuggers, Other]

	"categories": [
		"Linters", "Languages", "Other"
	],

结合扩展贡献

yo code生成器能让你轻松打包文本主题、颜色设置和代码片段并创建新的扩展。当生成器运行时，它为每个选项创建一个完整的独立扩展包。然而很多时候我们更倾向于创建一个包含多个贡献点的扩展。比如说，如果你希望为一门新语言添加支持，则希望为用户提供带有代码着色的语言定义和代码段功能，甚至可以提供调试支持。

要使能够结合扩展贡献，仅仅只需要编辑已经存在的清单文件package.json并添加新的贡献点和关联文件即可。

以下是一个扩展的清单文件，它包含了Latex语言定义(语言标识符和文件扩展名)、着色器（grammar)和代码段。

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

注意，扩展的清单文件中categories属性现在可以同时包含Languages和Snippets，这样方便在市场中查找和过滤。

要点 确保你的多个贡献点使用的是相同的标识符。在上例中，三个贡献点都是使用“latex”作为语言标识符。这让VS Code知道语法着色器和代码段是用于LaTeX语言并当编辑LaTex文件时激活它。

下一步

要想了解更多关于VS Code可扩展性模型， 可以查看这些主题：

• 贡献点 - VS Code 贡献点参考文档
• 激活事件 - VS Code 激活事件文档
• 扩展市场 - 了解更多的VS Code扩展市场

常见问题

暂无