VSCode XML 插件使用教程

VSCode XML 插件使用教程

vscode-xmlXML Tools for Visual Studio Code项目地址:https://gitcode.com/gh_mirrors/vs/vscode-xml

1. 项目的目录结构及介绍

vscode-xml/
├── assets/
│   └── logo.png
├── src/
│   ├── commands/
│   ├── languages/
│   ├── services/
│   ├── test/
│   └── extension.ts
├── .gitignore
├── package.json
├── README.md
└── tsconfig.json

• assets/: 存放项目相关的静态资源，如logo图片。
• src/: 项目的源代码目录，包含命令、语言服务、服务和测试等模块。
  • commands/: 存放命令相关的代码。
  • languages/: 存放语言服务相关的代码。
  • services/: 存放服务相关的代码。
  • test/: 存放测试相关的代码。
  • extension.ts: 插件的主入口文件。
• .gitignore: Git忽略文件配置。
• package.json: 项目的依赖和配置文件。
• README.md: 项目的说明文档。
• tsconfig.json: TypeScript配置文件。

2. 项目的启动文件介绍

项目的启动文件是 src/extension.ts。这个文件是插件的入口点，负责初始化插件并注册各种命令和服务。

import * as vscode from 'vscode';
import { activateCommands } from './commands';
import { activateLanguages } from './languages';
import { activateServices } from './services';

export function activate(context: vscode.ExtensionContext) {
    activateCommands(context);
    activateLanguages(context);
    activateServices(context);
}

export function deactivate() {}

• activate: 插件激活时调用的函数，初始化并注册命令、语言和服务。
• deactivate: 插件停用时调用的函数。

3. 项目的配置文件介绍

package.json

package.json 是Node.js项目的核心配置文件，包含了项目的元数据、依赖和脚本等信息。

{
  "name": "vscode-xml",
  "displayName": "XML Tools",
  "version": "2.5.1",
  "description": "XML Tools for Visual Studio Code",
  "publisher": "DotJoshJohnson",
  "engines": {
    "vscode": "^1.30.0"
  },
  "categories": [
    "Programming Languages",
    "Snippets",
    "Other"
  ],
  "activationEvents": [
    "onLanguage:xml"
  ],
  "main": "./src/extension",
  "contributes": {
    "commands": [
      {
        "command": "xmlTools.prettyPrint",
        "title": "XML Tools: Pretty-Print XML"
      }
    ],
    "configuration": {
      "type": "object",
      "title": "XML Tools Configuration",
      "properties": {
        "xmlTools.prettyPrintFileEnding": {
          "type": "string",
          "default": "pretty.xml",
          "description": "The file ending to use for pretty-printed XML files."
        }
      }
    }
  },
  "scripts": {
    "vscode:prepublish": "tsc -p ./",
    "compile": "tsc -watch -p ./",
    "postinstall": "node ./node_modules/vscode/bin/install"
  },
  "dependencies": {
    "vscode": "^1.1.28"
  }
}

• name: 插件的名称。
• displayName: 插件的显示名称。
• version: 插件的版本号。
• description: 插件的描述。
• publisher: 插件的发布者。
• engines: 插件支持的VSCode版本。
• categories: 插件的分类。
• activationEvents: 插件的激活事件。
• main: 插件的主入口文件路径。
• contributes: 插件的贡献点，包括命令和配置。
• scripts: 项目的脚本命令。
• dependencies: 项目的依赖包。

tsconfig.json

tsconfig.json 是TypeScript项目的配置文件，定义了TypeScript编译器的选项。

{
  "compilerOptions": {
    "module": "commonjs",
    "target": "es6",
    "outDir": "out",
    "rootDir": "src",
    "sourceMap": true
  },
  "include": [
    "src"
  ]
}

• compilerOptions: 编译器选项。
  • module: 模块系统。
  • target: 编译目标。
  • outDir: 输出目录。
  • rootDir: 源代码目录。
  • sourceMap: 是否生成source map文件。
• include: 包含的文件或目录。

vscode-xmlXML Tools for Visual Studio Code项目地址:https://gitcode.com/gh_mirrors/vs/vscode-xml