@wjc0210/js-plugin-cli/lib/init.js

A lightweight javascript plugin CLI.

// 请求 fs-extra 库，用于文件操作
const fse = require('fs-extra')
// 请求 ora 库，用于初始化项目时等待动画
const ora = require('ora')
// 请求 chalk 库
const chalk = require('chalk')
// 请求 log-symbols 库
const symbols = require('log-symbols')
// 请求 inquirer 库，用于控制台交互
const inquirer = require('inquirer')
// 请求 handlebars 库，用于替换模板字符
const handlebars = require('handlebars')

const path = require('path')

// 请求 download.js 文件，模板不在本地时执行该操作
const dlTemplate = require('./download')

async function initProject(projectName) {
	try {
		const exists = await fse.pathExists(projectName)
		if (exists) {
        	// 项目重名时提醒用户
			console.log(symbols.error, chalk.red('The project already exists.'))
		} else {
        	// 执行控制台交互
			inquirer
				.prompt([
					{
						type: 'input', // 类型，其他类型看官方文档
						name: 'name',  // 名称，用来索引当前 name 的值
						message: 'Set a global name for javascript plugin?',
						default: 'Default',  // 默认值，用户不输入时用此值
					},
				])
				.then(async (answers) => {
                	// Spinner 初始设置
					const initSpinner = ora(chalk.cyan('Initializing project...'))
                    // 开始执行等待动画
					initSpinner.start()
                    
					// 拼接 template 文件夹路径
					const templatePath = path.resolve(__dirname, '../template/')
                    // 返回 Node.js 进程的当前工作目录
					const processPath = process.cwd()
                    // 把项目名转小写
					const LCProjectName = projectName.toLowerCase()
                    // 拼接项目完整路径
					const targetPath = `${processPath}/${LCProjectName}`
                    
					// 先判断模板路径是否存在
					const exists = await fse.pathExists(templatePath)
					if (!exists) {
                    	// 不存在时，就先等待下载模板，下载完再执行下面的语句
						await dlTemplate()
					}
                    
                    // 等待复制好模板文件到对应路径去
         			try {
						await fse.copy(templatePath, targetPath)
					} catch (err) {
						console.log(symbols.error, chalk.red(`Copy template failed. ${err}`))
						process.exit()
					}
                    
          			// 把要替换的模板字符准备好
                    const multiMeta = {
                      project_name: LCProjectName,
                      global_name: answers.name
                    }
                    // 把要替换的文件准备好
                    const multiFiles = [
                      `${targetPath}/package.json`,
                      `${targetPath}/gulpfile.js`,
                      `${targetPath}/test/index.html`,
                      `${targetPath}/src/index.js`
                    ]
                    
					// 用条件循环把模板字符替换到文件去
                    for (var i = 0;i < multiFiles.length;i++){
                    	// 这里记得 try {} catch {} 哦，以便出错时可以终止掉 Spinner
                        try {
                        	// 等待读取文件
                            const multiFilesContent = await fse.readFile(multiFiles[i], 'utf8')
                            // 等待替换文件，handlebars.compile(原文件内容)(模板字符)
                            const multiFilesResult = await handlebars.compile(multiFilesContent)(multiMeta)
                            // 等待输出文件
                            await fse.outputFile(multiFiles[i], multiFilesResult)
                        } catch (err) {
                        	// 如果出错，Spinner 就改变文字信息
                            initSpinner.text = chalk.red(`Initialize project failed. ${err}`)
                            // 终止等待动画并显示 X 标志
                            initSpinner.fail()
                            // 退出进程
                            process.exit()
                        }
                    }
                    
					// 如果成功，Spinner 就改变文字信息
					initSpinner.text = 'Initialize project successful.'
                    // 终止等待动画并显示 ✔ 标志
					initSpinner.succeed()
                    console.log(`To get started:
    	                cd ${chalk.yellow(LCProjectName)}
	                    ${chalk.yellow('npm install')} or ${chalk.yellow('yarn install')}
	                    ${chalk.yellow('npm run dev')} or ${chalk.yellow('yarn run dev')}
					`)
				})
				.catch((error) => {
					if (error.isTtyError) {
						console.log(symbols.error,chalk.red("Prompt couldn't be rendered in the current environment."))
					} else {
						console.log(symbols.error, chalk.red(error))
					}
				})
		}
	} catch (err) {
		console.error(err)
		process.exit()
	}
}

// 将上面的 initProject(projectName) 方法导出
module.exports = initProject