『手撕Vue-CLI』自动安装依赖

vue,cli · 浏览次数 : 4

小编点评

本文将深入探讨如何在 Node.js 项目中自动安装依赖。首先,介绍了 shelljs 库,它是一个轻量级、简单易用且兼容多平台的 Node.js 模块,可用于执行 Unix shell 命令。接着,展示了如何在 nue-cli 项目中使用 shelljs 实现自动安装依赖的功能。最后,通过测试验证了该功能的有效性。 1. **shelljs 库介绍**: - 轻量级:可在 Node.js 环境中运行。 - 简单易用:提供了一组简单的 Unix shell 命令。 - 跨平台:适用于 Windows、Linux 和 macOS 等操作系统。 - 兼容性好:兼容大多数 Unix shell 命令。 - 开源:可在 GitHub 上查看源代码。 - 社区活跃:有一个活跃的社区可以提交问题和建议。 - 文档齐全:提供了详细的文档帮助开发者快速上手。 - 安装方便:可通过 npm 安装。 2. **在 nue-cli 项目中使用 shelljs**: - 引入 shelljs 模块。 - 在 bin\\create.js 文件中添加安装依赖的代码。 - 定义一个名为 installDependencies 的方法,调用 shelljs 的 exec 方法执行 npm install 命令。 - 在 create.js 的主流程中调用 installDependencies 方法。 3. **实现自动安装依赖**: - 将安装依赖的代码封装成一个 async 方法。 - 在 installDependencies 方法中加入进入模板根目录的逻辑,并传递模板名称作为参数。 - 使用 promisify 方法将 exec 方法转换为同步方法。 4. **测试自动安装依赖功能**: - 注释掉之前的测试代码。 - 只执行 installDependencies 方法。 - 准备动图(gif)作为演示。 - 录制过程中遇到问题,将在后续文章中探索解决方案。 总的来说,本文展示了如何在 Node.js 项目中使用 shelljs 库自动安装依赖,以提高项目的智能化水平。通过深入探讨核心实现细节,并通过实际测试验证了该功能的有效性。

正文

开篇

经过『手撕Vue-CLI』拷贝模板,实现了自动下载并复制指定模板到目标目录。然而,虽然项目已复制,但其依赖并未自动安装,可能需要用户手动操作,这并不够智能。

正如前文所述,我们已经了解了业务需求和背景。那么,接下来我们将直接深入探讨核心实现细节。

自动安装依赖

在前文中,我们已经将模板文件复制到了指定目录。接下来,我们需要在该目录下执行 npm install 命令,以自动安装依赖。

如何安装依赖?

我们平时咋安装依赖的?对,就是在项目目录下执行 npm install 命令。那么,我们如何在 Node.js 中执行这个命令呢?

在写这篇文章之前,我在自己实现的过程中,也是遇到了这个问题。我查阅了很多资料,最终找到了一个解决方案,那就是使用 shelljs 库。

所以先来给大家简单介绍一下 shelljs

shelljs

shelljs 是一个 Node.js 模块,它提供了一组简单的 Unix shell 命令,可以用于执行 shell 脚本。它是一个轻量级的模块,可以在 Node.js 环境中运行。

shelljs 的主要特点如下:

  • 轻量级:shelljs 是一个轻量级的模块,可以在 Node.js 环境中运行。
  • 简单易用:shelljs 提供了一组简单的 Unix shell 命令,可以用于执行 shell 脚本。
  • 跨平台:shelljs 可以在 Windows、Linux 和 macOS 等操作系统上运行。
  • 兼容性好:shelljs 兼容大多数 Unix shell 命令,可以方便地在 Node.js 环境中使用。
  • 开源:shelljs 是一个开源项目,可以在 GitHub 上查看源代码。
  • 社区活跃:shelljs 有一个活跃的社区,可以在 GitHub 上提交问题和建议。
  • 文档齐全:shelljs 有详细的文档,可以帮助开发者快速上手。
  • 安装方便:shelljs 可以通过 npm 安装,非常方便。
  • 使用方便:shelljs 提供了一组简单的 API,可以方便地执行 shell 命令。

就先简单介绍这么多,接下来我们来看看如何使用 shelljs

安装 shelljs

首先,我们需要安装 shelljs,可以通过 npm 安装:

npm install shelljs

安装完成后,我们就可以在项目中使用 shelljs 了。

使用 shelljs

在项目中使用 shelljs 非常简单,只需要引入 shelljs 模块,然后调用相应的 API 即可。

那么就来看看如何在我们自己编写的 nue-cli 项目中如何使用 shelljs 来完成自动安装依赖的功能。

实现自动安装依赖

shelljs 安装好了,现在需要在项目中引入它。在 bin\create.js 文件中添加如下代码:

const shell = require('shelljs');

接下来,需要在 create.js 中添加自动安装依赖的代码,我这里先一步一步来,我先写一下实现步骤,定义一个方法的名字为 installDependencies,然后在这个方法中调用 shelljsexec 方法,执行 npm install 命令。

const installDependencies = () => {
    shell.exec('npm install');
}

代码写好了,接下来在 create.js 中主流程中调用这个方法:

// 执行 npm install
await waitLoading('installing dependencies...', installDependencies)();

代码写到这我发现一个问题,就是 shelljsexec 方法是异步的,我要改造一下将其改为同步的,用之前的 promisify 方法,单独转一下 exec 方法:

const exec = promisify(shell.exec);

还有一个问题就是,我们拷贝好了模板到当前的目录,现在是要执行安装依赖,我们目前所处的位置还不是模板的根目录,所以我们需要先进入到模板的根目录,然后再执行 npm install 命令。

所以之前的 installDependencies 方法需要改造一下,加入进入到模板根目录的逻辑,还需要传递一个参数,就是模板的名称(projectName):

const installDependencies = async (projectName) => {
    shell.cd(projectName);
    await exec('npm install');
}

经过这一版本的改造,自动安装依赖功能就实现了,接下来来测试一下。

测试

因经过上篇文章的测试过后,项目已经拷贝过来了,所以我会将之前的代码注释掉,主流程当中就只会执行 installDependencies 方法。

为了展示运行过程,我准备了一个动图(gif)作为演示。不过,在录制过程中出现了一个小错误,似乎是因为模板依赖未能成功下载。我会在接下来的时间尝试更换一个源,并带领大家一起探索问题解决方案。待到问题解决后,将继续在下一篇文章中分享。感谢您的阅读,我们下篇文章再会。

与『手撕Vue-CLI』自动安装依赖相似的内容:

『手撕Vue-CLI』自动安装依赖

开篇 经过『手撕Vue-CLI』拷贝模板,实现了自动下载并复制指定模板到目标目录。然而,虽然项目已复制,但其依赖并未自动安装,可能需要用户手动操作,这并不够智能。 正如前文所述,我们已经了解了业务需求和背景。那么,接下来我们将直接深入探讨核心实现细节。 自动安装依赖 在前文中,我们已经将模板文件复制

『手撕Vue-CLI』完善提示信息

前言 经过『手撕Vue-CLI』自动安装依赖,已经实现了自动安装依赖的功能。 然而,虽然项目已复制并安装依赖,但其提示信息并不够友好,于是我试着去运行了一下vue create,发现其提示信息是这样的: 于是我决定完善提示信息,也借此机会完善一下项目的代码,变量命名等。 完善提示信息 完善变量命名

『手撕Vue-CLI』拉取模板名称

前言 好,经过上篇文章的介绍,已经可以有处理不同指令的能力了,接下来我们就来处理 vue create 指令,这个指令的本质就是从网络上下载提前准备好的模板,然后再自动安装模板中相关依赖。 所以实现 create 指令分为两步: 下载指定模板 安装模板中的依赖 先来看看官方的吧,我在终端中已经输入了

『手撕Vue-CLI』拉取版本号

开篇 在上一篇文章中,给 nue-cli 添加了与用户终端交互的功能,这一次来实现一个拉取版本号的功能。 这个功能的背景是,有时候我们在使用脚手架的时候,不同版本的脚手架可能会有不同的功能,所以用户有可能会根据自己的需求选择不同的版本,所以这里将会实现一个根据用户选择的版本号,拉取对应的版本号的模板

『手撕Vue-CLI』添加终端用户交互

前言 经过上一篇文章的梳理,实现了可以从 GitHub 上拉取模板项目名称,已经可以得知可使用的模板有哪些了,那么我觉得是不是要进行选择呢?所以这一篇文章就来实现终端用户交互,让用户可以自己选择想要使用的模板。 实现 在 NodeJS 当中,已经有人为我们封装好了一个库,叫做 inquirer,可以

『手撕Vue-CLI』添加自定义指令

前言 经上篇『手撕Vue-CLI』添加帮助和版本号的介绍之后,已经可以在控制台中输入 nue --help 来查看帮助信息了,但是在帮助信息中只有 --version,--help 这两个指令,而 vue-cli 中还有很多指令,例如 create,serve,build 等等,所以本章将继续添加自

『手撕Vue-CLI』添加自定义指令

前言 经上篇『手撕Vue-CLI』添加帮助和版本号的介绍之后,已经可以在控制台中输入 nue --help 来查看帮助信息了,但是在帮助信息中只有 --version,--help 这两个指令,而 vue-cli 中还有很多指令,例如 create,serve,build 等等,所以本章将继续添加自

『手撕Vue-CLI』拷贝模板

开篇 经过上篇文章的介绍,实现了可以根据用户选择的模板名称加上对应的版本号,可以下载对应的模板,并且将下载之后的文件存放在用户目录下的 .nue-template文件夹中。 接下来这篇文章主要实现内容是将下载的模板文件拷贝到当前所执行命令的目录下。 拷贝模板 例如我现在在终端当中输入 nue-cli

『手撕Vue-CLI』下载指定模板

开篇 经上篇文章的介绍,实现了获取下载目录地址,接下来实现下载指定模板的功能。 背景 通过很多章节过后,已经可以拿到模板名称,模板版本号,下载目录地址,这些信息都是为了下载指定模板做准备的。 实现 如何从 GitHub 下载模板 可以借助 download-git-repo 这个库来下载 GitHu

『手撕Vue-CLI』获取下载目录

开篇 在上一篇文章中,简单的对 Nue-CLI 的代码通过函数柯里化优化了一下,这一次来实现一个获取下载目录的功能。 背景 在 Nue-CLI 中,我现在实现的是 create 指令,这个指令本质就是首先拿到模板名称和版本号之后,然后去进行下载对应的模板,关于下载那么肯定要面临的问题就是如何下载?下