feat: 增加 tagFilter 来选取自己所需的 tag

Author: BearJ

.picklogrc.js

@@ -59,4 +59,5 @@ module.exports = {
 
     return output;
   },
+  tagFilter: /^v\d+\.\d+\.\d+$/,
 };

README.md

@@ -82,13 +82,15 @@ module.exports = {
   parse(commits){
     return JSON.stringify(commits, null, 2);
   },
+  tagFilter: /^v\d+\.\d+\.\d+$/, // Optional
 };
 ```
 
-| 参数 | 必填 | 说明 | 类型 |
+| 参数 (Args) | 必填 (Required) | 说明 (Introduction) | 类型 (Type) |
 | ------ | ------ | ------ | ------ |
 | filters | Yes | 规定了选取log的正则，你也可以在output里获得它。( `filters` use regexp filter logs, you can alse get this in output. ) | Array |
 | parse | Yes | 你可以对你过滤的logs进行解析的函数。参数`commits`的结构可看[这里](./test/getCommits/output.json)。( `parse` is the function that you can parse your output with the logs you filter. [Here](./test/getCommits/output.json) is the`commits` example. ) | Function |
+| tagFilter | False | 规定了选取tag的正则。( `tagFilter` use regexp filter tag. ) | RegExp |
 
 
 ### 我想要Markdown ( I want Markdown )
@@ -127,7 +129,8 @@ module.exports = {
     });
 
     return output;
-  }
+  },
+  tagFilter: /^v\d+\.\d+\.\d+$/, // Optional
 };
 ```
 
@@ -179,6 +182,7 @@ module.exports = {
     });
 
     return output;
-  }
+  },
+  tagFilter: /^v\d+\.\d+\.\d+$/, // Optional
 };
 ```

package.json

@@ -4,7 +4,7 @@
   "description": "Pickup the logs that you filter, so you can generation changelog from it.",
   "main": "index.js",
   "scripts": {
-    "test": "jest",
+    "test": "jest --detectOpenHandles",
     "lint": "eslint **/*.js",
     "changelog": "node ./bin/picklog.js -l -w CHANGELOG.md",
     "preversion": "npm run lint && npm test",

src/getCommits.js

@@ -62,7 +62,7 @@ module.exports = function getCommits(args, setting) {
     git.raw(['log', ...gitLogArgs, PrettyFormats.arg], (err, result) => {
       if (err) throw err;
 
-      let tagCommitObjList = splitCommitByTag(PrettyFormats.parse(result));
+      let tagCommitObjList = splitCommitByTag(PrettyFormats.parse(result), setting);
 
       if (args.latest) {
         tagCommitObjList = tagCommitObjList.splice(0, 1);

src/lib/defaultSetting.js

@@ -23,4 +23,5 @@ module.exports = {
     RegExp.prototype.toJSON = RegExp.prototype.toString; // JSON.stringify会调用正则表达式的toJSON
     return JSON.stringify(logs, null, 2);
   },
+  tagFilter: /^v\d+\.\d+\.\d+$/, // Optional
 };

src/splitCommitByTag.js

@@ -17,14 +17,17 @@ function getCommitObj(commit) {
   };
 }
 
-module.exports = function splitCommitByTag(commits) {
+module.exports = function splitCommitByTag(commits, setting) {
   if (!commits || commits.length < 1) return [];
 
   const result = [];
   let commitObject = getCommitObj(commits.splice(0, 1)[0]);
 
   commits.forEach((commit) => {
-    const tagName = getTagName(commit.d);
+    let tagName = getTagName(commit.d);
+    if (setting.tagFilter) {
+      tagName = setting.tagFilter.test(tagName) ? tagName : '';
+    }
 
     if (tagName) {
       // 该commit有tag

test/.picklogrc.js

@@ -23,4 +23,5 @@ module.exports = {
     RegExp.prototype.toJSON = RegExp.prototype.toString; // JSON.stringify会调用正则表达式的toJSON
     return JSON.stringify(logs, null, 2);
   },
+  tagFilter: /^v\d+\.\d+\.\d+$/,
 };

test/getCommits/getCommits.test.js

@@ -1,15 +1,15 @@
 /* eslint-disable no-undef */
 
-const { readFileSync } = require('fs');
-const { resolve } = require('path');
+const fs = require('fs');
+const path = require('path');
 
 const getCommits = require('../../src/getCommits.js');
 const setting = require('../.picklogrc');
 
-const output = readFileSync(resolve(__dirname, 'output.json'), 'utf-8');
-const outputWithLatest = readFileSync(resolve(__dirname, 'outputWithLatest.json'), 'utf-8');
+const output = fs.readFileSync(path.resolve(__dirname, 'output.json'), 'utf-8');
+const outputWithLatest = fs.readFileSync(path.resolve(__dirname, 'outputWithLatest.json'), 'utf-8');
 
-test('Test getCommits.js', () => {
+test('Test getCommits.js', () => new Promise((resolve) => {
   getCommits({
     gitLogArgs: 'v1.2.3',
   }, setting)
@@ -30,10 +30,11 @@ test('Test getCommits.js', () => {
       /* eslint-disable-next-line no-extend-native */
       RegExp.prototype.toJSON = RegExp.prototype.toString; // JSON.stringify会调用正则表达式的toJSON
       expect(JSON.stringify(commits, null, 2)).toBe(output);
+      resolve();
     });
-});
+}));
 
-test('Test getCommits.js with arg "latest"', () => {
+test('Test getCommits.js with arg "latest"', () => new Promise((resolve) => {
   getCommits({
     latest: true,
     gitLogArgs: 'v1.2.3',
@@ -55,5 +56,6 @@ test('Test getCommits.js with arg "latest"', () => {
       /* eslint-disable-next-line no-extend-native */
       RegExp.prototype.toJSON = RegExp.prototype.toString; // JSON.stringify会调用正则表达式的toJSON
       expect(JSON.stringify(commits, null, 2)).toBe(outputWithLatest);
+      resolve();
     });
-});
+}));

test/getFilterCommitsWithSetting/getFilterCommitsWithSetting.test.js

@@ -1,13 +1,13 @@
 /* eslint-disable no-undef */
 
-const { readFileSync } = require('fs');
-const { resolve } = require('path');
+const fs = require('fs');
+const path = require('path');
 
 const getFilterCommitsWithSetting = require('../../src/getFilterCommitsWithSetting.js');
 const input = require('./input');
 const setting = require('../.picklogrc');
 
-const output = readFileSync(resolve(__dirname, 'output.json'), 'utf-8');
+const output = fs.readFileSync(path.resolve(__dirname, 'output.json'), 'utf-8');
 
 test('Test getFilterCommitsWithSetting', () => {
   /* eslint-disable-next-line no-extend-native */

test/index/index.test.js

@@ -1,16 +1,18 @@
 /* eslint-disable no-undef */
 
-const { readFileSync } = require('fs');
-const { resolve } = require('path');
+const fs = require('fs');
+const path = require('path');
 
 const picklog = require('../../index');
 
-const output = readFileSync(resolve(__dirname, 'output.md'), 'utf-8');
+const output = fs.readFileSync(path.resolve(__dirname, 'output.md'), 'utf-8');
 
-test('Test index.js', () => {
+test('Test index.js', () => new Promise((resolve) => {
   picklog({
     gitLogArgs: 'v1.2.3',
   }).then((text) => {
+    fs.writeFileSync('output.md', text);
     expect(text).toBe(output);
+    resolve();
   });
-});
+}));

test/splitCommitByTag/input.js

@@ -153,7 +153,7 @@ module.exports = [
     cr: '2 days ago',
     ct: '1550065429',
     ci: '2019-02-13 21:43:49 +0800',
-    d: '',
+    d: ' (tag: bugfix)',
     e: '',
     s: 'fix: 修复bin的入口',
     f: 'fix-bin',
@@ -261,7 +261,7 @@ module.exports = [
     cr: '2 days ago',
     ct: '1550062380',
     ci: '2019-02-13 20:53:00 +0800',
-    d: '',
+    d: ' (tag: changelog)',
     e: '',
     s: 'changelog',
     f: 'changelog',

test/splitCommitByTag/output.json

@@ -166,7 +166,7 @@
         "cr": "2 days ago",
         "ct": "1550065429",
         "ci": "2019-02-13 21:43:49 +0800",
-        "d": "",
+        "d": " (tag: bugfix)",
         "e": "",
         "s": "fix: 修复bin的入口",
         "f": "fix-bin",
@@ -282,7 +282,7 @@
         "cr": "2 days ago",
         "ct": "1550062380",
         "ci": "2019-02-13 20:53:00 +0800",
-        "d": "",
+        "d": " (tag: changelog)",
         "e": "",
         "s": "changelog",
         "f": "changelog",

test/splitCommitByTag/splitCommitByTag.test.js

@@ -1,13 +1,21 @@
-/* eslint-disable no-undef */
+/* eslint-disable no-undef,max-len */
 
-const { readFileSync } = require('fs');
-const { resolve } = require('path');
+const fs = require('fs');
+const path = require('path');
 
 const splitCommitByTag = require('../../src/splitCommitByTag.js');
 const commits = require('./input');
 
-const output = readFileSync(resolve(__dirname, 'output.json'), 'utf-8');
+const setting = require('../.picklogrc');
+const settingWithoutTagFilter = require('./without-tag-filter/.picklogrc');
+
+const output = fs.readFileSync(path.resolve(__dirname, 'output.json'), 'utf-8');
+const outputWithoutTagFilter = fs.readFileSync(path.resolve(__dirname, './without-tag-filter/output.json'), 'utf-8');
 
 test('Test splitCommitByTag', () => {
-  expect(JSON.stringify(splitCommitByTag(commits), null, 2)).toBe(output);
+  expect(JSON.stringify(splitCommitByTag(commits, setting), null, 2)).toBe(output);
+});
+
+test('Test splitCommitByTag without tagFilter', () => {
+  expect(JSON.stringify(splitCommitByTag(commits, settingWithoutTagFilter), null, 2)).toBe(outputWithoutTagFilter);
 });

test/splitCommitByTag/without-tag-filter/.picklogrc.js

@@ -0,0 +1,26 @@
+module.exports = {
+  filters: [
+    {
+      name: 'Features',
+      regExp: /^feat(\(.*?\))?:\s/i,
+    },
+    {
+      name: 'Bugfixes',
+      regExp: /^fix(\(.*?\))?:\s/i,
+    },
+    {
+      name: 'Performance Improvements',
+      regExp: /^perf(\(.*?\))?:\s/i,
+    },
+    {
+      name: 'Reverts',
+      regExp: /^revert(\(.*?\))?:\s/i,
+    },
+  ],
+
+  parse(logs) {
+    /* eslint-disable-next-line no-extend-native */
+    RegExp.prototype.toJSON = RegExp.prototype.toString; // JSON.stringify会调用正则表达式的toJSON
+    return JSON.stringify(logs, null, 2);
+  },
+};