前言
在开发前端项目时，经常会遇到需要将项目上传至 git 仓库管理的情况。然而，在项目修改过程中，可能会有一些临时文件或者已经删除但是仍然存在于项目中的文件，这些文件可能会对项目的管理和维护带来不必要的困扰。而 npm 包 git-cleanse 正是为了解决这样的问题而存在的。
git-cleanse 是一个可以帮助去除不必要文件的 npm 包，能够快速帮助我们清除掉不必要的文件，极大地提高了我们项目文件的管理效果，下面将详细介绍 git-cleanse 的使用。
安装
通过 npm 安装 git-cleanse：
npm i -g git-cleanse
使用方法
基本使用
在项目根目录下执行命令：
git-cleanse
命令执行后，git-cleanse 将会扫描整个项目，找出不应该被提交的文件并将其删除。
忽略某些文件
有时候我们需要将某些文件上传至 git 仓库，但是这些文件又会被 git-cleanse 误删。这时需要在项目根目录下创建一个 .gitignore 文件，并将需要忽略的文件写在其中。例如，我们需要将一个文件 test.txt 上传至 git，但又不想让 git-cleanse 删除它，那么我们可以在 .gitignore 文件中添加如下代码：
!test.txt
使用配置文件
在项目根目录下创建一个. gitcleanse.json 文件，写入如下内容：
-- -------------------- ---- -------
-
-------- -
-
-------------- ------- --------- --------------
------- ------
------- --------------
--
-
-------------- ------- --- ----- -- --------- -----
------- ------
------- ------
---------- ---
--
-
-------------- ----- --------
------- -------
------- --------
-
-
-规则说明：
1、description：规则描述。
2、type：文件类型，可以是file或dir，分别对应文件和目录。
3、name：可以是单个的文件名或目录名。
4、include：正则匹配，可以写任何匹配规则，不填写则匹配全部文件或目录。
以上三条语句即是告诉 git-cleanse，需要忽略的是 node_modules 目录，lib 目录下的所有文件及 foo.js 文件。
执行如下命令：
git-cleanse --config .gitcleanse.json
git-cleanse 将根据 .gitcleanse.json 文件中的规则进行删除。
示例代码
以下是一个简单的示例代码，展示如何使用 git-cleanse 进行代码维护。
-- -------------------- ---- ------- -- -------------- -- ----- ---- - -------------- ------------------ ---------- -------- ------ -- - ------ - - -- - ------------------ ----
假设以上代码中 eslint-disable、console.log 都是不必要的文件，我们可以在命令行中输入 git-cleanse，然后 git-cleanse 将会自动删掉这些不必要的文件，使代码更加美观易读、易于维护。
总结
使用 git-cleanse 可以非常方便地对项目文件进行管理，尤其对于大型项目更为明显。本文讲解了 git-cleanse 的基本使用方法、如何设置忽略某些文件以及如何使用配置文件。如有需要，可以参考以上内容进行使用。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60057c8c81e8991b448ebeb5