@web.worker/create-astro-exe

一个用于快速创建 Astro 项目的 npm 模板包。

功能特性

• 🚀 通过 npm create @web.worker/astro-exe 快速创建 Astro 项目
• 📝 交互式配置项目信息（项目名、描述、作者等）
• 🎨 内置完整的 Astro 项目模板
• 📦 自动安装依赖（可选）
• 🔧 自动初始化 Git 仓库（可选）
• 🔄 模板变量替换系统

使用方法

基本用法

npm create @web.worker/astro-exe my-project

参数说明

该工具采用交互式方式收集配置；如果在不支持参数传递的环境（例如部分 npm create 场景）中使用，将采用默认值：

• 默认安装依赖（可在交互中取消）
• 默认初始化 Git 仓库，但不会自动提交（不执行 git add / git commit）
• 安装依赖时可选择包管理器（npm / yarn / pnpm），默认使用 npm

交互项说明

• Project name：项目名称（可在命令行传入或交互输入）
• Project description：默认值为“ - Astro application”，可编辑
• Author name：默认从 git config --global user.name 回填，若未设置则为空
• Install dependencies：是否安装依赖（默认是）
• Choose a package manager：选择 npm / yarn / pnpm（仅当安装依赖为是时出现，默认 npm）
• Initialize git repository：是否初始化 Git（默认是）

生成的项目结构

my-project/
├── .gitignore
├── README.md
├── astro.config.mjs
├── package.json
├── tsconfig.json
├── public/
│   └── favicon.svg
└── src/
    ├── components/
    │   └── Layout.astro
    └── pages/
        └── index.astro

开发

本地测试

1. 克隆项目并安装依赖：

git clone <repository-url>
cd create-astro-exe
npm install

2. 链接到全局：

npm link

3. 构建并测试 CLI 工具：

npm run build
node dist/create-astro-exe.cjs test-project

项目结构

• bin/ - CLI 入口文件
• lib/ - 核心逻辑模块
• template/ - Astro 项目模板文件
• docs/ - 项目文档

发布到 npm

1. 登录 npm：

npm login

2. 发布包：

npm publish --access public

技术实现

• CLI 框架: 基于 Node.js 原生模块
• 交互式输入: 使用 inquirer 库
• 模板引擎: 自定义变量替换系统
• 文件操作: 使用 fs-extra 进行文件复制和处理

验收标准

• ✅ 支持 npm create @web.worker/astro-exe 命令
• ✅ 交互式配置项目信息
• ✅ 生成完整可运行的 Astro 项目
• ✅ 模板变量正确替换
• ✅ 交互式依赖安装与 Git 初始化（默认初始化但不自动提交）
• ✅ 依赖安装支持包管理器选择（npm / yarn / pnpm）
• ✅ 生成的项目可正常启动开发服务器

许可证

MIT

作者

@web.worker team