npm 包 committed-git-files 使用教程

随着前端项目的不断增多和代码量的增加，我们需要更好地管理代码和版本。git 是一个非常好的版本控制工具，可以对代码进行版本管理、合并、回滚等操作。在日常开发中，我们通常需要查看已经提交的文件列表。committed-git-files 就是一个很好的解决方案。

本文将为大家介绍 npm 包 committed-git-files 的使用教程，帮助大家更好地管理代码和版本。

什么是 committed-git-files？

committed-git-files 是一个 npm 包，它可以帮助我们获取 Git 提交的文件列表，包括新增、修改、删除、改名的文件。我们可以在命令行中执行命令，也可以在 JavaScript 中使用。

安装 committed-git-files

首先，我们需要在项目中安装 committed-git-files。打开终端，进入项目根目录，运行以下命令：

npm install -D committed-git-files

为了更好地使用，我们可以将其添加到 package.json 文件中：

{
  "dependencies": {},
  "devDependencies": {
    "committed-git-files": "^0.1.9"
  }
}

使用 committed-git-files

使用 committed-git-files 很简单，我们可以在命令行中执行命令，也可以在 JavaScript 中使用。

在命令行中使用 committed-git-files

在命令行中，我们可以使用 committed-git-files 命令来获取提交的文件列表。打开终端，进入项目根目录，运行以下命令：

committed-git-files

执行后，会输出以下结果：

[ 'README.md',
  'package.json',
  'src/index.js',
  'src/index.test.js' ]

这是一个包含所有提交文件的数组。

committed-git-files 命令还支持以下参数：

• --json：以 JSON 格式输出文件列表。
• --changed-only：只输出改变的文件列表。
• --type=[A/M/D/R]：只输出指定类型（新增，修改，删除，重命名）的文件列表。

在 JavaScript 中使用 committed-git-files

在 JavaScript 中，我们可以使用 committed-git-files 的 API 来获取提交的文件列表。首先，我们需要引入 committed-git-files：

const cgit = require('committed-git-files');

然后，我们可以使用 cgit() 函数获取提交的文件列表：

const files = cgit();
console.log(files);

执行后，会输出与命令行中相同的结果。

cgit() 函数还支持传入以下参数：

• json：是否以 JSON 格式输出文件列表。
• changedOnly：是否只输出改变的文件列表。
• type：只输出指定类型（新增，修改，删除，重命名）的文件列表。

const files = cgit({ changedOnly: true, type: 'A' });
console.log(files);

执行后，会输出所有新增的文件列表。

总结

committed-git-files 是一个非常实用的 npm 包，它可以帮助我们更好地管理代码和版本。本文介绍了如何安装和使用 committed-git-files，希望能对大家有所帮助。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600560be81e8991b448df058