如何检查前端项目和 Node 项目中未被使用的依赖包

前言

在日常的开发工作中，随着项目的不断迭代和功能的逐渐增加，我们难免会安装许多依赖包。时间一长，项目中可能会存在一些不再使用的依赖包。这些未被使用的依赖包不仅会增加项目的体积，还可能带来安全隐患。
本文将介绍如何检查前端项目和 Node 项目中未被使用的依赖包。

为什么要清理未被使用的依赖？

减小项目体积：未被使用的依赖包会占用磁盘空间，影响项目的构建和部署速度。
提升安全性：未被使用的依赖包可能会存在安全漏洞，清理掉能够减少潜在的风险。
提高维护性：减少不必要的依赖包能使项目结构更加简洁明了，提升代码的可维护性。

工具介绍

我们可以使用一些工具来帮助我们检查和清理未被使用的依赖包：

npm-check：一个强大的 npm 工具，可以帮助我们检查项目中的依赖包状态，并提示哪些是未被使用的。
depcheck：专门用于检测项目中未被使用的依赖包，并提供详细的报告。

npm-check 使用教程

安装 npm-check

首先，我们需要全局安装 npm-check：

npm install -g npm-check

使用 npm-check 检查依赖

进入我们的项目目录，然后运行以下命令：

npm-check

npm-check 会启动一个交互式界面，检查项目中的依赖包，并且提供如下信息：

哪些依赖包是未被使用的。
哪些依赖包有可用的更新。
哪些依赖包是过时的。
我们可以根据提示选择是否更新、移除或忽略某些依赖包。

depcheck 使用教程

安装 depcheck

我们可以将 depcheck 安装到我们的项目中：

npm install depcheck --save-dev

或者全局安装：

npm install -g depcheck

使用 depcheck 检查依赖

进入我们的项目目录，然后运行以下命令：
npx depcheck
depcheck 会扫描我们的项目代码，并生成一个未被使用的依赖包的详细报告，例如：
Unused dependencies

unused-package
another-unused-package

Unused devDependencies

unused-dev-package

Missing dependencies

missing-package
我们可以根据这个报告，在 package.json 中手动移除未被使用的依赖包，然后运行 npm uninstall [package-name] 命令来删除这些包。

进阶技巧：自动化清理未使用的依赖

虽然使用 npm-check 和 depcheck 可以手动检查和清理未使用的依赖，但是如果我们希望在项目的持续集成（CI）流程中自动化这个过程，这里有一些进阶技巧：

使用脚本自动化

我们可以编写一个脚本，将 depcheck 的输出结果处理后自动移除未使用的依赖。下面是一个简单的 Node.js 脚本示例：

const { exec } = require('child_process');
const depcheck = require('depcheck');// 配置 depcheck
const options = {ignoreDirs: ['node_modules', 'dist'], // 忽略的目录ignoreMatches: ['babel-*', 'eslint-*'], // 忽略的依赖
};depcheck(process.cwd(), options, (unused) => {const allUnused = [...unused.dependencies, ...unused.devDependencies];if (allUnused.length === 0) {console.log('No unused dependencies found.');return;}console.log('Unused dependencies found: ', allUnused);// 生成卸载命令const uninstallCmd = `npm uninstall ${allUnused.join(' ')}`;// 执行卸载命令exec(uninstallCmd, (err, stdout, stderr) => {if (err) {console.error('Error while uninstalling dependencies:', stderr);} else {console.log('Successfully uninstalled unused dependencies:', stdout);}});
});

这个脚本首先使用 depcheck 检查未使用的依赖，然后生成并执行 npm uninstall 命令来自动移除这些依赖。我们可以将这个脚本放在项目的 scripts 目录下，并在 package.json 中添加一个脚本命令来执行它：

{"scripts": {"clean:unused": "node scripts/clean-unused-dependencies.js"}
}

然后我们可以通过以下命令来运行这个脚本：

npm run clean:unused

集成到 CI 流程

如果我们使用 CI/CD 管理我们的项目，可以将这个脚本集成到 CI 流程中。在 CI 配置文件中添加一个步骤，在每次构建前执行这个脚本。例如，对于 GitHub Actions，我们可以这样配置 .github/workflows/ci.yml 文件：
name: CI

on:push:branches: [ main ]pull_request:branches: [ main ]jobs:build:runs-on: ubuntu-lateststeps:- uses: actions/checkout@v2- name: Set up Node.jsuses: actions/setup-node@v2with:node-version: '14'- name: Install dependenciesrun: npm install- name: Clean unused dependenciesrun: npm run clean:unused- name: Run testsrun: npm test

在这个配置文件中，我们在构建步骤中添加了 Clean unused dependencies 步骤，这样每次构建时都会自动清理未使用的依赖。