前端脚手架搭建(part 1)
创始人
2024-05-30 02:33:23
0

本篇主要介绍如何搭建前端脚手架,一步一步地实现通过搭建的脚手架下载对应的项目模板。

通过脚手架的创建,可以快速搭建项目的基础配置和模板,在部门项目开发的规范中尤其总要。

  1. 初始化项目:

创建一个文件夹,命名随便(自己自定义),这里我就命名为mfex-project,

然后在终端执行命令,初始化生成package.json

npm init -y

在文件夹下创建一个bin文件夹,在bin文件夹下面在创建一个index.js文件,如图所示

在index.js第一行加上这句话#! /usr/bin/env node,就是用node来执行此文件

在package.json中添加命令配置,这里命令为mfex-cli,可以自定义,添加"type":"module",

避免node版本带来的插件引入方式问题

npm link,讲这个npm包挂着在全局执行环境中

执行看看效果

  1. 读取用户命令行信息

需要用到commander,用来解析读取用户命令行中输入内容,commander文档

安装commander

npm i commander

主要用到以下api:

command():定义命令名字
action():注册callback函数
parse():解析命令行参数args

在index.js中开始编写读取用户输入命令的逻辑

import { program } from 'commander';
program.command('create ').action((projectName) => {console.log(`项目名${projectName}`);})
program.parse(process.args)

输入命令npx mfex-project create mfexdemo

3、拉取项目模板

需要用到download-git-repo,文档

npm install download-git-repo
#! /usr/bin/env nodeimport { program } from 'commander';
import downLoad from 'download-git-repo'
import path from 'path'program.command('create ').action((projectName) => {console.log(`项目名${projectName}`);//项目git地址const demoGitUrl = 'https://gitee.com/Hehanjian/vue-vite-template';//当前目录const targetDir = path.join(process.cwd(), projectName)downLoad(`direct:${demoGitUrl}`, targetDir, { clone: true }, (err) => {if (err) {console.log('获取模版失败')} else {console.log('获取模版成功!')}})})
program.parse(process.args)

在命令行上输入npx mfex-project create mfexdemo

项目创建成功

现在项目模板是写死一个的,下面做成可以自主选择,需要用到inquirer,可以加强对命令行的交互,inquirer文档

npm install inquirer

提供2个模板创建选择,vue和react

#! /usr/bin/env nodeimport { program } from 'commander';
import downLoad from 'download-git-repo'
import path from 'path'
import inquirer from 'inquirer'
const questionList = [{"name": "features", // 选项名称"message": "请选择要创建的项目模板", // 选项提示语"type": "list", // 选项类型 另外还有 confirm check 等"choices": [{"name": "vue","value": "vue","description": "vue3+vite+ts","link": "https://gitee.com/Hehanjian/vue-vite-template"},{"name": "react","value": "react","description": "react+vite+ts","link": "https://gitee.com/Hehanjian/react-vite-template"}]},]program.command('create ').action((projectName) => {console.log(`项目名${projectName}`);//项目git地址// const demoGitUrl = 'https://gitee.com/Hehanjian/vue-vite-template';//当前目录const targetDir = path.join(process.cwd(), projectName)inquirer.prompt(questionList).then(res=>{//获取选择的是那个choiceconst project = questionList[0].choices.find(item=>item.value === res.features)downLoad(`direct:${project.link}`, targetDir, { clone: true }, (err) => {if (err) {console.log('获取模版失败')} else {console.log('获取模版成功!')}})})})
program.parse(process.args)

执行命令npx mfex-project create mfex-vue,回车

项目创建成功

4、美化字体颜色和图标

安装2个插件,ora:设置图标,chalk:设置字体颜色

npm install ora chalk
#! /usr/bin/env nodeimport { program } from 'commander';
import downLoad from 'download-git-repo'
import path from 'path'
import inquirer from 'inquirer'
import ora from 'ora';
import chalk from 'chalk';
const questionList = [{"name": "features", // 选项名称"message": "请选择要创建的项目模板", // 选项提示语"type": "list", // 选项类型 另外还有 confirm check 等"choices": [{"name": "vue","value": "vue","description": "vue3+vite+ts","link": "https://gitee.com/Hehanjian/vue-vite-template"},{"name": "react","value": "react","description": "react+vite+ts","link": "https://gitee.com/Hehanjian/react-vite-template"}]},]const spinner = ora('模版资源下载中 ...')
program.command('create ').action((projectName) => {console.log(`项目名${projectName}`);//项目git地址//当前目录const targetDir = path.join(process.cwd(), projectName)inquirer.prompt(questionList).then(res => {//获取选择的是那个choiceconst project = questionList[0].choices.find(item => item.value === res.features)downLoad(`direct:${project.link}`, targetDir, { clone: true }, (err) => {if (err) {spinner.fail()console.log(chalk.red('获取模版失败'))} else {spinner.succeed()console.log(chalk.green('获取模版成功!'))}spinner.stop()})})})
program.parse(process.args)

运行结果如下

相关内容

热门资讯

前端-session、jwt 目录:   (1)session (2&#x...
linux入门---制作进度条 了解缓冲区 我们首先来看看下面的操作: 我们首先创建了一个文件并在这个文件里面添加了...
关于测试,我发现了哪些新大陆 关于测试 平常也只是听说过一些关于测试的术语,但并没有使用过测试工具。偶然看到编程老师...
前缀和与对数器与二分法 1. 前缀和 假设有一个数组,我们想大量频繁的去访问L到R这个区间的和,...
nodejs:本地安装nvm实... 一、背景-使用不同版本node的原因 vue3+ts、nuxt3版本,node...
JAVA集合知识整理 Java集合知识整理 HashMap相关 HashMap的底层数据结构:jdk1.8之...
无刷直流电机介绍及单片机控制实... 无刷直流电机介绍及单片机控制实例前言基本概念优势与劣势使用寿命基本结构使用单片机控制实例电子调速器&...
fwdiary(2) dp2 1.传纸条  AcWing 275. 传纸条 - AcWing 走两条路,走一条最大的...
常用的DOS命令 常用的DOS命令 DOS(Disk Operating System,磁...
<C++> 类和对象(下) 1.const成员函数将const修饰的“成员函数”称之为const成员函数,cons...