node如何实现简单的脚手架浅析

 更新时间:2022年05月31日 09:15:19   作者:小跳蛙呀  
在工作中,需要开发一个脚手架,用于给相关用户提供相关的开发便利性,下面这篇文章主要给大家介绍了关于node如何实现简单的脚手架的相关资料,需要的朋友可以参考下

脚手架的实现原理无外乎:

通过命令行交互询问用户问题

根据用户的答案生成相应的项目结构

脚手架很多,比如特定语言封装好的脚手架集成方案:react-app,vue-cli,还有通用的脚手架工具Yeoman,包括项目内好用的模板生成工具plop等,今天我们来说一下用nodejs生成一个简单的脚手架

  • 首先创建文件夹,cd到当前文件夹,并且初始化一个package.json文件
 mkdir sample-saclfolding 
 cd sample-saclfolding 
 yarn init 
  • 在项目根目录下创建cli.js文件,并且在package.json中把cli.js设为入口文件

  • 在根目录下创造模板文件夹,并增加模板文件

  • node里面的命令行交互需要借助inquirer,在项目内安装inquirer
yarn add inquirer --dev

5.需要借助ejs渲染文件,在项目内安装ejs

yarn add ejs --dev

6.在cli.js里面增加脚手架执行的业务逻辑

#! /usr/bin/env node 
//头部必须加,用于指明这个脚本文件的解释程序,增加这一行是为了指定用node执行脚本文件

const inquirer = require('inquirer');
const path = require('path'); 
const ejs = require('ejs'); 
const fs = require('fs');
inquirer.prompt([ //inquirer.prompt方法命令行交互
    {
        type:'input', //方式:输入
        name:'name',  //得到data的key值为'name'
        message:'your project name' //询问用户的问题
    }
]).then(answer=>{ //answer为用户输入的最终结果,返回:{name:'你输入的答案'}
    const tmplDir=path.join(__dirname,'templates') //模板的路径
    const destDir=process.cwd(); //目标路径
    fs.readdir(tmplDir,((err, files) => { //fs.readdir读取路径文件夹里的所有文件
        if(err) throw err
        files.forEach((file)=>{ //循环文件夹内所有文件
            ejs.renderFile(path.join(tmplDir,file),answer, (err,result)=>{//根据文件渲染模板
                fs.writeFileSync(path.join(destDir,file),result)//根据 路径,内容 写入文件
            })
        })
    })
    )
})
  • 把模板文件内用到name的地方用<%= name %>替代

  • 在项目内运行以下命令,把定义好的脚手架链到全局。
yarn link
  • 新建文件夹,进入到新建的文件夹内,运行项目名命令可以生成文件模板,比如示例项目名为 sample-scaffolding,运行 sample-scaffolding即可
mkdir demo
cd demo
sample-scaffolding

10.输入name的值,则生成了模板文件。模板文件里的name为你输入的value

总结

到此这篇关于node如何实现简单脚手架的文章就介绍到这了,更多相关node实现脚手架内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • node.js中PC端微信小程序包解密的处理思路

    node.js中PC端微信小程序包解密的处理思路

    我们使用node.js去写一个解码的程序。根据上边加密的流程,我们首先读取加密文件,把前6个字节的固定字符串去除,这篇文章主要介绍了node.js中PC端微信小程序包解密,需要的朋友可以参考下
    2021-12-12
  • npm下载慢或下载失败问题解决的三种方法

    npm下载慢或下载失败问题解决的三种方法

    这篇文章主要为大家介绍了npm下载慢或下载失败问题解决的三种方法,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-07-07
  • 利用node实现一个批量重命名文件的函数

    利用node实现一个批量重命名文件的函数

    这篇文章主要给大家介绍了关于利用node实现一个批量重命名文件的函数的相关资料,文中通过示例示例代码介绍的非常详细,对大家学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧。
    2017-12-12
  • nodejs配置express服务器运行自动打开浏览器详细步骤

    nodejs配置express服务器运行自动打开浏览器详细步骤

    在nodejs中使用express来搭建框架可以说是非常的简单方便,下面这篇文章主要给大家介绍了关于nodejs配置express服务器运行自动打开浏览器的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2024-01-01
  • 详解NodeJs项目 CentOs linux服务器线上部署

    详解NodeJs项目 CentOs linux服务器线上部署

    这篇文章主要介绍了NodeJs项目 CentOs linux服务器线上部署,本文给大家介绍的非常详细,具有一定的参考借鉴价值,需要的朋友可以参考下
    2019-09-09
  • node.js使用net模块创建服务器和客户端示例【基于TCP协议】

    node.js使用net模块创建服务器和客户端示例【基于TCP协议】

    这篇文章主要介绍了node.js使用net模块创建服务器和客户端,结合实例形式分析了node.js使用net模块实现TCP客户端与服务器端通信的相关操作技巧,需要的朋友可以参考下
    2020-02-02
  • nodejs与浏览器中全局对象区别点总结

    nodejs与浏览器中全局对象区别点总结

    在本篇文章里小编给大家整理的是一篇关于nodejs与浏览器中全局对象区别点总结内容,对此有需要的朋友们可以学习下。
    2021-12-12
  • nvm管理node无法正常切换node版本问题的解决方法

    nvm管理node无法正常切换node版本问题的解决方法

    相信一定会有存在一些小伙伴 明明都已经按着操作卸载node 和安装nvm 了但是 依旧无法正常通过nvm管理node,本文将给大家介绍nvm管理node无法正常切换node版本问题的解决方法,需要的朋友可以参考下
    2024-01-01
  • Node.js开发静态资源服务器

    Node.js开发静态资源服务器

    这篇文章主要为大家介绍了Node.js开发静态资源服务器示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-08-08
  • 预防NodeJS命令注入的方法详解

    预防NodeJS命令注入的方法详解

    Node.js和npm为前端生态中提供了统一的开发语言、强大的包管理和模块生态系统、灵活的构建工具和任务自动化、以及丰富的前端框架和库等等,本文给大家介绍了如何预防NodeJS命令注入,文中有详细的代码讲解,需要的朋友可以参考下
    2023-12-12

最新评论