Pourquoi un échafaudage est-il nécessaire ? Explication détaillée des étapes pour construire un échafaudage dans node-js tutoriel-php.cn

Pourquoi un échafaudage est-il nécessaire ? Comment construire un échafaudage ? L'article suivant présente les étapes de construction d'un échafaudage sur Node. J'espère qu'il sera utile à tout le monde !

Pourquoi un échafaudage est-il nécessaire ? Explication détaillée des étapes pour construire un échafaudage dans node

1 Pourquoi un échafaudage est nécessaire

Générez dynamiquement la structure du projet et les fichiers de configuration en fonction de l'interaction.
Les utilisateurs téléchargent différents modèles via l'interaction des commandes
Les modèles de projet personnalisés sont rendus par le moteur de modèles
Lorsque le modèle change, il vous suffit de mettre à jour le modèle et l'utilisateur n'a pas besoin de mettre à jour l'échafaudage [Recommandations du didacticiel associées : Tutoriel vidéo Nodejs, Enseignement de la programmation]

2 Étapes de construction

Créez un nouveau dossier mycli (le nom du fichier peut être personnalisé) et créez un nouveau bin ci-dessous, Créez un nouveau fichier bin appelé index.js Ce index.js est le fichier d'entrée Ajouter. à l'en-tête du fichier <code>index.js. #!/usr/bin/env node code mycli文件夹（可自定义文件名），下方新建bin文件，bin文件新建index.js,这个index.js就是入口文件，index.js文件头部加入#!/usr/bin/env node代码
生成package.json文件，此时会有个bin配置对象，key值即为全局脚手架名称，value是入口文件bin文件的index.js路径。

    npm init -y
    npm install

Copier après la connexion

将脚手架全局命令链接到全局，终端打印mycli即链接成功。

//命令可以将一个任意位置的npm包链接到全局执行环境，从而在任意位置使用命令行都可以直接运行该npm包。
npm link

Copier après la connexion

安装依赖

  npm install commander inquirer@8.2.5 download-git-repo chalk@4.1.2 ora@5.4.1 figlet handlebars

Copier après la connexion

commander：命令行工具，有了它我们就可以读取命令行命令，知道用户想要做什么了
inquirer：交互式命令行工具，给用户提供一个漂亮的界面和提出问题流的方式
download-git-repo：下载远程模板工具，负责下载远程仓库的模板项目
chalk：颜色插件，用来修改命令行输出样式，通过颜色区分 info、error 日志，清晰直观
ora：用于显示加载中的效果，类似于前端页面的 loading 效果，像下载模板这种耗时的操作，有了 loading 效果可以提示用户正在进行中，请耐心等待
figlet :镂空字体样式

注意：下方代码都放在bin文件`index.js`进行调试

2.1 commander.js概述

commander.js是一个工具，用来构建node的命令行程序，使得能够使用自定义指令在全局命令行运行node脚本。本来我们只能在脚本所在文件的根目录里通过node xxx.js运行脚本，通过commander构建命令行程序后，就能在任意一个目录里，比如桌面，比如用户目录，直接输入自定义的那个指令，就能直接运行脚本，更加简便。

#!/usr/bin/env node
//就是解决了不同的用户node路径不同的问题，可以让系统动态的去查找node来执行你的脚本文件。
//node.js内置了对命令行操作的支持，在 package.json 中的 bin 字段可以定义命令名和关联的执行文件。
const program = require("commander")
program.version(&#39;1.1.0&#39;)

function getFramwork (val) {
  console.log(val);
}

const myhelp = function (program) {
  program.option(&#39;-f --framwork <framwork>&#39;, &#39;设置框架&#39;, getFramwork)
}

const createProgress = function (program) {
  program.command(&#39;create <progress> [other...]&#39;)
    .alias(&#39;crt&#39;)
    .description(&#39;创建项目&#39;)
    .action((progress, arg) => {
      console.log(progress, arg);
    })
}
myhelp(program);
createProgress(program);
program.parse(process.argv)
// 补充
.parse()
// 作用就是解析，参数就是要解析的字符串，一般使用时参数就是用process.argv，就是用户输入参数

Copier après la connexion

执行全局命令mycli即可输出所有命令~~

Pourquoi un échafaudage est-il nécessaire ? Explication détaillée des étapes pour construire un échafaudage dans node

2.2 download-git-repo

download(repository, destination, options, callback)
repository：下载地址
destination：下载路径
options：配置项 {clone：true}
callback：下载后的回调

#!/usr/bin/env node
const download = require(&#39;download-git-repo&#39;);
download(&#39;direct:https://gitlab.com/flippidippi/download-git-repo-fixture.git&#39;, "xxx", { clone: true }, (err) => {
  console.log(err ? &#39;Error&#39; : &#39;Success&#39;)
})

Copier après la connexion

执行mycli即可看到文件下生成一个xxx文件

Pourquoi un échafaudage est-il nécessaire ? Explication détaillée des étapes pour construire un échafaudage dans node

2.3 Inquirer（命令交互）

inquirer 是一个常用的交互式终端用户界面集合。简单来说 inquirer 是可以让我们很方便的做各种终端交互行为的一个库。

inquirer 主要提供了三个方法方便我们注册问题

prompt(questions) => promise该方法就是终端交互的核心方法，运行 prompt 方法即告诉终端启动交互式命令界面。 - prompt 方法需要传入一个 questions 数组, questions 数组包含对象形式的各个 question. question 的具体结构字段含义在后文介绍。 - prompt 方法的返回值是一个 promise 对象，promise.then 接收的返回值是 answers 对象，answers 对象包含前面所有问题回答的数据结果。

#!/usr/bin/env node
const inquirer = require("inquirer")
function getUsername() {
  return inquirer
    .prompt([
      {
        type: "input",
        name: "progress",
        message: "请输入项目名称",
        default: "progress",
        filter(input) {
          return input.trim()
        },
        validate(input) {
          return input.length > 0
        },
      },
    ])
    .then((answer) => {
      console.log(answer)
    })
}
function getFramework() {
  return inquirer
    .prompt([
      {
        type: "list",
        name: "framework",
        choices: [
          "express",
          new inquirer.Separator(),
          "koa",
          new inquirer.Separator(),
          "egg",
        ],
        message: "请选择你所使用的框架",
      },
    ])
    .then((answer) => {
      console.log(answer)
    })
}

function getSelect() {
  return inquirer
    .prompt([
      {
        type: "checkbox",
        name: "userndasde",
        choices: [
          { name: "pr", disabled: true },
          { name: "oa", checked: true },
          "gg",
        ],
        message: "需要的验证格式",
        // default: ["oa"],
      },
    ])
    .then((answer) => {
      console.log(answer)
    })
}
async function init() {
  await getSelect()
  await getUsername()
  await getFramework()
}
init()

Copier après la connexion

2.4 ora and chalk(美化)

在用户输入答案之后，开始下载模板，这时候使用 ora 来提示用户正在下载中。

注意：注意版本不同引入方式不同，这里用ora(版本5.4.1) ，chalk

🎜🎜 génère le package.json À ce stade, il y aura un objet de configuration bin. La valeur clé est le nom global de l'échafaudage et la valeur est le chemin index.js du fichier bin du fichier d'entrée. 🎜🎜🎜

const ora = require("ora")
const chalk = require("chalk")
const spinner = ora("Loading unicorns").start()
spinner.text = chalk.blue("下载中~~~~~~")
setTimeout(() => {
  spinner.succeed(chalk.red("下载成功!"))
  spinner.fail("下载失败!")
  spinner.warn("警告！")
}, 2000)

Copier après la connexion

🎜

🎜🎜🎜 🎜Liez la commande globale d'échafaudage à la commande globale Si le terminal imprime mycli, le lien est réussi. 🎜

const figlet = require("figlet")
const chalk = require("chalk")
//简单函数
function handleAsync(params) {
  const JAVASCRIPT = figlet.textSync(
    "NODEJS",
    {
      font: "big",
      horizontalLayout: "fitted",
      verticalLayout: "controlled smushing",
      width: 600,
      whitespaceBreak: true,
    },
    function (err, data) {
      if (err) {
        console.log("Something went wrong...")
        console.dir(err)
        return
      }
      console.log(data)
    }
  )

  console.log(chalk.blue.bold(JAVASCRIPT))
}
handleAsync()

Copier après la connexion

🎜🎜🎜Dépendances d'installation🎜🎜🎜

#!/usr/bin/env node
console.log("adas");
require("../lib/commander/index.js")

Copier après la connexion

🎜🎜commander : outil de ligne de commande, avec lequel nous pouvons lire les commandes de ligne de commande et savoir ce que l'utilisateur veut faire🎜🎜

 demandeur</ code> : Un outil de ligne de commande interactif qui offre aux utilisateurs une belle interface et un moyen de soulever des questions🎜🎜<code>download-git-repo

: Téléchargez l'outil de modèle à distance, responsable du téléchargement des entrepôts distants. Projet de modèle 🎜🎜 chalk : plug-in de couleur, utilisé pour modifier le style de sortie de la ligne de commande, distinguer les informations et les journaux d'erreurs grâce à la couleur, clair et intuitif 🎜🎜ora : utilisé pour afficher le chargement L'effet est similaire à l'effet de chargement de la page frontale. Pour les opérations fastidieuses telles que le téléchargement de modèles, l'effet de chargement peut rappeler à l'utilisateur qu'il est en cours. Veuillez patienter🎜🎜figlet. : style de police creux🎜 🎜

Remarque : Le code ci-dessous est placé dans le fichier bin `index.js` pour le débogage

2.1 Présentation de commander.js

🎜commander.js est un outil utilisé pour créer le programme de ligne de commande d'un nœud, permettant l'utilisation d'instructions personnalisées pour exécuter des scripts de nœud sur la ligne de commande globale. À l'origine, nous ne pouvions exécuter le script que via node xxx.js dans le répertoire racine du fichier où se trouve le script. Après avoir construit le programme en ligne de commande via Commander, nous pouvons l'exécuter dans n'importe quel répertoire. comme le bureau, comme le répertoire utilisateur, entrez simplement la commande personnalisée directement pour exécuter le script directement, ce qui est plus simple. 🎜

const program = require("commander")
const init = require(&#39;../inquirer/index&#39;);
const downloadFun = require("../core/download.js");
program.version(&#39;1.1.0&#39;)
function getFramwork (val) {
  console.log(val);
}
const myhelp = function (program) {
  program.option(&#39;-f --framwork <framork> [other...]&#39;, &#39;设置框架&#39;, getFramwork)
}
const createProgress = function (program) {
  program.command(&#39;create <progress> [other...]&#39;)
    .alias(&#39;crt&#39;)
    .description(&#39;创建项目&#39;)
    .action((progress, arg) => {
      init();
    })
}
const downloadUrl = function (program) {
  program.command(&#39;download <url> [...other]&#39;)
    .description(&#39;下载内容&#39;)
    .action((url, ...args) => {
      console.log(args);
      downloadFun(url, args[1].args[1])
    })
}
myhelp(program);
downloadUrl(program);
createProgress(program)
program.parse(process.argv)

Copier après la connexion

🎜Exécutez la commande globale mycli pour afficher toutes les commandes~~🎜🎜 Pourquoi un échafaudage est-il nécessaire ? Explication détaillée des étapes pour construire un échafaudage dans node

Pourquoi un échafaudage est-il nécessaire ? Explication détaillée des étapes pour construire un échafaudage dans node

🎜

2.2 download-git-repo

🎜🎜télécharger</code >(dépôt, destination, options, rappel)🎜🎜<code>dépôt : adresse de téléchargement🎜🎜destination : chemin de téléchargement🎜🎜options : élément de configuration { clone: true}🎜🎜callback : rappel après téléchargement🎜🎜

const fs = require(&#39;fs&#39;);
const path = require("path");
const handlebars = require("handlebars");
  function modifyPackageJson (options) {
    let downloadPath = options.projectName;
    const packagePath = path.join(downloadPath, &#39;package.json&#39;);
    console.log(packagePath, "packagePath");
    
    //判断是否存在package.json文件
    if (fs.existsSync(packagePath)) {
      let content = fs.readFileSync(packagePath).toString();
      
      //判断是否选择了eslint
      if (options.isIslint) {
        let targetContent = JSON.parse(content);
        content = JSON.stringify(targetContent);
        targetContent.dependencies.eslint = "^1.0.0";
        console.log("content", content);
      }
      
      //写入模板
      const template = handlebars.compile(content);
      const param = { name: options.projectName };
      const result = template(param);
      
      //重新写入package.json文件
      fs.writeFileSync(packagePath, result);
      console.log(&#39;modify package.json complate&#39;);
    } else {
      throw new Error(&#39;no package.json&#39;);
    }
  }
  module.exports = modifyPackageJson

Copier après la connexion

🎜Exécutez mycli et vous verrez un fichier xxx généré sous le fichier🎜 🎜 Pourquoi un échafaudage est-il nécessaire ? Explication détaillée des étapes pour construire un échafaudage dans node

🎜< h4 data -id="heading-5">2.3 Inquirer (interaction avec les commandes)🎜🎜inquirer🎜 est une collection d'interfaces utilisateur de terminaux interactifs couramment utilisées. En termes simples, 🎜inquirer🎜 est une bibliothèque qui nous permet d'effectuer facilement divers comportements interactifs de terminal. 🎜🎜inquirer fournit principalement trois méthodes pour nous faciliter l'enregistrement des questions🎜🎜🎜🎜prompt(questions) => promise🎜Cette méthode est la méthode principale de l'interaction du terminal. L'exécution de la méthode prompt indique au terminal de démarrer l'interface de commande interactive. - La méthode prompt doit passer dans un tableau 🎜questions🎜. Le tableau questions contient chaque question sous forme d'objets. La signification des champs de structure spécifiques de la question sera présentée plus tard. - La valeur de retour de la méthode prompt est un objet de promesse, et la valeur de retour reçue par promise.then est l'objet 🎜answers🎜. L'objet de réponses contient les résultats des données des réponses à toutes les questions précédentes. 🎜🎜

  const download = require(&#39;download-git-repo&#39;);
  const ora = require("ora");
  const chalk = require("chalk");
  const figlet = require("figlet");
  const modifyPackageJson = require("./action")
  
  function handleAsync (params) {
    const JAVASCRIPT = figlet.textSync(&#39;JAVASCRIPT&#39;, {
      font: &#39;big&#39;,
      horizontalLayout: &#39;fitted&#39;,
      verticalLayout: &#39;controlled smushing&#39;,
      width: 600,
      whitespaceBreak: true
    }, function (err, data) {
      if (err) {
        console.log(&#39;Something went wrong...&#39;);
        console.dir(err);
        return;
      }
      console.log(data);
    });
    console.log(chalk.blue.bold(JAVASCRIPT));
  }
  
  const downloadFun = (url, option) => {
    const spinner = ora("Loading unicorns").start()
    spinner.text = chalk.blue("下载中");
    
    download(url, option.projectName, { clone: true }, function (err) {
      if (err) {
        spinner.fail("下载失败!");
        handleAsync()
      } else {
        spinner.succeed(chalk.red("下载成功!"))
        console.log(chalk.blue(`cd ${option.projectName}`))
        console.log(chalk.red("npm install"))
        console.log(chalk.yellow(`npm run dev`))
        modifyPackageJson(option)
        handleAsync()
      }
    })
  }
  module.exports = downloadFun;

Copier après la connexion

2.4 ora et craie (embellissement)

🎜Une fois que l'utilisateur a saisi la réponse, le modèle commence à télécharger. À ce moment, utilisez

ora<. /code> pour inviter l'utilisateur à télécharger. 🎜🎜Remarque : Notez que différentes versions ont des méthodes d'introduction différentes. Ici, nous utilisons <code>ora

(version 5.4.1), chalk (version 4.1.2)🎜

const ora = require("ora")
const chalk = require("chalk")
const spinner = ora("Loading unicorns").start()
spinner.text = chalk.blue("下载中~~~~~~")
setTimeout(() => {
  spinner.succeed(chalk.red("下载成功!"))
  spinner.fail("下载失败!")
  spinner.warn("警告！")
}, 2000)

Copier après la connexion

2.5 figlet(镂空文字)

镂空文字调试器地址：地址

figlet旨在完全实现JavaScript中的FIGfont规范。它可以在浏览器和Node.js中工作。

用法

`figlet.text( description,{options},callback(err,data){}) 这个是异步的会被`

参数

description：需要格式化的字符串
options：参数配置
- Font：字体，Default value:Standard；
- horizontalLayout：布局，Default value:default; Values:{default,full,fitted};
- verticalLayout:垂直布局, Default value:default; Values:{defalut,full,fitted,controlled smushing,universal smushing};
- Width:宽度;
- whitespaceBreak:换行(Boolean); Default value:false
callback(err,data):回调

const figlet = require("figlet")
const chalk = require("chalk")
//简单函数
function handleAsync(params) {
  const JAVASCRIPT = figlet.textSync(
    "NODEJS",
    {
      font: "big",
      horizontalLayout: "fitted",
      verticalLayout: "controlled smushing",
      width: 600,
      whitespaceBreak: true,
    },
    function (err, data) {
      if (err) {
        console.log("Something went wrong...")
        console.dir(err)
        return
      }
      console.log(data)
    }
  )

  console.log(chalk.blue.bold(JAVASCRIPT))
}
handleAsync()

Copier après la connexion

Pourquoi un échafaudage est-il nécessaire ? Explication détaillée des étapes pour construire un échafaudage dans node

总结

创建一个完整的脚手架

目录结构：

bin/index.js

#!/usr/bin/env node
console.log("adas");
require("../lib/commander/index.js")

Copier après la connexion

lib/commonder/index.js

const program = require("commander")
const init = require(&#39;../inquirer/index&#39;);
const downloadFun = require("../core/download.js");
program.version(&#39;1.1.0&#39;)
function getFramwork (val) {
  console.log(val);
}
const myhelp = function (program) {
  program.option(&#39;-f --framwork <framork> [other...]&#39;, &#39;设置框架&#39;, getFramwork)
}
const createProgress = function (program) {
  program.command(&#39;create <progress> [other...]&#39;)
    .alias(&#39;crt&#39;)
    .description(&#39;创建项目&#39;)
    .action((progress, arg) => {
      init();
    })
}
const downloadUrl = function (program) {
  program.command(&#39;download <url> [...other]&#39;)
    .description(&#39;下载内容&#39;)
    .action((url, ...args) => {
      console.log(args);
      downloadFun(url, args[1].args[1])
    })
}
myhelp(program);
downloadUrl(program);
createProgress(program)
program.parse(process.argv)

Copier après la connexion

lib/core/action.js (package.json重写)

const fs = require(&#39;fs&#39;);
const path = require("path");
const handlebars = require("handlebars");
  function modifyPackageJson (options) {
    let downloadPath = options.projectName;
    const packagePath = path.join(downloadPath, &#39;package.json&#39;);
    console.log(packagePath, "packagePath");
    
    //判断是否存在package.json文件
    if (fs.existsSync(packagePath)) {
      let content = fs.readFileSync(packagePath).toString();
      
      //判断是否选择了eslint
      if (options.isIslint) {
        let targetContent = JSON.parse(content);
        content = JSON.stringify(targetContent);
        targetContent.dependencies.eslint = "^1.0.0";
        console.log("content", content);
      }
      
      //写入模板
      const template = handlebars.compile(content);
      const param = { name: options.projectName };
      const result = template(param);
      
      //重新写入package.json文件
      fs.writeFileSync(packagePath, result);
      console.log(&#39;modify package.json complate&#39;);
    } else {
      throw new Error(&#39;no package.json&#39;);
    }
  }
  module.exports = modifyPackageJson

Copier après la connexion

lib/core/download.js

  const download = require(&#39;download-git-repo&#39;);
  const ora = require("ora");
  const chalk = require("chalk");
  const figlet = require("figlet");
  const modifyPackageJson = require("./action")
  
  function handleAsync (params) {
    const JAVASCRIPT = figlet.textSync(&#39;JAVASCRIPT&#39;, {
      font: &#39;big&#39;,
      horizontalLayout: &#39;fitted&#39;,
      verticalLayout: &#39;controlled smushing&#39;,
      width: 600,
      whitespaceBreak: true
    }, function (err, data) {
      if (err) {
        console.log(&#39;Something went wrong...&#39;);
        console.dir(err);
        return;
      }
      console.log(data);
    });
    console.log(chalk.blue.bold(JAVASCRIPT));
  }
  
  const downloadFun = (url, option) => {
    const spinner = ora("Loading unicorns").start()
    spinner.text = chalk.blue("下载中");
    
    download(url, option.projectName, { clone: true }, function (err) {
      if (err) {
        spinner.fail("下载失败!");
        handleAsync()
      } else {
        spinner.succeed(chalk.red("下载成功!"))
        console.log(chalk.blue(`cd ${option.projectName}`))
        console.log(chalk.red("npm install"))
        console.log(chalk.yellow(`npm run dev`))
        modifyPackageJson(option)
        handleAsync()
      }
    })
  }
  module.exports = downloadFun;

Copier après la connexion

inquire/index.js 注意frameworkConfig写自己的gitlab仓库地址

  const inquirer = require("inquirer");
  const downloadFun = require("../core/download.js");
  const frameworkConfig = {
    front: "https://gitlab.com/flippidippi/download-git-repo-fixture.git",
    manager: "https://gitlab.com/flippidippi/download-git-repo-fixture.git"
  }
  const config = {};
  
  function getFramework () {
    return inquirer.prompt([
      {
        type: &#39;list&#39;,
        name: &#39;framework&#39;,
        choices: ["front", "manager"],
        message: "请选择你所使用的框架"
      }
    ]).then((answer) => {
      return answer.framework;
    })
  }
  
  function getProjectName () {
    return inquirer.prompt([
      {
        type: &#39;input&#39;,
        name: &#39;projectName&#39;,
        message: &#39;项目名称&#39;,
        filter (input) {
          return input.trim();
        },
      }
    ]).then((answer) => {
      console.log(answer, "FDsfs");
      return answer.projectName;
    })
  }
  
  function getIsEslint () {
    return inquirer.prompt([
      {
        type: &#39;confirm&#39;,
        name: &#39;isIslint&#39;,
        message: &#39;是否使用eslint校验格式?&#39;
      }
    ]).then((answer) => {
      return answer.isIslint;
    })
  }
  
  async function init () {
    config.projectName = await getProjectName();
    config.framework = await getFramework();
    config.isIslint = await getIsEslint();
    let url = config.framework == "front" ? frameworkConfig.front : frameworkConfig.manager;
    downloadFun("direct:" + url, config);
  }
  module.exports = init;

Copier après la connexion

更多node相关知识，请访问：nodejs 教程！

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!