Haskell Effectful 项目使用教程

Haskell Effectful 项目使用教程

effectful An easy to use, fast extensible effects library with seamless integration with the existing Haskell ecosystem. 项目地址: https://gitcode.com/gh_mirrors/eff/effectful

1. 项目目录结构及介绍

Haskell Effectful 是一个易于使用、快速扩展的效果库，与现有的 Haskell 生态系统无缝集成。项目目录结构如下：

• benchmarks/: 包含性能测试的代码。
• effectful-core/: effectful 库的核心代码，以及基本的效果实现。
• effectful-plugin/: 提供一个可选的 GHC 插件，用于改善效果的类型推断。
• effectful-th/: 提供通过 Template Haskell 生成效果相关代码的工具。
• effectful/: 重导出 effectful-core 的公共模块，并提供 unliftio 包的大多数功能，划分为适当的效果。
• .github/: 包含 GitHub 工作流程文件，如 CI/CD 配置。
• LICENSE: 项目的许可证文件。
• README.md: 项目的自述文件，详细介绍项目功能和用法。
• cabal.project: Cabal 的项目配置文件。
• doctest.sh: 用于运行 doctest 的脚本。
• genBench.sh: 用于生成性能测试报告的脚本。
• logo.svg: 项目图标。

2. 项目的启动文件介绍

项目的启动主要是通过 Cabal 文件进行的。在 effectful 目录下，有一个 cabal.project 文件，它定义了项目的 Cabal 配置。

-- cabal.project
package effectful
  .github/workflows/cabal.haskell-ci.yaml

此外，cabal.project 文件还可以包含其他依赖和构建配置，具体取决于项目的需要。

3. 项目的配置文件介绍

项目的配置主要在 cabal.project 文件中进行，它允许你指定项目的依赖、构建路径、标志和其他设置。以下是一个简单的配置文件示例：

-- cabal.project
package effectful-core
  Cabal-YYYY.MM.VV
  build-depends:
      base >= 4.12 && < 5
      transformers

在这个配置中，我们指定了 effectful-core 包的 Cabal 版本，以及它依赖的 base 和 transformers 包。

要构建和安装项目，你可以在项目根目录下运行以下命令：

cabal update
cabal build
cabal install

以上步骤将更新项目依赖，构建项目，并将其安装到本地 Haskell 环境中。

请按照这些指导开始使用 Haskell Effectful 库，并探索它的各种功能。

effectful An easy to use, fast extensible effects library with seamless integration with the existing Haskell ecosystem. 项目地址: https://gitcode.com/gh_mirrors/eff/effectful