VSCode Sort JSON 项目教程

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

VSCode Sort JSON 项目的目录结构相对简单，主要包含以下几个部分：

vscode-sort-json/
├── .github/
│   └── workflows/
│       └── main.yml
├── images/
│   └── demo.gif
├── src/
│   ├── extension.ts
│   ├── test/
│   │   └── extension.test.ts
│   └── package.json
├── .gitignore
├── .vscodeignore
├── CHANGELOG.md
├── LICENSE
├── README.md
├── package.json
└── tsconfig.json

• .github/workflows/main.yml: GitHub Actions 的工作流配置文件，用于自动化构建和测试。
• images/demo.gif: 项目演示的 GIF 图片。
• src/: 源代码目录，包含扩展的主要逻辑和测试代码。
  • extension.ts: 扩展的主文件，包含激活和停用扩展的逻辑。
  • test/extension.test.ts: 扩展的测试文件。
• .gitignore: Git 忽略文件配置。
• .vscodeignore: VSCode 忽略文件配置。
• CHANGELOG.md: 项目更新日志。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• package.json: 项目的 npm 配置文件，包含依赖、脚本和扩展信息。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

项目的启动文件是 src/extension.ts，它包含了扩展的激活和停用逻辑。以下是该文件的主要内容：

import * as vscode from 'vscode';
import { sortJSON } from './sortJSON';

export function activate(context: vscode.ExtensionContext) {
    let disposable = vscode.commands.registerCommand('extension.sortJSON', () => {
        sortJSON();
    });

    context.subscriptions.push(disposable);
}

export function deactivate() {}

• activate: 当扩展被激活时调用的函数，注册了一个命令 extension.sortJSON，该命令会调用 sortJSON 函数进行 JSON 排序。
• deactivate: 当扩展被停用时调用的函数，目前没有具体逻辑。

3. 项目的配置文件介绍

项目的配置文件主要是 package.json，它包含了扩展的所有配置信息。以下是该文件的部分内容：

{
  "name": "sort-json",
  "displayName": "Sort JSON",
  "description": "Sorts the keys within JSON objects",
  "version": "1.20.0",
  "publisher": "richie5um2",
  "engines": {
    "vscode": "^1.30.0"
  },
  "categories": [
    "Other"
  ],
  "activationEvents": [
    "onCommand:extension.sortJSON"
  ],
  "main": "./out/extension.js",
  "contributes": {
    "commands": [
      {
        "command": "extension.sortJSON",
        "title": "Sort JSON"
      }
    ]
  },
  "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": "^3.3.1",
    "vscode": "^1.1.28",
    "tslint": "^5.12.1",
    "@types/node": "^10.12.21",
    "@types/mocha": "^2.2.42"
  }
}

• name: 扩展的名称。
• displayName: 扩展的显示名称。
• description: 扩展的描述。
• version: 扩展的版本号。
• publisher: 扩展的发布者。
• engines: 扩展支持的 VSCode 版本。