Skip to content

配置及使用说明

OBKoro1 edited this page Aug 31, 2020 · 3 revisions

安装

在 Vscode 扩展商店中搜索Auto Commit,点击安装即可。

插件入口

  1. 使用快捷键打开VSCode的命令面板。

    • mac: command + p window: ctrl + p
  2. 输入`> auto commit将会看到如下图所示的命令选项,然后用鼠标点击或者回车都可启动插件。

    • 注意有>符号,老是用人不知道怎么用 o(╥﹏╥)o
    • 实际上可以输入下方选项的任何一段文字,都可以匹配到插件命令选项。

image

插件页面

image

自动commit演示:

image

使用须知

  1. 在使用插件之前先阅读一下github相关的内容: GitHub设置私有项目刷commit以及commit的次数与颜色
  2. 需要提交到master分支,github首页才会有你的提交记录
  3. 使用插件之前,需要clone项目到本地, 最好先进行一次提交确保能够正常提交,防止因为merge/release等问题导致提交失败。

插件配置说明

下面是插件每项配置的说明以及插件运行流程的说明。

项目地址选项

  1. 先把要提交commit的仓库clone到本地。

    推荐创建一个私有项目,别人就看不到你的提交内容和提交信息。

  2. 然后点击该选项,选择clone后的项目文件夹地址。

commit文件

commit需要有内容变化的,插件会自动生成变化,然后就变化的内容写入该文件。

它位于项目的根目录,不存在时将会自动创建。

PS:如果是提交到私有项目,将不会被别人看到你提交的内容。

commit信息

commit message的内容,所有提交的commit内容都是这个值。

PS:如果是提交到私有项目,将不会被别人看到你提交的信息。

随机commit次数

默认开启,默认为1~10随机,时间范围内默认每个日期随机commit几次,如果单个时间段设置了commit次数将使用设置的数字用于随机commit。

PS: 最小值为2,即每个日期随机commi 1/2次。

默认commit次数

关闭随机commit次数,就会使用一个固定的commit次数。

如果单个时间段设置了commit次数将使用设置的固定commit次数。

commit次数的最大值

所有计数器的最大值设定为30。

设置多个时间段、每个时间段可以设置不同的提交次数

如下图:

  1. 插件可以添加多次日期范围
  2. 每个日期范围都能控制具体的commit次数
  3. 每个日期范围和commit次数通过index来配对。
  4. 同一个日期,后面出现的将会覆盖前面的:commit次数将会使用后面日期设置。
  5. 对应的日期范围,不设置commit次数,那么将会使用随机commit次数/默认commit次数。

如下图所示的配置(日期覆盖情况),最后的结果是:

12/01~12/06 使用默认commit次数,每天将会提交一次

12/07~12/08 每天提交三次

12/09~12/19 每天提交四次

commit颜色

运行日志

插件运行日志,是倒序展示的,如果提交量比较大,支持在运行期间清空日志。

开始commit

当配置好选项之后就可以点击开始commit按钮来提交commit。

建议一开始为了避免误操作,先测试一下熟悉插件的运行流程:commit量不要过大。

PS: 请在一个网络状况良好的地方运行,否则会导致push失败。

取消commit

  1. 该按钮是为了避免用户误操作,用于在插件commit期间终止自动commit

  2. 一旦插件日志出现提交中...,就不可取消。

  3. 如果commit次数超过100,插件将会强制等待10S让你考虑是否需要取消commit。

保存配置和后台运行

  1. 插件在运行成功一次之后,会自动保存你的配置参数,在你下次通过命令打开插件的时候,会自动初始配置参数。

  2. 插件是可以挂在后台运行,不影响你编码、浏览网页之类的。

更多设置

间隔提交

起源于issue10: 绿墙全部都占满,看着有点太假的感觉,自己看着都不好意思。

这个功能的作用就是: 随机部分天数不提交commit,没有绿格子,看起来更逼真。

该功能根据以下两个字段来设置。

超出时间范围

比如设置60天,只有commit的日期总数超过60天,该间隔提交才会生效。

随机不提交天数

比如设置8天,超过60天之后,在这60天内随机八天不提交commit

Star一下吧

如果插件觉得还不错的话,就给个 Star ⭐️ 鼓励一下我吧~

推荐另一个我开源的VSCode插件: koroFileHeader

前端进阶积累公众号GitHub