1.0.0 • Published 1 year ago

xhlong-template-cli v1.0.0

Weekly downloads
-
License
ISC
Repository
-
Last release
1 year ago

介绍

安装

npm i xhlong-template -g

使用方式

  • 创建模版项目
xhlong-template create <project>
例如:xhlong-template create projectA

命令行参数

xhlong-template --help 查看使用帮助
xhlong-template -V|--version 查看版本号
xhlong-template list 列出所有可用模版
xhlong-template create <project> 基于指定的模版进行项目初始化

获取用户输入的命令行参数

xhlong-template list
// 原生方式
console.log(process.argv)
// 该项目中使用commander包来获取参数

开发

脚手架开发

设置软链

  • package.json文件中添加bin命令,软链指向index.js
  • index.js文件头部添加#!/usr/bin/env node,将以node的方式执行index.js文件
  • npm link 添加软链
  • npm unlink 解除软链 接着控制台便可以使用bin绑定的命令

模版配置

在config/templates.js文件中配置模版

依赖包

"dependencies": {
  "commander": "^9.4.1",          // 管理用户输入命令
  "consola": "^2.15.3",           // 美化控制台打印
  "download-git-repo": "^3.0.2",  // 从git上下载代码
  "handlebars": "^4.7.7",         // 模版解析,用来替换package.json文件中的内容
  "inquirer": "^8.0.0",           // 处理用户与控制台之间的交互
  "ora": "^4.0.5"                 // 美化控制台输出,类似Loading状态
}