PathIntellisense 开源项目教程

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

PathIntellisense 是一个用于 Visual Studio Code 的插件，帮助开发者更方便地处理文件路径。项目的目录结构相对简单，主要包含以下几个部分：

PathIntellisense/
├── .github/
│   └── workflows/
│       └── ci.yml
├── images/
│   └── demo.gif
├── src/
│   ├── extension.ts
│   ├── pathCompletion.ts
│   └── test/
│       ├── extension.test.ts
│       └── pathCompletion.test.ts
├── .gitignore
├── .vscodeignore
├── CHANGELOG.md
├── package.json
├── README.md
└── tsconfig.json

• .github/workflows/: 包含 GitHub Actions 的工作流配置文件，用于持续集成和部署。
• images/: 存放项目相关的图片资源，如演示 GIF。
• src/: 项目的源代码目录，包含插件的主要逻辑和测试代码。
  • extension.ts: 插件的入口文件。
  • pathCompletion.ts: 路径补全的核心逻辑。
  • test/: 测试代码目录，包含插件的单元测试。
• .gitignore: 指定 Git 忽略的文件和目录。
• .vscodeignore: 指定 Visual Studio Code 忽略的文件和目录。
• CHANGELOG.md: 记录项目的变更日志。
• package.json: 项目的配置文件，包含依赖、脚本和插件信息。
• README.md: 项目的说明文档。
• tsconfig.json: TypeScript 的配置文件。

2. 项目的启动文件介绍

PathIntellisense 的启动文件是 src/extension.ts。这个文件是插件的入口点，负责注册和初始化插件的主要功能。以下是 extension.ts 的主要内容：

import * as vscode from 'vscode';
import { provideCompletionItems } from './pathCompletion';

export function activate(context: vscode.ExtensionContext) {
    const provider = vscode.languages.registerCompletionItemProvider(
        { scheme: 'file' },
        {
            provideCompletionItems
        },
        '\\', '/'
    );

    context.subscriptions.push(provider);
}

export function deactivate() {}

• activate: 插件激活时调用的函数，注册路径补全的提供者。
• deactivate: 插件停用时调用的函数，目前为空。

3. 项目的配置文件介绍

PathIntellisense 的主要配置文件是 package.json。这个文件包含了插件的元数据、依赖和脚本等信息。以下是 package.json 的部分关键内容：

{
  "name": "path-intellisense",
  "displayName": "Path Intellisense",
  "description": "Visual Studio Code plugin that autocompletes filenames",
  "version": "2.8.0",
  "publisher": "christian-kohler",
  "engines": {
    "vscode": "^1.52.0"
  },
  "categories": [
    "Other"
  ],
  "activationEvents": [
    "onLanguage:markdown",
    "onLanguage:plaintext",
    "onLanguage:yaml",
    "onLanguage:json",
    "onLanguage:javascript",
    "onLanguage:typescript",
    "onLanguage:javascriptreact",
    "onLanguage:typescriptreact",
    "onLanguage:html",
    "onLanguage:css",
    "onLanguage:scss",
    "onLanguage:less",
    "onLanguage:vue",
    "onLanguage:php",
    "onLanguage:python",
    "onLanguage:csharp",
    "onLanguage:go",
    "onLanguage:rust",
    "onLanguage:java",
    "onLanguage:ruby",
    "onLanguage:swift",
    "onLanguage:kotlin",
    "onLanguage:scala",
    "onLanguage:perl",
    "onLanguage:haskell",
    "onLanguage:lua",
    "onLanguage:r",
    "onLanguage:dart",
    "onLanguage:clojure",