创建 Effect 应用
create-effect-app 命令行工具(CLI)允许你使用默认模板或公共 GitHub 仓库中的示例创建新的 Effect 应用。它是快速上手 Effect 的最简单方式。
命令行界面(CLI)
首先,使用你偏好的包管理器在终端中运行 create-effect-app 命令:
| 包管理器 | 命令 |
|---|---|
| npm | npx create-effect-app@latest |
| pnpm | pnpm create effect-app@latest |
| Yarn | yarn create effect-app@latest |
| Bun | bunx create-effect-app@latest |
| Deno | deno init --npm effect-app@latest |
该命令会启动一个交互式设置流程,引导你完成项目初始化的必要步骤:
完成选择后,create-effect-app 会根据你的选择生成新的 Effect 项目并进行配置。
示例
例如,要在名为 my-effect-app 的目录中创建一个使用基础模板并集成 ESLint 的新 Effect 项目,可运行以下命令:
bash
npx create-effect-app --template basic --eslint my-effect-app
非交互式使用
如果偏好非交互式模式,也可按以下方式使用 create-effect-app:
bash
create-effect-app
(-t, --template basic | cli | monorepo)
[--changesets]
[--flake]
[--eslint]
[--workflows]
[<project-name>]
create-effect-app
(-e, --example http-server)
[<project-name>]
以下是可用于自定义 Effect 项目模板的选项说明:
| 选项 | 描述 |
|---|---|
--changesets |
使用 Changesets 包初始化项目,用于版本控制管理。 |
--flake |
使用 Nix flake 初始化项目,用于系统依赖管理。 |
--eslint |
包含 ESLint,用于代码格式化和代码检查。 |
--workflows |
设置 Effect 推荐的 GitHub Action 工作流,用于自动化流程。 |