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。

相关文章

Python使用Turtle实现精确计时工具

Python使用Turtle实现精确计时工具

《Python使用Turtle实现精确计时工具》这篇文章主要为大家详细介绍了Python如何使用Turtle实现精确计时工具,文中的示例代码讲解详细,具有一定的借鉴价值,有需要的小伙伴可以参考一下... 目录功能特点使用方法程序架构设计代码详解窗口和画笔创建时间和状态显示更新计时器控制逻辑计时器重置功能事件
阅读更多...
利用Python实现Excel文件智能合并工具

利用Python实现Excel文件智能合并工具

《利用Python实现Excel文件智能合并工具》有时候,我们需要将多个Excel文件按照特定顺序合并成一个文件,这样可以更方便地进行后续的数据处理和分析,下面我们看看如何使用Python实现Exce... 目录运行结果为什么需要这个工具技术实现工具的核心功能代码解析使用示例工具优化与扩展有时候，我们需要将
阅读更多...
Python+PyQt5实现文件夹结构映射工具

Python+PyQt5实现文件夹结构映射工具

《Python+PyQt5实现文件夹结构映射工具》在日常工作中,我们经常需要对文件夹结构进行复制和备份,本文将带来一款基于PyQt5开发的文件夹结构映射工具,感兴趣的小伙伴可以跟随小编一起学习一下... 目录概述功能亮点展示效果软件使用步骤代码解析1. 主窗口设计（FolderCopyApp）2. 拖拽路径
阅读更多...
MySQL Workbench工具导出导入数据库方式

MySQL Workbench工具导出导入数据库方式

《MySQLWorkbench工具导出导入数据库方式》：本文主要介绍MySQLWorkbench工具导出导入数据库方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝... 目录mysql Workbench工具导出导入数据库第一步 www.chinasem.cn数据库导出第二步
阅读更多...
重新对Java的类加载器的学习方式

重新对Java的类加载器的学习方式

《重新对Java的类加载器的学习方式》：本文主要介绍重新对Java的类加载器的学习方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录1、介绍1.1、简介1.2、符号引用和直接引用1、符号引用2、直接引用3、符号转直接的过程2、加载流程3、类加载的分类3.1、显示
阅读更多...
Spring Validation中9个数据校验工具使用指南

Spring Validation中9个数据校验工具使用指南

《SpringValidation中9个数据校验工具使用指南》SpringValidation作为Spring生态系统的重要组成部分,提供了一套强大而灵活的数据校验机制,本文给大家介绍了Spring... 目录1. Bean Validation基础注解常用注解示例在控制器中应用2. 自定义约束验证器定义自
阅读更多...
VSCode中配置node.js的实现示例

VSCode中配置node.js的实现示例

《VSCode中配置node.js的实现示例》本文主要介绍了VSCode中配置node.js的实现示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着... 目录一.node.js下载安装教程二.配置npm三.配置环境变量四.VSCode配置五.心得一.no
阅读更多...
Linux系统调试之ltrace工具使用与调试过程

Linux系统调试之ltrace工具使用与调试过程

《Linux系统调试之ltrace工具使用与调试过程》：本文主要介绍Linux系统调试之ltrace工具使用与调试过程,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐... 目录一、ltrace 定义与作用二、ltrace 工作原理1. 劫持进程的 PLT/GOT 表2. 重定
阅读更多...
Java 如何创建和使用ExecutorService

Java 如何创建和使用ExecutorService

《Java如何创建和使用ExecutorService》ExecutorService是Java中用来管理和执行多线程任务的一种高级工具,可以有效地管理线程的生命周期和任务的执行过程,特别是在需要处... 目录一、什么是ExecutorService？二、ExecutorService的核心功能三、如何创建
阅读更多...
使用Java编写一个字符脱敏工具类

使用Java编写一个字符脱敏工具类

《使用Java编写一个字符脱敏工具类》这篇文章主要为大家详细介绍了如何使用Java编写一个字符脱敏工具类,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录1、字符脱敏工具类2、测试工具类3、测试结果1、字符脱敏工具类import lombok.extern.slf4j.Slf4j
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2