Agda-Mode-VSCode 项目教程

Agda-Mode-VSCode 项目教程

agda-mode-vscodeagda-mode on VS Code项目地址:https://gitcode.com/gh_mirrors/ag/agda-mode-vscode

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

agda-mode-vscode/
├── .github/
│   └── workflows/
├── assets/
├── src/
│   ├── client/
│   ├── server/
│   └── util/
├── .gitignore
├── LICENSE
├── package.json
├── README.md
└── tsconfig.json

• .github/workflows: 包含GitHub Actions的工作流配置文件。
• assets: 存放项目相关的静态资源文件。
• src: 项目的源代码目录。
  • client: VSCode插件客户端代码。
  • server: 语言服务器代码。
  • util: 工具函数和辅助代码。
• .gitignore: Git忽略文件配置。
• LICENSE: 项目许可证文件。
• package.json: 项目依赖和脚本配置。
• README.md: 项目说明文档。
• tsconfig.json: TypeScript配置文件。

2. 项目的启动文件介绍

项目的启动文件主要位于src/client目录下，其中extension.ts是VSCode插件的入口文件。该文件负责初始化插件并注册各种命令和功能。

// src/client/extension.ts
import * as vscode from 'vscode';
import { AgdaModeClient } from './AgdaModeClient';

export function activate(context: vscode.ExtensionContext) {
    const client = new AgdaModeClient(context);
    client.start();
}

export function deactivate() {
    // 插件停用时的清理工作
}

3. 项目的配置文件介绍

• package.json: 该文件包含了项目的依赖、脚本命令、插件配置等信息。

{
  "name": "agda-mode",
  "displayName": "agda-mode",
  "version": "0.3.9",
  "publisher": "banacorn",
  "description": "Agda mode on VSCode",
  "engines": {
    "vscode": "^1.50.0"
  },
  "categories": [
    "Programming Languages"
  ],
  "activationEvents": [
    "onLanguage:agda"
  ],
  "main": "./out/client/extension",
  "contributes": {
    "languages": [{
      "id": "agda",
      "aliases": ["Agda", "agda"],
      "extensions": [".agda"]
    }],
    "configuration": {
      "type": "object",
      "title": "Agda Mode Configuration",
      "properties": {
        "agdaMode.enableLanguageServer": {
          "type": "boolean",
          "default": true,
          "description": "Enable Agda Language Server"
        }
      }
    }
  },
  "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"
  },
  "dependencies": {
    "vscode-languageclient": "^6.1.3"
  },
  "devDependencies": {
    "@types/node": "^12.12.0",
    "@types/vscode": "^1.50.0",
    "typescript": "^4.0.5",
    "vscode": "^1.1.37"
  }
}

• tsconfig.json: TypeScript编译配置文件，定义了编译选项和编译目标。

{
  "compilerOptions": {
    "module": "commonjs",
    "target": "es6",
    "outDir": "out",
    "rootDir": "src",
    "sourceMap": true,
    "strict": true,
    "esModuleInterop": true
  },
  "include": [
    "src"
  ]
}

以上是Agda-Mode-VSCode项目的基本教程，涵盖了项目的目录结构、启动文件

agda-mode-vscodeagda-mode on VS Code项目地址:https://gitcode.com/gh_mirrors/ag/agda-mode-vscode