Pulp 使用指南

Pulp 是一个用于 PureScript 的构建工具，它简化了编译、测试和打包 PureScript 项目的流程。本指南旨在帮助开发者理解其基本架构和关键文件，以便高效地使用 Pulp。

1. 项目目录结构及介绍

Pulp 项目通常遵循一定的结构以保持一致性。以下是一般性的项目结构示例：

.
├── src                    # 源代码文件存放处，PureScript 源码文件放在这里。
│   └── Main.purs          # 入口文件，通常包含 `main` 函数，是程序启动的地方。
├── test                   # 测试文件目录，存放测试用例。
│   └── Spec.purs         # 示例中的测试文件。
├── bower.json             # 依赖管理文件，列出项目所需的 PureScript 库。
├── pulp.json               # Pulp 的配置文件，自定义构建行为。
└── package.json           # 如果项目有 JavaScript 部分或需要npm包，此文件用于Node.js包管理。

2. 项目的启动文件介绍

• Main.purs
  这个文件是应用程序的主要入口点。在 Pulp 环境下，当你运行构建命令来执行项目时，Pulp 默认寻找 src/Main.purs 文件内的 main 函数。这个函数定义了程序启动时执行的操作，如初始化应用逻辑或启动Web服务器等。

3. 项目的配置文件介绍

• pulp.json

  {
    "version": "0.0.1",
    "sourceDirs": ["src"],
    "testDirs": ["test"],
    "targets": ["browser", "node"],
    "pscIDE": false,
    "build": {
      "modules": [
        "Main"
      ],
      "output": "./dist/webpack/main.js"
    }
  }
  

  • sourceDirs: 指定源代码存放的目录。
  • testDirs: 测试文件存放的目录。
  • targets: 指定构建目标，可以是浏览器环境（browser）、Node.js环境（node）或两者。
  • pscIDE: 是否开启PureScript IDE服务，默认关闭。
  • build: 包含更详细的构建配置，比如要编译的模块、输出文件路径等。

以上就是 Pulp 项目的核心组件和它们的基本用途。正确理解和配置这些元素对于有效管理和开发 PureScript 项目至关重要。记得根据实际需求调整 pulp.json 中的各项配置，以优化你的开发体验。