使用nodejs搭建脚手架工具并发布到npm中

使用nodejs搭建脚手架工具并发布到npm中

  • 一、安装环境依赖及脚手架搭建过程
  • 二、搭建Monorepo 风格的脚手架工程
  • 三、脚手架的必备模块
    • 命令参数模块
      • 获取命令参数
      • 设置子命令
    • 用户交互模块
    • 文件拷贝模块
      • 脚手架中的路径处理
      • 目录守卫
    • 文件拷贝模块
    • 动态文件生成模块
      • mustache简介
    • 自动安装依赖模块
    • 发布与安装
  • 四、总结

一、安装环境依赖及脚手架搭建过程

  1. 安装 vue-cli 脚手架：npm install -g vue-cli

  2. 创建项目：vue create myapp
    在这里插入图片描述

  3. 输入cmd：
    在这里插入图片描述

  4. 在cmd中输入：npm init 输入后会生成一个package.json文件
    在这里插入图片描述

  5. 在package.json中添加：./bin/index.js
    在这里插入图片描述

这样就声明了一个mortal命令，而./bin/index.js是运行mortal命令后，所运行js的文件相对路径

  1. 创建bin文件夹、在bin文件夹下创建index.js文件：
    在这里插入图片描述

注意：必须加#!/usr/bin/env node否则会报错

  1. **在cmd窗口执行mortal命令：**会报错
    在这里插入图片描述

报错原因：并不是声明命令的方法错误，而是需要将该脚手架发布到npm上，在package.json中可以看到name值为mortal-cli，所以可以通过运行npm install -g mortal-cli将脚手架安装到本地，再运行mortal才会成功（可理解为安装vue-cli脚手架一样的操作过程）

  1. **实现在本地调试脚手架的能力：**先执行npm link再执行mortal则运行成功
    在这里插入图片描述

**总结：**到此一个声明命令结束
注意： npm link的弊端：若本地存在多个版本的脚手架仓库，在A仓库中修改代码，然后运行mortal命令，会发现所修改的代码并不生效。原因是：在仓库B的脚手架中已经运行了npm link，从而导致再次运行mortal时实际上是执行仓库B中的代码。所以要先在仓库B的脚手架工程中先进行释放，运行npm unlink，然后再在仓库A中执行npm link、mortal，此时仓库A中已经修改的代码会生效。所以可以通过pnpm来搭建monorepo风格的脚手架工程。
Monorepo风格：即代码管理方式，指单个仓库中管理多个项目，有助于简化代码共享、版本控制、构建和部署等方面的复杂性，并提供更好的可重用性和协作性。含有多个子工程，每一个子工程都能独立编译打包，并将产物变成npm包，所以又叫monorepo为多包工程。

  1. 修改package.json以便于更好的发布到npm上：
    在这里插入图片描述

注意：在dependencies中声明mortal-cli依赖包版本需使用workspace:*来定义，而不是使用具体的版本号来定义。
在 pnpm 中使用 workspace: 协议定义某个依赖包版本号时，pnpm 将只解析存在工作空间内的依赖包，不会去下载解析 npm 上的依赖包。
把 mortal-cli 依赖包引入，执行 pnpm i 安装依赖，其效果就跟执行 npm install -g mortal-cli一样，只不过不是全局安装而已，只在调试子工程内安装 mortal-cli 脚手架。然后调试子工程就直接引用脚手架子工程本地编译打包后的产物，而不是发布到 npm 上的产物，彻底做到本地调试。
另外脚手架子工程和调试子工程是在同一个工程中，这样就做一对一的调试，从而解决了使用 npm link 来实现本地调试的弊端。
同时在 scripts 定义了脚本命令，在调试工程中执行 pnpm mortal 既是执行了 mortal 命令，不用脚手架工程中执行 npm link 就可以运行 mortal 命令。

  1. **安装pnpm：**先安装pnpm安装pnpm地址详细请见该文章 安装命令：iwr https://get.pnpm.io/install.ps1 -useb | iex
    在这里插入图片描述

二、搭建Monorepo 风格的脚手架工程

  1. 新建mortal文件夹：
    在这里插入图片描述

  2. 使用pnpm搭建monorepo风格脚手架：pnpm init
    在这里插入图片描述

  3. 创建pnpm-workspace.yaml工作空间配置文件： 并添加以下代码
    在这里插入图片描述

声明了 packages 和 examples 文件夹中子工程是同属一个工作空间的，工作空间中的子工程编译打包的产物都可以被其它子工程引用。
在这里插入图片描述

  1. 使用pnpm初始化：pnpm init在packages文件夹下的mortal文件夹下产生一个package.json文件
    在这里插入图片描述
    在这里插入图片描述

  2. 在package.json文件中新建bin字段声明mortal
    在这里插入图片描述

  3. 在packages->mortal下新建bin文件夹，在bin文件夹下新建index.js文件
    在这里插入图片描述

  4. 在与packages同级目录下新建examples文件夹，在该文件夹下创建app文件夹 输入cmd，再输入pnpm init进行初始化生成package.json文件
    在这里插入图片描述
    在这里插入图片描述

  5. 给example文件夹中的package.json添加代码:
    在这里插入图片描述

  6. 在最外层的根目录执行安装命令：pnpm install
    在这里插入图片描述

  7. 当前的目录结构：

Project Tree插件可生成tree目录，或者在该文件夹中cmd到根目录->输入TREE>文件名.txt也可生成tree目录
使用Project Tree插件：Crtl + Shift + P -> 输入Project Tree->生成README.md文件这里是引用
在这里插入图片描述
这里是目录工程化
在这里插入图片描述

// 当前项目的目录结构如下所示：
mortal
├─ examples
│  └─ app
│     └─ package.json
├─ package.json
├─ packages
│  └─ mortal-cli
│     ├─ bin
│     │  └─ index.js
│     └─ package.json
├─ pnpm-lock.yaml
└─ pnpm-workspace.yaml

三、脚手架的必备模块

命令参数模块

获取命令参数

  1. Node.js 中的 process 模块提供了当前 Node.js 进程相关的全局环境信息，比如命令参数、环境变量、命令运行路径process模块 安装命令：npm install 
const process = require('process');
// 获取命令参数
console.log(process.argv);

脚手架提供的 mortal 命令后面还可以设置参数，标准的脚手架命令参数需要支持两种格式：

mortal --name=orderPage
mortal --name orderPage

通过 process.argv 来获取，要额外处理两种不同的命令参数格式不方便，这里使用 yargs 开发脚手架/CLI，这里推荐 yargs 开源库来解析命令参数

  1. 这里使用 yargs 开发脚手架/CLI：pnpm add yargs --F mortal-cli
    在这里插入图片描述

这里要注意，mortal-cli 是取 mortal-cli 子工程中 package.json 中 name 字段的值，而不是 mortal-cli 子工程文件夹的名称。yargs 的使用非常简单，其提供的 argv 属性是对两个格式的命令参数的处理结果。

  1. 在 bin/index.js 添加如下代码：
#!/usr/bin/env node
const yargs = require('yargs')console.log('name',yargs.argv.name);

在这里插入图片描述

注意，以上代码是在 Node.js 环境中运行，Node.js 的模块是遵循 CommonJS 规范的，如果要依赖一个模块，要使用 Node.js 内置 require 系统函数引用模块使用。

  1. 在example/app文件夹下执行：pnpm mortal -- --name=orderPage
    在这里插入图片描述

注意，在 pnpm mortal 后面需要加上两个连字符（--），这是为了告诉 pnpm 后面的参数是传递给命令mortal 本身的，而不是传递给 pnpm 的。结果是name orderPage

设置子命令

假如脚手架要对外提供多个功能，不能将所有的功能都集中在 mortal 命令中实现。可通过 yargs 提供的 command 方法来设置一些子命令，让每个子命令对应各自功能，各司其职。
yargs.command 的用法是 yargs.command(cmd, desc, builder, handler)

  • cmd：字符串，子命令名称，也可以传递数组，如 [‘create’, ‘c’]，表示子命令叫 create，其别名是 c；
  • desc：字符串，子命令描述信息；
  • builder：一个返回数组的函数，子命令参数信息配置，比如可以设置参数：
    • alias：别名；
    • demand：是否必填；
    • default：默认值；
    • describe：描述信息；
    • type：参数类型，string | boolean | number。
  • handler: 函数，可以在这个函数中专门处理该子命令参数。

设置一个用来生成一个模板的子命令，把这个子命令命名为create： 修改在 bin/index.js 文件中的代码：

#!/usr/bin/env node
//const yargs = require('yargs');
yargs.command(['create', 'c'],'新建一个模板',function (yargs) {return yargs.option('name', {alias: 'n',demand: true,describe: '模板名称',type: 'string'})},function (argv) {console.log('argv', argv);}
).argv;

在app下执行：pnpm mortal create -- --name=orderPage和pnpm mortal c -- --name=orderPage
在这里插入图片描述

配置了子命令 create 的参数 name 的一些参数信息，如何将这些信息展示给用户：输入子命令的参数有错误，就会在命令行窗口中显示这些参数信息。

在app文件夹目录下：pnpm mortal c -- --abc
在这里插入图片描述

最简单地实现了脚手架和用户之间的交互能力，但是如果自定义参数过多，那么命令行参数的交互方法对于用户来说是非常不友好的。所以需要通过用户交互模块桥接与用户进行交互。

用户交互模块

  1. 下载inquirer： 实现询问式的交互 pnpm add inquirer@8.2.5 --F mortal-cli
    在这里插入图片描述

为了使用 require 引入 inquirer ，要使用 8.2.5 版本的 inquirer。
inquirer 能力：询问用户问题、获取并解析用户的输入、检测用户的答案是否合法

主要通过 inquirer.prompt() 来实现。prompt 函数接收一个数组，数组的每一项都是一个询问项，询问项有很多配置参数，下面是常用的配置项：

  • type：提问的类型，常用的有：
    • 输入框：input；
    • 确认：confirm；
    • 单选组：list；
    • 多选组：checkbox；
  • name：存储当前问题答案的变量；
  • message：问题的描述；
  • default：默认值；
  • choices：列表选项，在某些type下可用；
  • validate：对用户的答案进行校验；
  • filter：对用户的答案进行过滤处理，返回处理后的值。

总结：创建一个模板文件，大概会询问用户：模板文件名称、模板类型、使用什么框架开发、使用框架对应的哪个组件库开发等等

  1. 在 bin 文件夹中新建 inquirer.js 文件夹：
// 添加的内容
const inquirer = require("inquirer");function inquirerPrompt(argv) {const { name } = argv;return new Promise((resolve, reject) => {inquirer.prompt([{type: "input",name: "name",message: "模板名称",default: name,validate: function (val) {if (!/^[a-zA-Z]+$/.test(val)) {return "模板名称只能含有英文";}if (!/^[A-Z]/.test(val)) {return "模板名称首字母必须大写";}return true;},},{type: "list",name: "type",message: "模板类型",choices: ["表单", "动态表单", "嵌套表单"],filter: function (value) {return {表单: "form",动态表单: "dynamicForm",嵌套表单: "nestedForm",}[value];},},{type: "list",message: "使用什么框架开发",choices: ["react", "vue"],name: "frame",},]).then((answers) => {const { frame } = answers;if (frame === "react") {inquirer.prompt([{type: "list",message: "使用什么UI组件库开发",choices: ["Ant Design"],name: "library",},

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.hqwc.cn/news/601325.html

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

相关文章

近距离共享数字化实战经验，深挖数据价值赋能千行百业

近距离共享数字化实战经验，深挖数据价值赋能千行百业

近期，思迈特软件积极投身于金融、制造、零售、医疗等多个行业的线下活动中，深度解析行业趋势，分享BI数字化创新解决方案，并与客户及合作伙伴进行深入交流。通过这些活动，不仅展示了思迈特软件在各领域的先进技术和成果…
阅读更多...
企业3D数字化网络展馆成为企业文化传承与发扬的圣地

企业3D数字化网络展馆成为企业文化传承与发扬的圣地

在河北这片古老而富饶的土地上，文明的火种薪火相传，燕赵之风历久弥新。河北企业也多年持续稳居我国第五的宝座，企业文化展馆不仅是企业形象的展示窗口，更是企业文化传承与发扬的圣地。 与短暂的行业展会不同，企业展馆是…
阅读更多...
PyCharm双击无法打开 安装新旧版本pycharm同时启动失败的解决办法

PyCharm双击无法打开 安装新旧版本pycharm同时启动失败的解决办法

由于2019版本无法直接升级到2023版本 所以下载了两个版本的PyCharm 且两个都是专业版的 一个是2019的， 一个是2024新版的其中2019版本是破解版！ 然后现在想要打开2024的新版，发现双击无法启动，到文件所在位置打开也无法启动&a…
阅读更多...
关系（三）利用python绘制相关矩阵图

关系（三）利用python绘制相关矩阵图

关系（三）利用python绘制相关矩阵图 相关矩阵图（Correlogram）简介 相关矩阵图既可以分析每对变量之间的相关性，也可以分析单变量的分布情况。相关性以散点图的形式可视化，对角线用直方图/密度图表示每个变量…
阅读更多...
AI智能分析盒子在工地的应用，提高工地管理效率和安全性

AI智能分析盒子在工地的应用，提高工地管理效率和安全性

工地ai智能分析盒子是一种基于人工智能视觉分析技术的人工智能盒子，旨在提升工地作业区域的管理效率和保障作业人员的安全。通过最前沿的AI视觉算法、大数据，能够实时监控工地现场视频流画面，对施工工地人员的工作着装及日常作业行为进行规范…
阅读更多...
Mysql底层原理十：Redo log

Mysql底层原理十：Redo log

3.7 Redo log Redo log记录的是物理日志，具体就是哪个表空间，哪个数据页，哪个偏移量，改了几个字节，改成什么表空间号数据页号偏移量修改几个字节的值具体的值 3.7.1 Redo block （批处理缓存）…
阅读更多...
2023年全球热门编程语言排行榜

2023年全球热门编程语言排行榜

2023年全球热门编程语言top排行榜，数据来源stackoverflow。 排名前三分别为 JavaScript， HTML/CSS, Python. Top20排行榜 2023年全球编程语言TOP排行榜 总版 语言名称 百分比 JavaScript 63.61% HTML/CSS 52.97% Python 49.28% SQL 48.66% Type…
阅读更多...
Databend 开源周报第 138 期

Databend 开源周报第 138 期

Databend 是一款现代云数仓。专为弹性和高效设计，为您的大规模分析需求保驾护航。自由且开源。即刻体验云服务：https://app.databend.cn 。 Whats On In Databend 探索 Databend 本周新进展，遇到更贴近你心意的 Databend 。 支持多表插入 …
阅读更多...
关于STM32单片机延时微妙（delay_us）函数-hal库

关于STM32单片机延时微妙（delay_us）函数-hal库

关于STM32单片机延时微妙（delay_us）函数-hal库 Chapter1 关于STM32单片机延时微妙（delay_us）函数-hal库delay_us 函数delay_ms 函数验证补充 Chapter1 关于STM32单片机延时微妙（delay_us）函数-hal库 原文链…
阅读更多...
14届蓝桥杯省赛 C/C++ B组 T4 飞机降落 （DFS）

14届蓝桥杯省赛 C/C++ B组 T4 飞机降落 （DFS）

记录此题提醒自己，此类时间轴问题可以通过DFS解决 DFS不是能解决所有题吗 对于此题，我们将降落的飞机的个数和时间轴作为DFS的形参，这样可以节省手动回溯的过程。 并且在DFS的过程中我们要加入一些贪心策略，否则直接爆搜有可能搜…
阅读更多...
精酿啤酒：酿造过程中的微生物控制与管理

精酿啤酒：酿造过程中的微生物控制与管理

在啤酒酿造过程中，微生物控制与管理是确保啤酒品质和口感的重要环节。Fendi Club啤酒在酿造过程中，对微生物的控制与管理有着严格的要求和杰出的技艺。 Fendi Club啤酒注重原料的微生物质量。他们了解不同原料中可能存在的微生物种类和数量，并…
阅读更多...
安装 windows 版 dash —— zeal

安装 windows 版 dash —— zeal

1、下载安装 下载地址：Download Zeal 选择 Protable 版 直接使用 zeal 下载文档比较慢甚至失败，可以设置代理，也可以使用下面两种方式。 2、手动下载 docset 文档后导入 这种方法不能够选择文档的版本 （1）在 http://…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023