VSCode Lua 插件项目教程

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

目录结构

vscode-lua/
├── client/
│   ├── src/
│   │   ├── extension.ts
│   │   └── ...
│   └── package.json
├── server/
│   ├── bin/
│   │   ├── Windows/
│   │   ├── macOS/
│   │   └── Linux/
│   ├── script/
│   ├── src/
│   │   ├── main.lua
│   │   └── ...
│   └── package.json
├── .gitignore
├── README.md
└── package.json

目录介绍

• client/: 包含VSCode插件客户端的源代码和配置文件。

  • src/: 客户端的主要源代码文件，包括extension.ts等。
  • package.json: 客户端的配置文件，定义了插件的依赖和启动方式。

• server/: 包含Lua语言服务器的源代码和配置文件。

  • bin/: 包含不同操作系统下的可执行文件。
  • script/: 包含一些脚本文件，用于构建和部署。
  • src/: 服务器的主要源代码文件，包括main.lua等。
  • package.json: 服务器的配置文件，定义了依赖和启动方式。

• .gitignore: Git忽略文件，定义了哪些文件和目录不需要被版本控制。

• README.md: 项目的说明文档，介绍了项目的基本信息和使用方法。

• package.json: 项目的根配置文件，定义了整个项目的依赖和脚本。

2. 项目的启动文件介绍

客户端启动文件

• client/src/extension.ts: 这是VSCode插件的入口文件，负责初始化插件和注册各种命令和功能。

服务器启动文件

• server/src/main.lua: 这是Lua语言服务器的入口文件，负责启动服务器并处理各种语言服务请求。

3. 项目的配置文件介绍

客户端配置文件

• client/package.json: 这个文件定义了客户端插件的元数据、依赖项、命令和激活事件。例如：

{
  "name": "vscode-lua",
  "displayName": "Lua",
  "version": "1.0.0",
  "publisher": "sumneko",
  "engines": {
    "vscode": "^1.50.0"
  },
  "activationEvents": [
    "onLanguage:lua"
  ],
  "main": "./out/extension.js",
  "contributes": {
    "languages": [{
      "id": "lua",
      "aliases": ["Lua", "lua"],
      "extensions": [".lua"]
    }],
    "configuration": {
      "type": "object",
      "title": "Lua Configuration",
      "properties": {
        "lua.lint": {
          "type": "boolean",
          "default": true,
          "description": "Enable linting for Lua files."
        }
      }
    }
  }
}

服务器配置文件

• server/package.json: 这个文件定义了服务器的基本信息和依赖项。例如：

{
  "name": "lua-language-server",
  "version": "1.0.0",
  "description": "Lua Language Server",
  "main": "bin/Windows/lua-language-server.exe",
  "scripts": {
    "compile": "tsc -p ./",
    "watch": "tsc -watch -p ./"
  },
  "dependencies": {
    "typescript": "^4.0.0"
  }
}

通过以上配置文件，可以了解项目的依赖关系、启动方式和功能配置。