create-hel 项目说明

项目简介

create-hel 是一个可快速创建 hel 项目的命令行工具，自带多种模板，目前支持创建 hel + react + pnpm workspace 的hel-mono大仓架构项目，通过可自动扩展 type 的架构，后续可以支持其它 hel 类型的示例项目

主要功能

• 支持快速创建微模块大仓架构项目（来自模板hel-mono）
• 支持创建独立的 react、vue、js 库等传统微模块项目

目录结构

create-hel/
  ├── bin/                  # 项目脚本
  │   ├── analyze-args      # 分析命令行参数
  │   ├── config            # 项目脚本配置
  │   ├── consts            # 常量
  │   ├── fetch-template    # 拉取模板
  │   ├── create-template   # 创建模板
  │   ├── util              # 工具函数
  ├── package.json          # 根包配置
  └── README.md             # 项目说明文档

快速开始

创建 hel-mono 项目

以下多种方式均可创建 hel-mono 项目，任意选择其一即可

注：如不提供项目目录名称，则会提供交互询问方式要求用户输入

• create-hel（推荐）

使用 npm 全局安装 create-hel 后，再基于hel命令行或create-hel命令行创建项目到my-mono目录下

npm install create-hel -g
# or type as: create-hel init my-mono
hel init my-mono

• npx

使用 npx 创建项目到my-mono目录下

# 回车后在交互式命令行界面输入 my-mono
npx create-hel@latest

# or
npx create-hel@latest init my-mono

• npm create

使用 npm 创建项目到my-mono目录下

# 回车后在交互式命令行界面输入 my-mono
npm create hel@latest

# or
npx create-hel@latest init my-mono

• pnpm create

使用 pnpm 创建项目到my-mono目录下

# 回车后在交互式命令行界面输入 my-mono
pnpm create hel

# or
pnpm create-hel@latest init my-mono

安装依赖并启动

确保 node 版本>=18，按照提示进入项目安装依赖并启动

cd <your-project-name>
pnpm install
pnpm start

针对内置模板react-mono, 有 2 种启动方式

• 普通模式启动

宿主和所有子模块依赖在一个服务里启动

pnpm start hub

• 微模块启动

除了启动宿主，还会启动所有的子模块依赖

pnpm start hub:hel

更多说明详见react-mono项目

参数说明

• -t 可选参数 -t（或 --template） 默认值react-mono，表示模板类型，目前暂提供这一种内置模板，其他名称会自动尝试拉取 https://github.com/hel-eco/<xxx>.git的代码做初始化

hel init my-mono -t react-mono

• -r 可选参数 -r（或 --remote）默认值 false，表示是否优先从远端拉取 t 参数对应的模板

hel init my-mono -t react-mono -r

• -u 可选参数 -u（或 --url）默认值 undefined，表示从指定 url 的拉取远端模板（设置了 u，则 t r 无效）

hel init my-mono -u https://github.com/hel-eco/hel-mono.git

其他

升级本地模板

hel -b
# or
hel --bump

携带参数写法

npm create 带参写法如下，需要加 --，在其后面的参数会被 create-hel cli 工具接收到

npm create@latest init hel -- -t xx-template

贡献模板

在 https://github.com/hel-eco 组下创建项目，均能被 cli 识别到，例如创一个 my-type，则可以使用以下命令行安装

# 安装 https://github.com/hel-eco/my-type 对应的模板项目
hel init my-mono -t my-type

定制 cli

透传config参数，基于 create-hel 包构建自己的专属 hel cli

#!/usr/bin/env node
const config = require('./config');
const { analyzeArgs, setConfig } = require('create-hel');

// config 参数见 setConfig 里的类型说明
setConfig(config);
analyzeArgs();