Tower LSP Boilerplate 项目教程

姬鸿桢

于 2024-08-23 08:24:53 发布

阅读量314

点赞数 3

本文链接：https://blog.csdn.net/gitblog_00136/article/details/141447926

版权

Tower LSP Boilerplate 项目教程

tower-lsp-boilerplate项目地址:https://gitcode.com/gh_mirrors/to/tower-lsp-boilerplate

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

tower-lsp-boilerplate/
├── .github/
│   └── workflows/
│       └── main.yml
├── src/
│   ├── client/
│   │   ├── main.ts
│   │   └── ...
│   ├── server/
│   │   ├── main.ts
│   │   └── ...
│   └── shared/
│       └── ...
├── .gitignore
├── package.json
├── tsconfig.json
└── README.md

目录结构介绍

.github/workflows/main.yml: GitHub Actions 的工作流配置文件，用于自动化构建和部署。
src/client/: 客户端代码目录，包含客户端的主要逻辑。
src/server/: 服务器端代码目录，包含服务器的主要逻辑。
src/shared/: 共享代码目录，包含客户端和服务器共享的代码。
.gitignore: Git 忽略文件，指定哪些文件和目录不需要被 Git 追踪。
package.json: 项目的依赖和脚本配置文件。
tsconfig.json: TypeScript 配置文件，用于配置 TypeScript 编译选项。
README.md: 项目说明文档，包含项目的介绍、安装和使用说明。

2. 项目的启动文件介绍

客户端启动文件

src/client/main.ts

import { startClient } from './client';

startClient();

服务器端启动文件

src/server/main.ts

import { startServer } from './server';

startServer();

启动文件介绍

src/client/main.ts: 客户端的入口文件，负责启动客户端逻辑。
src/server/main.ts: 服务器端的入口文件，负责启动服务器逻辑。

3. 项目的配置文件介绍

package.json

{
  "name": "tower-lsp-boilerplate",
  "version": "1.0.0",
  "description": "A boilerplate for Tower LSP",
  "main": "src/server/main.ts",
  "scripts": {
    "start": "ts-node src/server/main.ts",
    "build": "tsc",
    "test": "jest"
  },
  "dependencies": {
    "typescript": "^4.0.0",
    "ts-node": "^10.0.0",
    "tower-lsp": "^1.0.0"
  },
  "devDependencies": {
    "@types/node": "^14.0.0",
    "jest": "^27.0.0",
    "ts-jest": "^27.0.0"
  }
}

tsconfig.json

{
  "compilerOptions": {
    "target": "ES6",
    "module": "CommonJS",
    "outDir": "./dist",
    "rootDir": "./src",
    "strict": true,
    "esModuleInterop": true
  },
  "include": ["src/**/*"]
}