Haskell-Flake 使用教程

Haskell-Flake 使用教程

haskell-flake A `flake-parts` Nix module for Haskell development 项目地址: https://gitcode.com/gh_mirrors/ha/haskell-flake

1. 项目介绍

Haskell-Flake 是一个用于 Haskell 开发的 flake-parts Nix 模块。它简化了使用 Nix flakes 进行 Haskell 项目开发、打包和部署的过程。Haskell-Flake 通过现代的 flake-parts 模块，轻松集成到其他 Nix 项目和 shell 开发环境中，提供了轻量级和模块化的方式来管理 Haskell 项目。

2. 项目快速启动

2.1 安装 Nix

首先，确保你已经安装了 Nix。如果你还没有安装 Nix，可以按照以下步骤进行安装：

sh <(curl -L https://nixos.org/nix/install) --daemon

2.2 克隆项目

克隆 Haskell-Flake 项目到本地：

git clone https://github.com/srid/haskell-flake.git
cd haskell-flake

2.3 配置 flake.nix

在你的项目根目录下创建或编辑 flake.nix 文件，添加以下内容：

{
  inputs = {
    flake-parts.url = "github:hercules-ci/flake-parts";
    haskell-flake.url = "github:srid/haskell-flake";
  };

  outputs = inputs: inputs.flake-parts.lib.mkFlake { inherit inputs; } {
    systems = [ "x86_64-linux" ];
    imports = [
      inputs.haskell-flake.flakeModule
    ];

    perSystem = { self', system, lib, config, pkgs }: {
      haskellProjects.default = {
        basePackages = pkgs.haskellPackages;
        packages = {
          aeson.source = "1.5.0.0";
        };
        devShell = {
          hlsCheck.enable = false;
        };
        autoWire = [ "packages" "apps" "checks" ];
      };

      devShells.default = pkgs.mkShell {
        name = "my-haskell-package custom development shell";
        inputsFrom = [ config.haskellProjects.default.outputs.devShell ];
        nativeBuildInputs = with pkgs; [
          # 其他开发工具
        ];
      };
    };
  };
}

2.4 启动开发环境

运行以下命令启动开发环境：

nix develop

3. 应用案例和最佳实践

3.1 单包项目

对于单包 Haskell 项目，Haskell-Flake 提供了简单的方式来管理依赖和开发环境。你可以在 flake.nix 中指定项目的基本包和额外包，并配置开发环境。

3.2 多包项目

对于多包项目，Haskell-Flake 支持使用 cabal.project 文件来管理多个包。你可以在 flake.nix 中配置每个包的依赖和开发环境。

3.3 最佳实践

• 模块化配置：使用 flake-parts 模块化配置，便于管理和扩展。
• 自动化测试：通过 autoWire 自动添加测试和检查。
• 开发工具集成：在 devShell 中集成常用的开发工具，如 hlint、ormolu 等。

4. 典型生态项目

4.1 Nix Flakes

Haskell-Flake 是基于 Nix Flakes 构建的，Nix Flakes 是 Nix 包管理器的一个新特性，提供了更强大和灵活的包管理功能。

4.2 Cabal

Haskell-Flake 支持使用 Cabal 作为 Haskell 包管理器，确保你的项目可以方便地使用 Cabal 进行构建和管理。

4.3 Haskell Language Server (HLS)

Haskell-Flake 可以与 Haskell Language Server 集成，提供强大的 IDE 支持，包括代码补全、类型检查和重构等功能。

通过以上步骤，你可以快速上手并使用 Haskell-Flake 进行 Haskell 项目的开发和管理。

haskell-flake A `flake-parts` Nix module for Haskell development 项目地址: https://gitcode.com/gh_mirrors/ha/haskell-flake