VSCode Python 扩展项目教程

最新推荐文章于 2024-09-13 21:53:13 发布

杭云瑗Ward

最新推荐文章于 2024-09-13 21:53:13 发布

阅读量246

点赞数 5

本文链接：https://blog.csdn.net/gitblog_00495/article/details/142164932

版权

VSCode Python 扩展项目教程

vscode.py Create VSCode Extensions with python 项目地址: https://gitcode.com/gh_mirrors/vs/vscode.py

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"
  }
}