VSCode Simple Readme 项目教程

VSCode Simple Readme 项目教程

vscode-simple-readme📝 Readme Generator for Visual Studio Code ❤️项目地址:https://gitcode.com/gh_mirrors/vs/vscode-simple-readme

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

vscode-simple-readme/
├── .vscode/
│   ├── extensions.json
│   └── settings.json
├── assets/
│   └── logo.png
├── src/
│   ├── commands/
│   │   └── generateReadme.ts
│   ├── templates/
│   │   ├── en.md
│   │   └── pt-BR.md
│   ├── extension.ts
│   └── test/
│       └── extension.test.ts
├── .gitignore
├── package.json
├── README.md
└── tsconfig.json

• .vscode/: 包含VSCode的配置文件，如扩展推荐和设置。
• assets/: 存放项目的静态资源，如logo图片。
• src/: 项目的源代码目录。
  • commands/: 包含命令处理文件。
  • templates/: 包含README模板文件，支持英文和葡萄牙语。
  • extension.ts: 扩展的主入口文件。
  • test/: 包含测试文件。
• .gitignore: Git忽略文件配置。
• package.json: 项目的npm配置文件，包含项目依赖和脚本。
• README.md: 项目的说明文档。
• tsconfig.json: TypeScript配置文件。

2. 项目的启动文件介绍

项目的启动文件是 src/extension.ts。这个文件是VSCode扩展的入口点，负责注册命令和初始化扩展。

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

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

export function deactivate() {}

• activate: 当扩展被激活时调用，注册生成README的命令。
• deactivate: 当扩展被停用时调用。

3. 项目的配置文件介绍

项目的配置文件主要是 package.json 和 .vscode/settings.json。

package.json

{
  "name": "vscode-simple-readme",
  "displayName": "Simple Readme",
  "version": "1.0.0",
  "description": "Generate readme fastly and simply with Simple Readme",
  "publisher": "maurodesouza",
  "engines": {
    "vscode": "^1.50.0"
  },
  "categories": [
    "Other"
  ],
  "activationEvents": [
    "onCommand:extension.generateReadme"
  ],
  "main": "./src/extension.ts",
  "contributes": {
    "commands": [
      {
        "command": "extension.generateReadme",
        "title": "Generate Readme"
      }
    ]
  },
  "scripts": {
    "vscode:prepublish": "npm run compile",
    "compile": "tsc -p ./",
    "watch": "tsc -watch -p ./",
    "pretest": "npm run compile && npm run lint",
    "lint": "eslint src --ext ts",
    "test": "node ./out/test/runTest.js"
  },
  "devDependencies": {
    "@types/vscode": "^1.50.0",
    "@types/glob": "^7.1.3",
    "@types/mocha": "^8.0.4",
    "@types/node": "^12.11.7",
    "eslint": "^7.10.0",
    "glob": "^7.1.6",
    "mocha": "^8.1.3",
    "typescript": "^4.0.3",
    "vscode-test": "^1.4.0"
  }
}

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

vscode-simple-readme📝 Readme Generator for Visual Studio Code ❤️项目地址:https://gitcode.com/gh_mirrors/vs/vscode-simple-readme