npm 包 cleanware 使用教程

阅读时长 4 分钟读完

在前端项目开发过程中,经常需要使用各种 npm 包。但是随着项目的不断迭代和开发,安装的 npm 包也越来越多,这时候我们就需要清理没有使用的 npm 包,以减小项目体积并且避免不必要的安全隐患。而 cleanware 就是一个非常实用的 npm 包清理工具。

cleanware 简介

cleanware 是一个专门用于清理无用依赖包的 npm 包。它可以扫描你的项目目录或者指定目录下的所有 npm 包,并进行静态分析,找到没有使用过的 npm 包,然后进行自动清理。

快速入门

首先,需要全局安装 cleanware :

然后在终端输入以下命令:

其中,“<path>”为你需要清理的目录,也可以不填则默认扫描当前目录。执行命令后,cleanware 会自动扫描目标目录下的所有文件和文件夹,分析出没有被使用的 npm 包,并进行清理。

进阶用法

在实际项目中,可能会遇到多个开发者共同开发,使用了不同的 npm 包,在进行清理时需要在不影响他人的情况下进行。这时候, cleanware 提供了一些非常好用的选项。

可配置路径

通过在 cleanware 命令行中使用 “-p” 或 “--path” 参数,我们可以配置需要清理的路径。例如:

忽略指定的文件和文件夹

在某些情况下,我们会使用一些 npm 包,但是希望 cleanware 不要将其清理掉。这个时候可以使用 “-i” 或 “--ignore” 参数来忽略指定的文件和文件夹。例如:

上述命令将忽略目录中的 build,config,node_modules 三个目录。

配置多个清理路径

当需要清理多个路径时,我们可以配置一个 cleanware.json 文件,使用命令 “cleanware run” 自动清理多个指定的路径。例如:

-- -------------------- ---- -------
-
  -------- -
    -------------------------
    -------------------------
    ------------------------
  --
  --------- -
    --------
    ---------
    --------------
  -
-

然后,在终端输入以下命令:

指定清理模式

cleanware 支持三种清理模式:

  • safe:保险模式,只会删除本地没有用到的依赖包;
  • aggressive:激进模式,会删除所有没有被项目依赖的 npm 包,包括全局 node_modules;
  • very-safe:极度保险模式,除了删除本地没有用到的依赖包,还会进行手动确认并备份。

可以使用 “-m” 或 “--mode” 参数来指定使用哪种清理模式。例如:

如何保证清理的安全

在使用 cleanware 进行清理过程中,一定要保证自己的数据安全性。建议在清理前先进行备份,确保在出现问题的情况下能够迅速恢复。此外,也要确保自己了解清理的过程和可能存在的风险,避免误删重要文件。

示例代码

以下是一个示例的 cleanware.json 文件,演示如何配置多个清理路径和忽略指定的文件和文件夹。

-- -------------------- ---- -------
-
  -------- -
    -------------------------
    -------------------------
    ------------------------
  --
  --------- -
    --------
    ---------
    --------------
  -
-

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600562f781e8991b448e0c30

纠错
反馈