Node学习第二章-创建脚手架工具

2024-06-04 05:36
文章标签 工具 学习 创建 node 第二章 脚手架

本文主要是介绍Node学习第二章-创建脚手架工具，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

开发脚手架工具

脚手架是个工具，通过输入命令创建项目初始化代码文件。

脚手架工具的特点：1.指令执行 2.可交互 3.初始化项目构架。

创建脚手架工具教学

主要步骤：

  1. 创建自定义指令
  2. 接受命令参数
  3. 设计终端交互
  4. 模块化抽离
  5. 下载远程代码
  6. 项目初始化完成提示

1. 创建全局指令

  1. 创建项目文件夹，并且在文件中新建名称为bin子文件夹，然后在bin文件夹中创建文件cli.js文件。这样做的目的是我们后续生成package.json文件时，会自动配置我们的指令。当作我们的一个全局命令入口。
  2. 终端输入：npm init 初始化脚手架信息。输入脚手架的名称，之后的配置信息默认即可。初始化结束之后，生成package.json文件，“mycli"就是我的脚手架名称，“bin”, 配置的是命令程序入口。
    在这里插入图片描述
  3. 编写cli.js程序
    首先终端使用指令：npm link 将指令全局挂载。然后在cli.js文件中代码首行配置，指令运行环境。
    在这里插入图片描述

2 接受命令参数

  1. 获取命令参数
    终端输入 mycli --help, cli.js 文件中打印这个help入参。
console.log(process.argv[2]);

在这里插入图片描述
2. 引入第三方包，处理指令参数。commander。npm install commander。commander。

// 引入commader
const {program} = require('commander');
program.parse(process.argv);

控制台 输入mycli --help, 可以看到控制提示，已经有默认的help指令。
自定义指令（“’–framwork‘ ’别名 -f‘ ’参数‘”， ‘指令说明’）

const {program} = require('commander');
program.option('-f --framwork <framwork>', '设置框架');
program.parse(process.argv);
  1. 使用commander处理自定义命令参数。
    通过.command()或.addCommand()可以配置命令，有两种实现方式：为命令绑定处理函数，或者将命令单独写成一个可执行文件。
// 第一个参数为命令名称，命令参数可以跟在名称后面，也可以用.argument()单独指定。参数可为必选的（尖括号表示）、可选的（方括号表示）或变长参数（点号表示，如果使用，只能是最后一个参数）
program.command('create <project> [destination...]' ) // 设置指令，指令
.alias('crt') // 别名
.description('创建项目') // 命令说明 自动在help生成
.action((project, args)=>{// 命令行的执行逻辑代码console.log('参数', project, args)
})
program.parse(process.argv);

3 设计终端交互

  1. npm install inquirer
  2. 代码
var inquirer = require('inquirer');
inquirer.prompt([{type: 'input',name: 'username',message: '你的名字'}
]).then((answer)=>{console.log(answer)
})
  1. 在使用中可能会提示require 不能用，建议降低inquirer的版本，npm i inquirer@8.2.0 。

4. 模块化抽离

创建lib文件夹，然后在lib中创建子文件夹core, 其中创建JS脚本,存放主要的逻辑代码。
help.js

const myhelp = function(program){program.option('-f --framwork <framwork>', '设置框架');
}
module.exports = myhelp;

command.js

const myAction = require('../core/action')
var command = (program)=>{program.command('create <project> [destination...]' ) // 设置指令，指令.alias('crt') // 别名.description('创建项目') // 命令说明 自动在help生成.action((project, args)=>{// 命令行的执行逻辑代码myAction(project, args)})
}
module.exports = command;

action.js

var inquirer = require('inquirer');
var config = require('../../config')
const myAction = (project, args)=>{// 命令行的执行逻辑代码console.log('参数', project, args)inquirer.prompt([{type: 'list',name: 'framwork',choices: config.framwork,message: '请选择你使用的框架'}]).then((answer)=>{console.log(answer)})
}
module.exports = myAction;

最后集成到bin/cli.js

#! /Users/shishuai/.nvm/versions/node/v17.0.1/bin/node
const {program} = require('commander');
const myhelp = require('../lib/core/help');
myhelp(program);
const command = require('../lib/core/command');
command(program)
program.parse(process.argv);

5 下载远程代码

项目中引入下载插件，并且在action.js中,通过用户的选择“模版”的指令，下载对应的文件。

  1. 引入插件 npm install download-git-repo
  2. 抽离下载方法，创建download.js
const download = require('download-git-repo');
const downloadFun = function(url, project) {download('direct:'+url, project,{clone:true},(err)=>{console.log(err)})
}
module.exports = downloadFun;
  1. config.js中配置不同选择项的下载路径
module.exports = {// 可选择的框架framwork:['express','koa', 'egg'],// 框架的下载地址framworkUrl:{express:'https://github.com/expressjs/express.git',koa:'https://github.com/koajs/koa.git',egg:'https://gitee.com/mirrors/eggjs.git'}
}
  1. action.js 引入使用， 核心代码展示
// 远程下载
var downloadFun = require('./download');
const myAction = async (project, args)=>{// 命令行的执行逻辑代码console.log('参数', project, args)const answer = await inquirer.prompt([{type: 'list',name: 'framwork',choices: config.framwork,message: '请选择你使用的框架'}])downloadFun(config.framworkUrl[answer.framwork],project)console.log(answer)
}

  1. 优化下载，加入laoding 动画, 加入不同的颜色字体
    引入插件 npm install ora@5。 优化动画
    引入插件 npm install chalk。优化字体

    使用插件

    
const ora = require('ora')
const chalk = require('chalk')
const downloadFun = function (url, project) {const spinner = ora().start()spinner.text = '代码正在下载……'download('direct:' + url, project, { clone: true }, (err) => {if (!err) {spinner.succeed('代码下载成功')console.log(chalk.blue.bold('Done!'), chalk.bold('you run:'));console.log('cd ' + project);console.log('npm install ');console.log('npm run dev ');} else {spinner.fail('代码下载失败')}})
}

这篇关于Node学习第二章-创建脚手架工具的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1029198。

相关文章

Android 悬浮窗开发示例((动态权限请求 | 前台服务和通知 | 悬浮窗创建 )

Android 悬浮窗开发示例((动态权限请求 | 前台服务和通知 | 悬浮窗创建 )

《Android悬浮窗开发示例((动态权限请求|前台服务和通知|悬浮窗创建)》本文介绍了Android悬浮窗的实现效果,包括动态权限请求、前台服务和通知的使用,悬浮窗权限需要动态申请并引导... 目录一、悬浮窗 动态权限请求1、动态请求权限2、悬浮窗权限说明3、检查动态权限4、申请动态权限5、权限设置完毕后
阅读更多...
Java深度学习库DJL实现Python的NumPy方式

Java深度学习库DJL实现Python的NumPy方式

《Java深度学习库DJL实现Python的NumPy方式》本文介绍了DJL库的背景和基本功能,包括NDArray的创建、数学运算、数据获取和设置等,同时,还展示了如何使用NDArray进行数据预处理... 目录1 NDArray 的背景介绍1.1 架构2 JavaDJL使用2.1 安装DJL2.2 基本操
阅读更多...
Java数字转换工具类NumberUtil的使用

Java数字转换工具类NumberUtil的使用

《Java数字转换工具类NumberUtil的使用》NumberUtil是一个功能强大的Java工具类,用于处理数字的各种操作,包括数值运算、格式化、随机数生成和数值判断,下面就来介绍一下Number... 目录一、NumberUtil类概述二、主要功能介绍1. 数值运算2. 格式化3. 数值判断4. 随机
阅读更多...
Python创建Excel的4种方式小结

Python创建Excel的4种方式小结

《Python创建Excel的4种方式小结》这篇文章主要为大家详细介绍了Python中创建Excel的4种常见方式,文中的示例代码简洁易懂,具有一定的参考价值,感兴趣的小伙伴可以学习一下... 目录库的安装代码1——pandas代码2——openpyxl代码3——xlsxwriterwww.cppcns.c
阅读更多...
使用Navicat工具比对两个数据库所有表结构的差异案例详解

使用Navicat工具比对两个数据库所有表结构的差异案例详解

《使用Navicat工具比对两个数据库所有表结构的差异案例详解》：本文主要介绍如何使用Navicat工具对比两个数据库test_old和test_new,并生成相应的DDLSQL语句,以便将te... 目录概要案例一、如图两个数据库test_old和test_new进行比较：二、开始比较总结概要公司存在多
阅读更多...
Java中基于注解的代码生成工具MapStruct映射使用详解

Java中基于注解的代码生成工具MapStruct映射使用详解

《Java中基于注解的代码生成工具MapStruct映射使用详解》MapStruct作为一个基于注解的代码生成工具,为我们提供了一种更加优雅、高效的解决方案,本文主要为大家介绍了它的具体使用,感兴趣... 目录介绍优缺点优点缺点核心注解及详细使用语法说明@Mapper@Mapping@Mappings@Co
阅读更多...
使用Python在Excel中创建和取消数据分组

使用Python在Excel中创建和取消数据分组

《使用Python在Excel中创建和取消数据分组》Excel中的分组是一种通过添加层级结构将相邻行或列组织在一起的功能,当分组完成后,用户可以通过折叠或展开数据组来简化数据视图,这篇博客将介绍如何使... 目录引言使用工具python在Excel中创建行和列分组Python在Excel中创建嵌套分组Pyt
阅读更多...
使用Python实现图片和base64转换工具

使用Python实现图片和base64转换工具

《使用Python实现图片和base64转换工具》这篇文章主要为大家详细介绍了如何使用Python中的base64模块编写一个工具,可以实现图片和Base64编码之间的转换,感兴趣的小伙伴可以了解下... 简介使用python的base64模块来实现图片和Base64编码之间的转换。可以将图片转换为Bas
阅读更多...
使用Java实现一个解析CURL脚本小工具

使用Java实现一个解析CURL脚本小工具

《使用Java实现一个解析CURL脚本小工具》文章介绍了如何使用Java实现一个解析CURL脚本的工具,该工具可以将CURL脚本中的Header解析为KVMap结构,获取URL路径、请求类型,解析UR... 目录使用示例实现原理具体实现CurlParserUtilCurlEntityICurlHandler
阅读更多...
Rsnapshot怎么用? 基于Rsync的强大Linux备份工具使用指南

Rsnapshot怎么用? 基于Rsync的强大Linux备份工具使用指南

《Rsnapshot怎么用?基于Rsync的强大Linux备份工具使用指南》Rsnapshot不仅可以备份本地文件，还能通过SSH备份远程文件，接下来详细介绍如何安装、配置和使用Rsnaps... Rsnapshot 是一款开源的文件系统快照工具。它结合了 Rsync 和 SSH 的能力，可以帮助你在 li
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2