VSCode Python 扩展项目教程

VSCode Python 扩展项目教程

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

vscode-python
├── config
├── devcontainer
├── github
├── vscode
├── build
├── images
├── languages
├── pythonExtensionApi
├── python_files
├── resources
├── schemas
├── scripts
├── src
├── syntaxes
├── types
├── typings
├── editorconfig
├── eslintignore
├── eslintrc
├── git-blame-ignore-revs
├── gitattributes
├── gitignore
├── npmrc
├── nvmrc
├── prettierrc.js

目录结构介绍

• config: 包含项目的配置文件。
• devcontainer: 用于开发容器的配置文件。
• github: 与GitHub相关的配置和脚本。
• vscode: Visual Studio Code的扩展配置。
• build: 构建相关的文件和脚本。
• images: 项目中使用的图像资源。
• languages: 语言相关的配置和资源。
• pythonExtensionApi: Python扩展的API相关文件。
• python_files: Python文件的模板和示例。
• resources: 项目资源文件。
• schemas: JSON Schema文件。
• scripts: 项目脚本文件。
• src: 项目的源代码。
• syntaxes: 语法定义文件。
• types: TypeScript类型定义文件。
• typings: TypeScript类型声明文件。
• editorconfig: 编辑器配置文件。
• eslintignore: ESLint忽略文件。
• eslintrc: ESLint配置文件。
• git-blame-ignore-revs: Git忽略的修订版本。
• gitattributes: Git属性配置文件。
• gitignore: Git忽略文件。
• npmrc: npm配置文件。
• nvmrc: Node版本管理配置文件。
• prettierrc.js: Prettier代码格式化配置文件。

2. 项目的启动文件介绍

项目的启动文件通常位于src目录下，具体文件名可能因项目结构而异。启动文件负责初始化扩展并注册各种功能。

示例启动文件

// src/extension.ts

import * as vscode from 'vscode';

export function activate(context: vscode.ExtensionContext) {
    console.log('Python extension is now active!');

    // 注册命令
    let disposable = vscode.commands.registerCommand('python.helloWorld', () => {
        vscode.window.showInformationMessage('Hello World from Python!');
    });

    context.subscriptions.push(disposable);
}

export function deactivate() {}

启动文件功能

• activate: 当扩展被激活时调用，通常用于注册命令和初始化功能。
• deactivate: 当扩展被停用时调用，用于清理资源。

3. 项目的配置文件介绍

package.json

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

{
  "name": "vscode-python",
  "displayName": "Python",
  "description": "Python extension for Visual Studio Code",
  "version": "1.0.0",
  "publisher": "Microsoft",
  "engines": {
    "vscode": "^1.50.0"
  },
  "categories": [
    "Programming Languages"
  ],
  "activationEvents": [
    "onLanguage:python"
  ],
  "main": "./out/src/extension",
  "contributes": {
    "commands": [
      {
        "command": "python.helloWorld",
        "title": "Hello World"
      }
    ]
  },
  "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"
  }
}

配置文件功能

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

通过以上内容，您可以了解VSCode Python扩展项目的基本结构、启动文件和配置文件。