github-commit 是一款基于 Node.js 与 Github API 开发的 npm 包，可以方便地将代码提交到 Github 上的仓库中，并附带提交信息和文件路径等信息。对于前端工程师而言，github-commit 可以用来快速、便捷地上传代码。
安装
在使用 github-commit 之前，需要先安装该 npm 包。可以使用以下命令进行安装：
npm install github-commit --save-dev
配置
建议在项目的根目录下新建一个 commit.config.js 文件，用于存放 Github API 的认证信息和提交记录的配置信息。文件内容如下：
-- -------------------- ---- -------
-------------- - -
------------ ------------------ -- ------ --- -- -----
------ ------------- -- ------ ---------
----- ------------ -- ------ ----
------- --------- -- -----
-------- -------- -------- -- ----
------ -
-------------- -- ----------------
------------
-
--将 accessToken 替换为自己的 Github API 认证 token，owner 和 repo 替换为自己的 Github 仓库所属组织或用户和仓库名称。如果需要将其他文件夹或文件添加到提交记录中，可以修改 files 数组。
使用
在项目中使用 github-commit 的方法如下：
const { commit } = require('github-commit');
const config = require('./commit.config');
commit(config)
.catch(error => {
console.error(error);
});commit 方法接收一个对象作为参数，该对象包括 Github API 的认证信息和提交信息等配置。它会将指定的文件路径下的文件提交到 Github 仓库中。
示例
假设我们的项目根目录下有一个 dist 文件夹和一个 src 文件夹，分别存放打包后的代码和源代码，而我们需要将它们提交到 Github 仓库中。以下是使用 github-commit 实现的示例代码：
-- -------------------- ---- -------
----- - ------ - - -------------------------
----- ------ - ---------------------------
--------------
-------- -- -
----------------- --- ---- --------- -- ------ --------------
--
------------ -- -
---------------------
---执行以上代码，可以将 dist 和 src 目录下的所有文件提交到 Github 仓库中。此外，提交信息可以根据实际情况进行修改，以便更好地记录提交记录。
总结
github-commit 是一款很实用的 npm 包，可以帮助前端工程师在开发过程中更方便地将代码提交到 Github 仓库中，节省了很多时间。本篇文章介绍了该 npm 包的安装、配置和使用方法，并提供了示例代码。希望读者能够通过阅读本文，更好地理解和掌握 github-commit 的使用，以便提高开发效率。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60059d7b81e8991b448ed496