VSCode Partial Diff 插件使用教程

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

vscode-partial-diff/
├── .vscode/
│   ├── extensions.json
│   └── settings.json
├── src/
│   ├── commands/
│   │   ├── compareTextWithPreviousSelection.ts
│   │   ├── markSection1.ts
│   │   └── markSection2.ts
│   ├── extension.ts
│   ├── package.json
│   └── README.md
├── .gitignore
├── LICENSE
└── package.json

目录结构介绍

• .vscode/: 包含 VSCode 的配置文件，如 extensions.json 和 settings.json。
• src/: 项目的源代码目录，包含插件的主要功能实现。
  • commands/: 包含插件的命令实现，如 compareTextWithPreviousSelection.ts 和 markSection1.ts。
  • extension.ts: 插件的入口文件，负责注册命令和初始化插件。
  • package.json: 项目的元数据文件，包含插件的依赖、脚本和配置信息。
  • README.md: 项目的说明文档。
• .gitignore: Git 忽略文件列表。
• LICENSE: 项目的开源许可证。
• package.json: 项目的元数据文件，包含插件的依赖、脚本和配置信息。

2. 项目的启动文件介绍

extension.ts

extension.ts 是 VSCode Partial Diff 插件的入口文件，负责注册插件的命令和初始化插件。以下是文件的主要内容：

import * as vscode from 'vscode';
import { registerCommands } from './commands';

export function activate(context: vscode.ExtensionContext) {
    registerCommands(context);
}

export function deactivate() {}

功能介绍

• activate: 插件激活时调用的函数，负责注册插件的命令。
• deactivate: 插件停用时调用的函数，目前为空。

3. 项目的配置文件介绍

package.json

package.json 是项目的元数据文件，包含插件的依赖、脚本和配置信息。以下是文件的主要内容：

{
  "name": "vscode-partial-diff",
  "displayName": "Partial Diff",
  "description": "Compare (diff) text selections within a file, across different files, or to the clipboard.",
  "version": "1.0.0",
  "publisher": "ryu1kn",
  "engines": {
    "vscode": "^1.50.0"
  },
  "categories": [
    "Other"
  ],
  "activationEvents": [
    "onCommand:extension.partialDiff.markSection1",
    "onCommand:extension.partialDiff.markSection2",
    "onCommand:extension.partialDiff.compareTextWithPreviousSelection"
  ],
  "main": "./src/extension.ts",
  "contributes": {
    "commands": [
      {
        "command": "extension.partialDiff.markSection1",
        "title": "Partial Diff: Mark Section 1"
      },
      {
        "command": "extension.partialDiff.markSection2",
        "title": "Partial Diff: Mark Section 2"
      },
      {
        "command": "extension.partialDiff.compareTextWithPreviousSelection",
        "title": "Partial Diff: Compare Text with Previous Selection"
      }
    ]
  },
  "scripts": {
    "vscode:prepublish": "npm run compile",
    "compile": "tsc -p ./",
    "watch": "tsc -watch -p ./",
    "postinstall": "node ./node_modules/vscode/bin/install",
    "test": "npm run compile && node ./node_modules/vscode/bin/test"
  },
  "devDependencies": {
    "typescript": "^4.0.2",
    "vscode": "^1.1.37",
    "tslint": "^6.1.3",
    "@types/node": "^14.0.27",
    "@types/mocha": "^8.0.3"
  }
}

配置文件介绍

• name: 插件的名称。
• displayName: 插件的显示名称。
• description: 插件的描述。
• version: 插件的版本号。
• publisher: 插件的发布者。
• engines: 插件支持的 VSCode 版本。
• categories: 插件的分类。
• activationEvents: 插件的激活事件。
• main: 插件的入口文件。
• contributes: 插件的贡献点，如命令。
• scripts: 项目的脚本，如编译和测试。
• devDependencies: 开发依赖。

通过以上介绍，您可以更好地理解和使用 VSCode Partial Diff 插件。