feat: 使用git log来获取每个tag之间的commit，解决如果有merge的时候，commit会拉不全的问题。

Author: BearJ

.eslintrc.js

@@ -11,5 +11,6 @@ module.exports = {
     'no-param-reassign': ['error', { 'props': false }], // 允许修改入参的属性
     'no-continue': 'off', // 在我的代码里，continue; 就类似于 return; 的作用
     'no-labels': 'off', // 在我的代码里，就类似于 return; 的作用
+    'no-trailing-spaces': 'off',
   }
 };

.picklogrc.js

@@ -29,7 +29,7 @@ module.exports = {
 
     picklog.forEach((log) => {
       let date = new Date(log.timestamp * 1000);
-      date = `${date.getFullYear()}-${('0' + (date.getMonth() + 1)).substr(-2)}-${('' + date.getDate()).substr(-2)}`;
+      date = `${date.getFullYear()}-${('0' + (date.getMonth() + 1)).substr(-2)}-${('0' + date.getDate()).substr(-2)}`;
 
       output += `### [${log.tag}](${comparePath}${log.previousTag || ''}...${log.tag}) (${date})\n\n`;
 
@@ -59,4 +59,4 @@ module.exports = {
 
     return output;
   },
-};
+};

bin/picklog.js

@@ -1,8 +1,49 @@
 #!/usr/bin/env node
 
+const fs = require('fs');
+const { resolve } = require('path');
+const yargs = require('yargs');
 const picklog = require('../index');
 
-picklog(process.argv.slice(2))
+const { argv } = yargs
+  .alias('h', 'help')
+  .alias('v', 'version')
+
+  .option('g', {
+    alias: 'gitLogArgs',
+    describe: 'Pass the arg to "git log". Splited by comma. e.g: picklog -g v2.0.0',
+  })
+  .option('l', {
+    alias: 'latest',
+    describe: 'Only pick latest changes after the last tag.',
+  })
+
+  .option('w', {
+    alias: 'write',
+    describe: 'Append stdout to this file.',
+  })
+  .option('o', {
+    alias: 'overwrite',
+    describe: 'Overwrite stdout to this file.',
+  });
+
+if (argv.overwrite && typeof argv.overwrite !== 'string') {
+  console.warn('Please type a file name. eg: picklog -o changelog.md');
+  return;
+}
+
+if (argv.write && typeof argv.write !== 'string') {
+  console.warn('Please type a file name. eg: picklog -w changelog.md');
+  return;
+}
+
+picklog(argv)
   .then((commits) => {
-    process.stdout.write(commits);
+    if (argv.overwrite) {
+      fs.writeFileSync(resolve(argv.overwrite), commits, 'utf8');
+    } else if (argv.write) {
+      fs.writeFileSync(resolve(argv.write), commits + fs.readFileSync(resolve(argv.write), 'utf8'));
+    } else {
+      console.log(commits);
+    }
   });

index.js

@@ -1,40 +1,15 @@
 const fs = require('fs');
 const path = require('path');
-const getCommits = require('./lib/getCommits');
-const getLatestCommits = require('./lib/getLatestCommits');
+const getCommits = require('./src/getCommits');
+const defaultSetting = require('./src/lib/defaultSetting');
 
-const defaultSetting = {
-  filters: [
-    {
-      name: 'Features',
-      regExp: /^feat(\(.*?\))?:\s/i,
-    },
-    {
-      name: 'Bugfixes',
-      regExp: /^fix(\(.*?\))?:\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);
-  },
-};
-
-function picklog(_args = []) {
-  let args = _args;
-  let isLatest = false;
+function picklog(_args) {
+  const args = Object.assign({
+    gitLogArgs: '', // 透传给命令 git log 的参数
+    latest: false, // 是否只取上一个tag后的commit
+  }, _args);
   let setting;
 
-  if (typeof args === 'string') {
-    args = args.split(' ');
-  }
-
-  if (args.indexOf('--latest') > -1) {
-    isLatest = true;
-    args.splice(args.indexOf('--latest'), 1);
-  }
-
   try {
     fs.accessSync(path.resolve('.picklogrc.js'));
     setting = require(path.resolve('.picklogrc.js')); // eslint-disable-line global-require,import/no-dynamic-require
@@ -43,17 +18,13 @@ function picklog(_args = []) {
   }
 
   return new Promise((resolve) => {
-    getCommits(args, setting)
-      .then((commits) => {
-        if (isLatest) {
-          getLatestCommits(commits, setting).then((latestCommits) => {
-            resolve(setting.parse(latestCommits));
-          });
-        } else {
-          resolve(setting.parse(commits));
-        }
-      });
+    getCommits(args, setting).then((commits) => {
+      resolve(setting.parse(commits));
+    });
   });
 }
 
+// picklog().then((commitStr) => {
+//   fs.writeFileSync('bear.md', commitStr);
+// });
 module.exports = picklog;