Merge pull request #3 from Alinvor/developer

[DONE]合并分支

Author: DovSnier

.gitignore

@@ -1,6 +1,15 @@
 
+# Generated files
 bin/
+gen/
 out/
-.DS_Store
+mock/
+venv/
+venv2/
+**/.DS_Store
 
+# vscode config files
+.vscode/settings.json
+
+# script files
 script/self/

.vscode/launch.json

@@ -0,0 +1,15 @@
+{
+    // 使用 IntelliSense 了解相关属性。 
+    // 悬停以查看现有属性的描述。
+    // 欲了解更多信息，请访问: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+
+        {
+            "type": "bashdb",
+            "request": "launch",
+            "name": "Bash-Debug",
+            "program": "${file}"
+        }
+    ]
+}

code.sh

@@ -0,0 +1,55 @@
+#!/usr/bin/env bash
+
+echo "enter the directory(format is ../workspace/the_current_project, but you only input the_current_project or workspace/the_current_project): "
+read dir # input directory
+dir_name=$(dirname $dir)
+project_name=$(basename $dir)
+
+function juageInteractionMode(){
+    if [[ $1 == "\\" || $1 == "." ]];then
+        return 1; # the relative path mode
+    fi
+    return 0; # the absolute path mode
+}
+
+echo -n "enter the start date(format is xxxx-xx-xx): "
+read start_date # input start date
+
+if [[ ! -d "./out" ]];then
+    mkdir ./out
+fi
+
+root_name="$(dirname $(dirname $(pwd)))" # the parent directory of the current workspace
+juageInteractionMode $dir_name
+mode=$? # 1: relative mode otherwise absolute mode
+project="" # the current project directory
+if [[ $mode == 1 ]];then
+    project="${root_name}/$(basename $(dirname $(pwd)))/${project_name}"
+else
+    project="${root_name}/${dir}"
+fi
+out_name="" # the current project statistics output directory.
+
+if [[ ! -z $dir ]]; then
+    if [[ ! -z $start_date ]]; then
+        out_name="`pwd`/out/statistics_${project_name}_${start_date}_$(date "+%Y-%m-%d_%H%M%S")"
+        mkdir -p $out_name
+        echo -e "\n the current project directory:\n $project"
+        echo -e "\n the current out directory:\n $out_name"
+        echo -e "\n"
+        python2 gitstats -c start_date=${start_date} ${project} ${out_name}
+    else
+        out_name="`pwd`/out/statistics_${project_name}_$(date "+%Y-%m-%d_%H%M%S")"
+        mkdir -p $out_name
+        echo -e "\n the current project directory:\n $project"
+        echo -e "\n the current out directory:\n $out_name"
+        echo -e "\n"
+        python2 gitstats -c ${project} ${out_name}
+    fi
+else
+    echo "the current project directory: $project"
+    echo "the current out directory: $out_name"
+    echo "the directory is not vaild."
+fi
+exit 0
+

readMe.md

@@ -0,0 +1,91 @@
+
+# gitstats
+
+gitstats
+
+
+
+## 构建`venv`环境
+
+### venv2
+
+```
+virtualenv -p /usr/local/bin/python2 --no-site-packages venv2
+```
+
+## venv3
+
+```
+virtualenv -p /usr/local/bin/python3 --no-site-packages venv
+```
+
+## 使用方式
+
+### 方式一
+
+目录结构如下:
+
+```
++ root
+  + --- directory_work_space_xxx
+  | + - directory_the_current_project
+  |
+  + --- directory_work_space_gitstats
+    + - directory_the_gitstats_project   //即 gitstats
+```
+
+使用如下命令:
+```
+$ cd root/directory_work_space_gitstats/directory_the_gitstats_project(即gitstats)
+$ ./code.sh
+
+$ enter the directory(format is ../workspace/the_current_project, but you only input the_current_project or workspace/the_current_pr
+oject): 
+$ directory_work_space_xxx/directory_the_current_project
+
+$ enter the start date(format is xxxx-xx-xx): 
+$ enter the start date(format is xxxx-xx-xx): 2019-12-12
+
+# the sensible browser
+# sensible-browser 'directory_work_space_gitstats/gitstats/out/statistics_directory_the_current_project_2019-xx-xx_2019-12-12_xxxxxx/index.html'
+```
+
+### 方式二
+
+目录结构如下:
+
+```
++ root
+  + --- directory_work_space_gitstats
+    + - directory_the_gitstats_project   //即 gitstats
+    + - directory_the_current_project
+```
+
+使用如下命令:
+```
+$ cd root/directory_work_space_gitstats/directory_the_gitstats_project(即gitstats)
+$ ./code.sh
+
+$ enter the directory(format is ../workspace/the_current_project, but you only input the_current_project or workspace/the_current_pr
+oject): 
+$ directory_the_current_project
+
+$ enter the start date(format is xxxx-xx-xx): 
+$ enter the start date(format is xxxx-xx-xx): 2019-12-12
+
+# the sensible browser
+# sensible-browser 'directory_work_space_gitstats/gitstats/out/statistics_directory_the_current_project_2019-xx-xx_2019-12-12_xxxxxx/index.html'
+```
+## FAQ
+
+### Note
+
+> 其实就是注意一下,输入的目录:
+> 一种为: `directory_work_space_xxx/directory_the_current_project`
+> 一种为: `directory_the_current_project`
+>
+> 再然后就是注意一下，日期输入格式: `xxxx-xx-xx`
+> 举例: 2019-12-12
+>
+> 最后浏览器打开:
+> `../gitstats/out/statistics_directory_the_current_project_2019-xx-xx_2019-12-12_xxxxxx/index.html`