脚手架工作原理，及创建简单 脚手架

介绍

在启动脚手架之后会询问一些预设的问题，将回答的结果结合一些模版文件生成一个项目的结构

创建脚手架

cli应用

脚手架工具实际上就是一个node cli应用，创建脚手架 就是创建一个cli应用

mkdir sample-scaffolding

cd sample-scaffolding

yarn init

在package.json中添加bin属性，加一个入口 文件

{
  "name": "sample-scaffolding",
  "version": "1.0.0",
  "main": "index.js",
  "license": "MIT",
  "bin": "cli.js"
}

创建cli.js文件

cli与其他js文件不同的是需要加一个特定的文件头

// Node CLI 应用入口文件必须要有这样的文件头
// 如果是 Linux 或者 macOS 系统下还需要修改此文件的读写权限为 755
// 具体就是通过 chmod 755 cli.js 实现修改
console.log('cli working')

yarn link 链接到全局后，就可以使用sample-scaffolding命令会正常打印

命令行交互询问

yarn add inquirer

简单脚手架代码展示

#!/usr/bin/env node

// Node CLI 应用入口文件必须要有这样的文件头
// 如果是 Linux 或者 macOS 系统下还需要修改此文件的读写权限为 755
// 具体就是通过 chmod 755 cli.js 实现修改
console.log('cli working')

const inquirer = require('inquirer')
const path = require('path')
const fs = require('fs')
const ejs = require('ejs')
inquirer.prompt([
{
    type: 'input',
    // 返回的键
    name: 'name',
    message: 'Project Name?'
}
]).then(answers=>{
    console.log(answers)
    // 模版目录
    const templDir = path.join(__dirname,'templates')
    // 目标目录
    const destDir = process.cwd()

    fs.readdir(templDir,function(err,files){
        if(err) throw err
        files.forEach(file=>{
            // 通过模版引擎渲染文件
            ejs.renderFile(path.join(templDir,file),answers,(err, result)=>{
                if(err) throw err

                // 将结果写入目标文件路径
                fs.writeFileSync(path.join(destDir,file),result)
            })
        })
    })
})