Agda Language Server 项目教程

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

Agda Language Server 项目的目录结构如下：

agda-language-server/
├── .github/                # 存放 GitHub Actions 工作流文件
│   └── workflows/
├── app/                    # 包含应用程序的源代码
├── src/                    # 包含项目的 Haskell 源代码
├── test/                   # 包含项目的测试代码
├── .gitignore              # 指定 Git 忽略的文件和目录
├── CHANGELOG.md            # 记录项目的更新和修改历史
├── LICENSE                 # 项目的 MIT 许可证文件
├── README.md               # 项目的自述文件
├── Setup.hs                # Haskell Stack 的构建脚本
├── agda-language-server.cabal # Cabal 配置文件
├── hie.yaml                # Haskell IDE Engine 配置文件
├── package.yaml            # Stack 的项目配置文件
├── stack-*.yaml            # 不同 Agda 版本的 Stack 配置文件
└── stack.yaml.lock         # Stack 的锁定文件

• .github/workflows/：存放持续集成和持续部署的工作流文件。
• app/：通常用于存放应用程序的源代码，但在本项目中未使用。
• src/：存放 Agda Language Server 的 Haskell 源代码。
• test/：存放用于测试项目的代码。
• .gitignore：定义了 Git 应该忽略的文件和目录列表。
• CHANGELOG.md：记录了项目的所有更新和修改。
• LICENSE：MIT 许可证，规定了项目的使用和分发条款。
• README.md：提供了项目的描述、使用方法和安装指南。
• Setup.hs：用于自定义 Haskell Stack 的构建过程。
• agda-language-server.cabal：Cabal 配置文件，用于描述 Haskell 包。
• hie.yaml：Haskell IDE Engine 配置文件，用于集成开发环境。
• package.yaml：Stack 的项目配置文件，定义了项目的依赖和构建参数。
• stack-*.yaml：为不同版本的 Agda 提供的 Stack 配置文件。
• stack.yaml.lock：Stack 的锁定文件，记录了项目依赖的精确版本。

2. 项目的启动文件介绍

项目的启动主要通过 Stack 工具进行，Stack 是一个用于构建 Haskell 项目的工具。在项目根目录下，你可以通过以下命令启动 Agda Language Server：

stack run

这会编译并在本地运行 Agda Language Server。如果你想先进行测试，可以使用以下命令：

stack test

3. 项目的配置文件介绍

• package.yaml：这是 Stack 的项目配置文件，它定义了项目的名称、版本、依赖项以及构建命令等。例如：

name: agda-language-server
version: 0.2.7.0.1.5
dependencies:
- Cabal-2.4.1.0
- base-4.12.0.0
- ...

• hie.yaml：这是 Haskell IDE Engine 的配置文件，它允许你配置编辑器与 Agda Language Server 的集成。例如，你可以设置监听端口和自动启动服务器等：

{"haskell-language-server": {"command": ["stack", "exec", "haskell-language-server", "--", "--lsp"], "args": {"port": 4096}}}

• agda-language-server.cabal：Cabal 是 Haskell 的包管理器，这个文件描述了 Agda Language Server 作为一个 Cabal 包的结构。它包含了包的元数据、依赖和构建指令。例如：

name: agda-language-server
version: 0.2.7.0.1.5
build-type: Simple
cabal-version: >= 1.10

library
  exposed-modules: ...
  build-depends: ...
  ...

通过这些配置文件，你可以方便地管理和定制 Agda Language Server 的构建和运行过程。