feat: 更新init生成的picklogrc，对新手更加友好

Author: BearJ

.picklogrc.js

@@ -21,13 +21,13 @@ module.exports = {
       regExp: /^revert(\(.*?\))?:\s/i,
     },
   ],
-  parse(picklog) {
+  parse(commits) {
     // RegExp.prototype.toJSON = RegExp.prototype.toString; // JSON.stringify会调用正则表达式的toJSON
-    // return JSON.stringify(picklog, null, 2);
+    // return JSON.stringify(commits, null, 2);
 
     let output = '';
 
-    picklog.forEach((log) => {
+    commits.forEach((log) => {
       let date = new Date(log.timestamp * 1000);
       date = `${date.getFullYear()}-${(`0${date.getMonth() + 1}`).substr(-2)}-${(`0${date.getDate()}`).substr(-2)}`;
 

README.md

@@ -21,32 +21,32 @@ $ picklog -o CHANGELOG.md
 - **`init`**
 
   生成配置文件`.picklogrc.js` ( Generator a setting file `.picklogrc.js` )
-  
+
   e.g: `picklog init`
 
 - **`-w` or `--write`**
 
   把输出添加到指定文件 ( Append stdout to a file )
-  
+
   e.g: `picklog -w CHANGELOG.md`
-  
+
 - **`-o` or `--overwrite`**
-  
+
   把输出覆盖到指定文件 ( Overwrite stdout to a file )
-  
+
   e.g: `picklog -o CHANGELOG.md`
-  
+
 - **`-l` or `--latest`**
-  
+
   只获取距离上一次tag间的修改 ( Only pick latest changes after the last tag )
-  
+
   e.g: `picklog -l -w CHANGELOG.md`
-  
+
 
 - **`-g` or `--gitLogArgs`**
-  
+
   透传给`git log`的参数，以英文逗号分隔 ( Pass the arg to "git log". Splited by **comma** )
-  
+
   e.g: `picklog -g v2.0.0 -w CHANGELOG.md`
 
 
@@ -79,8 +79,8 @@ module.exports = {
       regExp: /^fix/i,
     }
   ],
-  parse(picklog){
-    return JSON.stringify(picklog, null, 2);
+  parse(commits){
+    return JSON.stringify(commits, null, 2);
   },
 };
 ```
@@ -106,13 +106,13 @@ module.exports = {
       regExp: /^fix/i,
     }
   ],
-  parse(picklog){
+  parse(commits){
     let output = '';
 
-    picklog.forEach((log) => {
+    commits.forEach((log) => {
       let date = new Date(log.timestamp * 1000);
       date = `${date.getFullYear()}-${('0' + (date.getMonth() + 1)).substr(-2)}-${('0' + date.getDate()).substr(-2)}`;
-      
+
       output += `### ${log.tag} (${date})\n\n`;
 
       log.results.forEach((result) => {
@@ -130,3 +130,55 @@ module.exports = {
   }
 };
 ```
+
+### 适配AngularJS推荐的Git Commit格式 ( AngularJS Git Commit Guidelines )
+
+[AngularJS Git Commit Guidelines](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commits)
+
+```javascript
+const origin = '<%= GitURL %>';
+const comparePath = `${origin}/compare/`;
+const commitPath = `${origin}/commit/`;
+
+module.exports = {
+  filters: [
+    {
+      name: 'Features',
+      regExp: /^(?:feat|add)/i,
+    },
+    {
+      name: 'Bugfixes',
+      regExp: /^fix/i,
+    }
+  ],
+  parse(commits){
+    // RegExp.prototype.toJSON = RegExp.prototype.toString; // JSON.stringify会调用正则表达式的toJSON
+    // return JSON.stringify(commits, null, 2); // output commits
+
+    let output = '';
+
+    commits.forEach((log) => {
+      let date = new Date(log.timestamp * 1000);
+      date = `${date.getFullYear()}-${('0' + (date.getMonth() + 1)).substr(-2)}-${('0' + date.getDate()).substr(-2)}`;
+
+      let currentTag = log.tag || log.commits[0].h;
+      let prevTag = log.previousTag || log.commits[log.commits.length - 1].h;
+      output += `### [${currentTag}](${comparePath}${prevTag || ''}...${currentTag}) (${date})\n\n`;
+
+      log.results.forEach((result) => {
+        output += `#### ${result.filter.name}\n`;
+
+        result.commits.forEach((commit) => {
+          output += `* ${commit.s}([${commit.h}](${commitPath}${commit.h}))\n`;
+        });
+
+        output += '\n';
+      });
+
+      output += '\n\n';
+    });
+
+    return output;
+  }
+};
+```

bin/.picklogrc.js

@@ -6,30 +6,22 @@ module.exports = {
   filters: [
     {
       name: 'Features',
-      regExp: /^feat(\(.*?\))?:\s/i,
+      regExp: /^(?:feat|add)/i,
     },
     {
       name: 'Bugfixes',
-      regExp: /^fix(\(.*?\))?:\s/i,
-    },
-    {
-      name: 'Performance Improvements',
-      regExp: /^perf(\(.*?\))?:\s/i,
-    },
-    {
-      name: 'Reverts',
-      regExp: /^revert(\(.*?\))?:\s/i,
-    },
+      regExp: /^fix/i,
+    }
   ],
-  parse(picklog) {
+  parse(commits){
     // RegExp.prototype.toJSON = RegExp.prototype.toString; // JSON.stringify会调用正则表达式的toJSON
-    // return JSON.stringify(picklog, null, 2);
+    // return JSON.stringify(commits, null, 2); // output commits
 
     let output = '';
 
-    picklog.forEach((log) => {
+    commits.forEach((log) => {
       let date = new Date(log.timestamp * 1000);
-      date = `${date.getFullYear()}-${(`0${date.getMonth() + 1}`).substr(-2)}-${(`0${date.getDate()}`).substr(-2)}`;
+      date = `${date.getFullYear()}-${('0' + (date.getMonth() + 1)).substr(-2)}-${('0' + date.getDate()).substr(-2)}`;
 
       let currentTag = log.tag || log.commits[0].h;
       let prevTag = log.previousTag || log.commits[log.commits.length - 1].h;
@@ -39,16 +31,7 @@ module.exports = {
         output += `#### ${result.filter.name}\n`;
 
         result.commits.forEach((commit) => {
-          const { regExp } = result.filter;
-          let subject = commit.s.match(regExp) || '';
-
-          if (subject[1]) {
-            const type = subject[1].match(/\((.*?)\)/)[1];
-            subject = `**${type}:** ${commit.s.replace(regExp, '')}`;
-          } else {
-            subject = commit.s.replace(regExp, '');
-          }
-          output += `* ${subject}([${commit.h}](${commitPath}${commit.h}))\n`;
+          output += `* ${commit.s}([${commit.h}](${commitPath}${commit.h}))\n`;
         });
 
         output += '\n';
@@ -58,5 +41,5 @@ module.exports = {
     });
 
     return output;
-  },
+  }
 };