用 Node.js 构建模块化的 CLI 脚手架工具,从 GitHub 下载远程模板

在这里插入图片描述


本文将手把手带你构建一个支持远程模板下载、自定义项目名称,并完成模块化拆分的 CLI 脚手架工具,适用于初创项目、团队内部工具或者开源项目快速初始化。


🧩 为什么要自己造一个 CLI 脚手架?

在日常开发中,我们常用脚手架如 create-react-appvue-cli 来初始化项目,它们帮我们完成繁琐的初始化配置。如果你:

  • 想统一团队的项目初始化结构;
  • 想搭建自己的模板体系;
  • 想通过命令行一键拉取模板代码;

那自定义脚手架就是你的不二选择!


📦 项目结构设计(模块化)

我们先设计一套清晰的目录结构,便于后续拓展和维护:

my-cli/
├── bin/
│   └── my-cli.js          # CLI 命令入口
├── lib/
│   ├── init.js            # 初始化流程调度
│   ├── download.js        # 模板下载逻辑
│   ├── log.js             # 统一日志封装
│   └── repo.js            # 仓库地址统一管理
├── package.json

🛠️ 核心依赖库说明

库名用途描述
commanderCLI 命令行参数解析
download-git-repo支持 GitHub/Gitee 等仓库模板下载
ora终端加载动画
chalk控制台美化输出
inquirer(可选)增强交互体验,如模板选择

🧱 一步步构建 CLI 工具

Step 1️⃣:初始化并安装依赖

mkdir my-cli && cd my-cli
npm init -ynpm install commander download-git-repo ora chalk

Step 2️⃣:编写命令入口 bin/my-cli.js

#!/usr/bin/env node
const { program } = require('commander');
const init = require('../lib/init');program.version('1.0.0').command('init <projectName>').description('初始化一个项目模板').action((projectName) => {init(projectName);});program.parse(process.argv);

别忘了给该文件执行权限:chmod +x bin/my-cli.js
并在 package.json 添加:

"bin": {"my-cli": "./bin/my-cli.js"
}

Step 3️⃣:编写模板下载逻辑 lib/download.js

const download = require('download-git-repo');
const ora = require('ora');
const { error, success } = require('./log');function downloadTemplate(repo, dest) {const spinner = ora('📦 正在下载模板...').start();return new Promise((resolve, reject) => {download(repo, dest, { clone: false }, (err) => {if (err) {spinner.fail('❌ 下载失败');error(err);reject(err);} else {spinner.succeed('✅ 下载成功');resolve();}});});
}module.exports = downloadTemplate;

Step 4️⃣:统一日志输出 lib/log.js

const chalk = require('chalk');exports.success = (msg) => console.log(chalk.green(msg));
exports.error = (msg) => console.log(chalk.red(msg));
exports.info = (msg) => console.log(chalk.blue(msg));

Step 5️⃣:管理模板仓库地址 lib/repo.js

module.exports = {vue: 'github:yourname/vue-template',react: 'github:yourname/react-template',default: 'github:yourname/base-template'
};

你可以拓展为支持 inquirer 交互选择模板。


Step 6️⃣:主流程调度 lib/init.js

const path = require('path');
const fs = require('fs');
const downloadTemplate = require('./download');
const repo = require('./repo');
const { error, success } = require('./log');async function init(projectName) {const targetDir = path.resolve(process.cwd(), projectName);if (fs.existsSync(targetDir)) {error(`目录 ${projectName} 已存在`);process.exit(1);}const templateRepo = repo.default;try {await downloadTemplate(templateRepo, targetDir);success(`🎉 项目 ${projectName} 初始化完成`);console.log(`👉 你可以执行:\n   cd ${projectName}\n   npm install\n   npm start`);} catch (err) {error('初始化失败');}
}module.exports = init;

🚀 如何运行和测试

npm link      # 将 CLI 注册为全局命令
my-cli init my-app

你的模板就会从远程仓库拉取并生成到 my-app 目录!


🌱 后续拓展方向

目标技术点
多模板选择使用 inquirer 提供列表选择
模板渲染变量加入 ejs 渲染 package.json 等文件
模板配置项提供 .myclirc 管理默认仓库
支持 GitLab / Gitee使用 clone: true 下载私有仓库

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如若转载,请注明出处:http://www.pswp.cn/web/88805.shtml
繁体地址,请注明出处:http://hk.pswp.cn/web/88805.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

08.如何正确关闭文件

如何正确关闭文件(File Handling Best Practices) 文件操作是日常开发中非常常见的任务,正确关闭文件对于避免资源泄漏尤为关键。错误的文件关闭方式可能导致文件未保存、锁定或其他异常。 1. 常见的错误方式:手动 close() 许多初学者会手动调用 close() 关闭文件,这在异…

算法入门--动态规划(C++)

深入浅出掌握动态规划核心思想&#xff0c;图文并茂实战代码 什么是动态规划&#xff1f; 动态规划&#xff08;Dynamic Programming, DP&#xff09; 是一种高效解决多阶段决策问题的方法。它通过将复杂问题分解为重叠子问题&#xff0c;并存储子问题的解&#xff08;避免重…

[2025CVPR]GNN-ViTCap:用于病理图像分类与描述模型

论文结构解析​ 本文采用经典学术论文结构: ​引言​:阐述病理图像分析的挑战与现有方法局限性​相关工作​:系统梳理MIL、视觉语言预训练和生物医学语言模型三大领域​方法​:详细阐述GNN-ViTCap四阶段架构​实验​:在BreakHis和PatchGastric数据集验证性能​讨论​:通…

Java SE--图书管理系统模拟实现

一.设计思路首先这个系统可以由俩种用户使用&#xff0c;分别为管理者用户和普通者用户&#xff0c;根据不同的用户有不同的界面&#xff0c;每个界面有不同的功能。二.代码实现创建三个包和一个类book包&#xff1a;包括Book类和Booklist类Book类&#xff1a;package book; pu…

[RPA] 批量数据抓取指定商品名称信息

影刀RPA案例&#xff1a;批量数据抓取指定商品名称信息流程图&#xff1a;操作步骤&#xff1a;涉及的影刀RPA大致指令&#xff1a; 1. 打开影刀商城页面 2. 使用【填写输入框(web)】指令输入用户名和密码&#xff0c;并点击"登录"按钮 3. 切换到"订单管理"…

我的世界Java版1.21.4的Fabric模组开发教程(十四)方块实体

这是适用于Minecraft Java版1.21.4的Fabric模组开发系列教程专栏第十四章——方块实体。想要阅读其他内容&#xff0c;请查看或订阅上面的专栏。 方块实体(Block Entity) 指的是一种用于存储方块额外数据的方法。但这种数据和为了控制方块状态而在自定义方块类中创建的属性不太…

【UE教程/进阶】UE中的指针与引用

目录直接属性引用共享指针 TSharedPtr实现原理共享引用 TSharedRef弱引用指针 TWeakPtrObject弱指针 FWeakPtr实现原理Object软指针 FSoftObjectPtr原理直接属性引用 在c通过UPROPERTY()宏将属性公开&#xff0c;蓝图中属性类型中的Object Reference。 对一个类型及其子类型的…

早期 CNN 的经典模型—卷积神经网络(LeNet)

目录 LeNet 的设计背景与目标 LeNet 的网络结构&#xff08;经典 LeNet-5&#xff09; 局部感受野详解 一、局部感受野和全连接网络的区别 1. 传统全连接网络的问题 2. 局部感受野的解决方案 二、局部感受野的优势 1. 参数大幅减少 2. 提取局部特征 3. 平移不变性 参数…

RabbitMQ 高级特性之延迟队列

1. 简介 在某些场景下&#xff0c;当生产者发送消息后&#xff0c;可能不需要让消费者立即接收到&#xff0c;而是让消息延迟一段时间后再发送给消费者。 2. 实现方式 2.1 TTL 死信队列 给消息设置过期时间后&#xff0c;若消息在这段时间内没有被消费&#xff0c;就会将消…

uniapp app安卓下载文件 图片 doc xls 数据流文件 app安卓本地路径下载保存

//下载图片 downloadToLocal() {plus.android.requestPermissions([android.permission.WRITE_EXTERNAL_STORAGE],(success) > {uni.saveImageToPhotosAlbum({filePath: /static/x.png,//本地地址success: () > {this.$refs.uToast.show({message: "模版下载成功&am…

Context Engineering:从Prompt Engineering到上下文工程的演进

最近在做Deepresearch以及刷到一个不错的文章&#xff1a;context-engineering-guide &#xff0c;这篇文章揭示了提示工程以及上下文过程在智能体应用开源流程中&#xff0c;包括Deepresearch&#xff0c;MCP在内的一些概念&#xff0c;起到了非常重要的作用&#xff01; Cont…

jenkins部署vue前端项目

文章目录前言一、安装nginx二、jenkins构建项目总结前言 前面已经使用jenkins部署了后端springboot项目&#xff0c;现在开始学习jenkins部署前端Vue项目。 一、安装nginx 访问nginx官网&#xff0c;https://nginx.org/en/download.html下载tar包 上传到服务器目录中 然后到…

设计总监年中复盘:用Adobe XD内容识别布局,告别“手动调距”

时至年中&#xff0c;这不仅是检视上半年项目成果的节点&#xff0c;更是优化团队工作流、为下半年挑战储备动能的关键时期。在海外设计界工作的十余年间&#xff0c;我发现&#xff0c;一个高效的设计团队与一个疲于奔命的团队之间&#xff0c;最大的差别往往就在于是否建立了…

Unity 在Rider中通过Lingma插件使用MCP

环境&#xff1a; Unity 2022.3.12f1 JetBrains Rider 2025.1.4 Lingma 2.5.14 Python 3.13.4 下载包 首先在unity package manager 加入unity-mcp包 https://github.com/justinpbarnett/unity-mcp.git 然后下载uv包&#xff08;要先先下载python&#xff09;,网上很多…

pycharm+SSH 深度学习项目 远程后台运行命令

pycharmSSH 深度学习项目 远程后台运行命令碎碎念&#xff0c;都是实验室里那说关机就关机&#xff0c;说重启就重启的台式机逼得。。学吧记录 运行&#xff1a;nohup /root/miniconda3/bin/python -u "run.py" > /root/log/nohup.log 2>&1 &实时查看日…

【Linux | 网络】应用层(HTTP)

目录一、认识URL二、urlencode和urldecode三、HTTP协议格式&#xff08;使用Fiddler抓包&#xff09;3.1 安装并使用Fiddler抓包3.2 HTTP协议格式3.2.1 HTTP请求3.2.1.1 资源URL路径3.2.1.2 请求方法&#xff08;Method&#xff09;3.2.1.3 Location头字段&#xff08;重定向相…

编程实践:单例模式(懒汉模式+饿汉模式)

说明:本专栏文章有两种解锁方案 1:付费订阅,畅享所有文章 2:免费获取,点击下方链接,关注,自动获取免费链接 https://free-img.400040.xyz/4/2025/04/29/6810a50b7ac8b.jpg 主题:C++ 单例模式 什么是单例模式

破局电机制造四大痛点:MES与AI视觉的协同智造实践

万界星空科技电机行业MES系统解决方案是针对电机制造过程中多工序协同难、质量追溯复杂、设备管理要求高等痛点设计的数字化管理系统。一、电机行业的核心痛点1. 多工序协同困难 电机制造涉及绕线、装配、测试等多道工序&#xff0c;工艺衔接复杂&#xff0c;传统人工调度效率…

HTML 初体验

HTML&#xff08;超文本标记语言&#xff09;全称&#xff1a;HyperText Markup Language。超文本是什么&#xff1f;答&#xff1a;超文本就是网页中的链接。标记是什么&#xff1f;答&#xff1a;标记也叫标签&#xff0c;是带尖括号的文本。需求1&#xff1a;将“我爱中国”…

网络层TCP机制

1.确认应答机制由于发送信息的距离可能较远,可能出现后发的信息先到的情况,怎么办?TCP将每个字节的数据都进行了编号,即为序列号如何分辨一个数据包是普通数据还是应答数据呢2.超时重传由于丢包是一个随机的事件,因此在上述tcp传输的过程中,丢包就存在两种情况但是在发送方的角…