This commit is contained in:
OBKoro1 2020-08-31 13:29:30 +08:00
parent 2283ae012d
commit 66951e7355
3 changed files with 40 additions and 149 deletions

View File

@ -4,8 +4,8 @@
### [V1.0.5]
* 增加新功能:超过一定天数范围内,随机部分天数不提交`commit`,没有绿格子,看起来更逼真。
* 重写wiki配置文档
* 增加新功能:超过一定天数范围内,[随机部分天数不提交](https://github.com/OBKoro1/autoCommit/wiki/%E9%85%8D%E7%BD%AE%E5%8F%8A%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E#%E9%97%B4%E9%9A%94%E6%8F%90%E4%BA%A4)`commit`,没有绿格子,看起来更逼真。
* 重写wiki[配置文档](https://github.com/OBKoro1/autoCommit/wiki/%E9%85%8D%E7%BD%AE%E5%8F%8A%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E)
### [V1.0.4]

183
README.md
View File

@ -1,82 +1,36 @@
# autoCommit
> 一个用于Git自动commit的VSCode插件它可以用来补充之前忘记提交commit帮助你把首页的绿色格子填满。
> 用于刷commit记录可以刷过去几年的commit以及未来的commit, 一键帮你把github首页的绿色格子填满。
* 它是一个VScode插件可以自由控制commit日期(提交过去几年的commit以及未来的commit)
* 它可以自由控制commit次数, 固定或者随机commit次数。
* 插件提供完善的日志: 清晰的了解插件的运行情况
### 使用效果
1. 使用本插件来控制commit次数.
2. 如下图,你甚至可以规划一下`commit`次数,然后画出图形, 天空才是你的极限。
![commit_img.png](https://upload-images.jianshu.io/upload_images/5245297-2c357937f3122b08?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)
### 功能特性
1. **选择多个日期范围**:一次操作即可提交不同日期`commit`
2. **控制每个日期的commit次数**: 可以用它来控制绿色格子的颜色,了解[commit次数与颜色](https://github.com/OBKoro1/autoCommit/wiki/%E4%BD%BF%E7%94%A8%E9%A1%BB%E7%9F%A5#commit%E6%AC%A1%E6%95%B0%E4%B8%8E%E9%A2%9C%E8%89%B2)
3. **随机commit次数**随机commit次数让我们的提交看起来更加逼真。
4. **取消commit**: 用于在`commit`期间取消并回滚到未提交版本
5. 超过100次提交将强制考虑10秒是否要取消commit。
6. 插件成功运行后,将自动保存配置参数,无须每次都要一通操作。
7. 提交完善的日志: 清晰的了解插件的运行情况
8. 后台运行,不影响编码、浏览网页等。
9. 运行超快如下图187次commit20秒搞定。
10. 还有超多细节优化。
### 仓库地址:
[autoCommit](https://github.com/OBKoro1/autoCommit)
![image](https://github.com/OBKoro1/autoCommit/blob/master/images/commit_img.png?raw=true)
#### 自动commit演示
![image](https://github.com/OBKoro1/autoCommit/blob/master/images/autoCommit.gif?raw=true)
![autoCommit.gif](https://upload-images.jianshu.io/upload_images/5245297-ba173538d0a037cf?imageMogr2/auto-orient/strip)
### 功能特性
### 安装
在 Vscode 扩展商店中搜索`Auto Commit`,点击安装即可。
### 插件入口
1. 使用快捷键打开VSCode的命令面板。
* `mac`: `command + p` window: `ctrl + p`
2. 输入`> auto commit`将会看到如下图所示的命令选项,然后用鼠标点击或者回车都可启动插件。
* 实际上可以输入下方选项的任何一段文字,都可以匹配到插件命令选项。
![image](https://upload-images.jianshu.io/upload_images/5245297-832f45c19fdca38e?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)
### 使用须知
## Git相关
需要有一个项目让插件提交commit可以使用公开项目但更推荐创建一个私有项目
#### 创建私有项目来提交commit
**私有项目的优势**:
1. 隐藏项目,别人看不到。
PS 公开的项目如果后面要删除的话会将commit也清除掉。
2. 相对应的你的提交记录别人也看不到,只能看到类似下面这句话。
`3 contributions in private repositories`: 提交了三个commit到私有仓库。
3. **要打开私有仓库贡献可见 别人才能看到私有仓库的commit** ,否则只能自己看到:
![image](https://upload-images.jianshu.io/upload_images/5245297-4b6984da51d815cd?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)
#### 确保能够正常提交
1. clone github项目到本地。
2. 确保能够正常提交。
先进行一次提交确保能够正常提交防止因为merge/release等问题导致提交失败。
#### **需要提交到`master`分支上**
如果提交到其他分支,提交记录不会显示在绿色的格子里面,合并分支之后 才会显示在绿色格子里面。
* **一键提交**: 设置好参数之后,一键超快提交`commit`
* **选择多个日期范围**:一次操作即可提交不同日期`commit`, **还可以提交过去/未来日期的commit**
* **控制每个日期的commit次数**: 可以用它来控制绿色格子的颜色,了解[commit次数与颜色](https://github.com/OBKoro1/autoCommit/wiki/GitHub%E8%AE%BE%E7%BD%AE%E7%A7%81%E6%9C%89%E9%A1%B9%E7%9B%AE%E5%88%B7commit%E4%BB%A5%E5%8F%8Acommit%E7%9A%84%E6%AC%A1%E6%95%B0%E4%B8%8E%E9%A2%9C%E8%89%B2#commit%E6%AC%A1%E6%95%B0%E4%B8%8E%E9%A2%9C%E8%89%B2)
* **随机commit次数**随机commit次数让我们的提交看起来更加逼真。
* **间隔提交commit**: 在一定的时间长度内随机选取几天不提交commit
* 取消commit: 用于在`commit`期间取消并回滚到未提交版本
* 超过100次提交将强制考虑10秒是否要取消commit。
* 插件成功运行后,将自动保存配置参数,无须每次都要一通操作。
* 提供完善的日志: 清晰的了解插件的运行情况
* 后台运行,不影响编码、浏览网页等。
* 运行超快如下图187次commit20秒搞定。
* **觉得插件还不错的话点个Star吧~**
#### 提交以前和未来的commit
@ -86,89 +40,29 @@
2. 现在2020年1月份成功提交了2020年2月份的commit。
3. 具体能提交最早和最晚的日期没有测试过,有兴趣的可以试试~
#### commit次数与颜色
### 仓库地址:
我用这个工具测试一下了一个不同日期commit1~30次的颜色变化
[autoCommit](https://github.com/OBKoro1/autoCommit)
一天1-7次commit颜色为`#c6e48b`
一天8-14次commit颜色为`#7bc96f`
一天15-20次commit颜色为`#239a3b`
一天21-63次commit颜色为`#196127`
### 安装
后面的没有再测试了,应该最深的颜色就是`#196127`
在 Vscode 扩展商店中搜索`Auto Commit`,点击安装即可。
![commit颜色](https://upload-images.jianshu.io/upload_images/5245297-73427fb0f18ccfa8?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)
### 插件入口
1. 使用快捷键打开VSCode的命令面板。
* `mac`: `command + p` window: `ctrl + p`
2. 输入`> auto commit将会看到如下图所示的命令选项然后用鼠标点击或者回车都可启动插件。
* 注意有`>`符号,老是用人不知道怎么用 o(╥﹏╥)o
* 实际上可以输入下方选项的任何一段文字,都可以匹配到插件命令选项。
## 插件运行机制相关
![image](https://github.com/OBKoro1/autoCommit/blob/master/images/command.png?raw=true)
#### 随机commit次数
### 文档
默认开启默认为1~10随机时间范围内默认每个日期随机commit几次如果单个时间段设置了`commit`次数将使用设置的次数。
PS 最小值为2即每个日期随机commi 1/2次。
#### 默认commit次数
关闭随机commit次数就会使用默认commit次数如果单个时间段设置了`commit`次数将使用设置的次数。
#### 设置多个时间段、每个时间段可以设置不同的提交次数
如下图:
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 每天提交四次
![image](https://upload-images.jianshu.io/upload_images/5245297-5d9be61e7da96d62?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)
#### commit次数的最大值
所有计数器的最大值设定为30。
#### 默认修改项目根目录的`commit.md`文件
插件将默认重写项目根目录的`commit.md`文件,如果文件不存在将会自动创建。
插件提供了一个配置项让你可以修改commit信息将要存储的文件。
#### commit信息
每次提交需要有一个commit信息插件默认是`autoCommit`, 你可以在界面修改它。
#### 运行日志
插件运行日志,是倒序展示的,如果提交量比较大,支持在运行期间清空日志。
### 开始commit
当配置好选项之后就可以**点击开始commit**按钮来提交commit。
建议一开始为了避免误操作先测试一下commit量不要过大。
PS 请在一个网络状况良好的地方运行,否则会导致`push`失败。
### 取消commit
1. 该按钮是为了避免用户误操作用于在插件commit期间终止自动`commit`。
2. 一旦插件日志出现`提交中...`,就不可取消。
3. 如果commit次数超过100插件将会强制等待10S让你考虑是否需要取消commit。
#### 保存配置和后台运行
1. 插件在运行成功一次之后,会自动保存你的配置参数,在你下次通过命令打开插件的时候,会自动初始配置参数。
2. 插件是可以挂在后台运行,不影响你编码、浏览网页之类的。
* [配置及使用说明](https://github.com/OBKoro1/autoCommit/wiki/%E9%85%8D%E7%BD%AE%E5%8F%8A%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E)
* [GitHub设置私有项目刷commit以及commit的次数与颜色](https://github.com/OBKoro1/autoCommit/wiki/GitHub%E8%AE%BE%E7%BD%AE%E7%A7%81%E6%9C%89%E9%A1%B9%E7%9B%AE%E5%88%B7commit%E4%BB%A5%E5%8F%8Acommit%E7%9A%84%E6%AC%A1%E6%95%B0%E4%B8%8E%E9%A2%9C%E8%89%B2)
### 插件声明
@ -178,13 +72,10 @@ PS 请在一个网络状况良好的地方运行,否则会导致`push`失
### 头部注释插件
本人还开源了另外一个VSCode插件: [koroFileHeader](https://github.com/OBKoro1/koro1FileHeader)目前该插件已经有1300+ Star了欢迎安装使用。
本人还开源了另外一个VSCode插件: [koroFileHeader](https://github.com/OBKoro1/koro1FileHeader)目前该插件已经有1000+ Star了欢迎安装使用。
1. 它是用于生成文件头部注释,帮助我们养成良好的编码习惯,规范整个团队风格。
2. 插件支持所有主流语言,功能强大,灵活方便,文档齐全,食用简单!
3. 一键添加佛祖保佑永无BUG、神兽护体等注释图案。
![example.gif](https://raw.githubusercontent.com/OBKoro1/koro1FileHeader/master/images/example.gif)
### License

View File

@ -3,7 +3,7 @@
"displayName": "Auto Commit",
"description": "自动提交commit到github",
"publisher": "OBKoro1",
"version": "1.0.4",
"version": "1.0.5",
"scripts": {
"build": "vsce package",
"vscode:prepublish": "webpack --mode production",