feat: 增加picklog init来协助初始化 .picklogrc 文件

Author: BearJ

.picklogrc.js

@@ -1,4 +1,4 @@
-const origin = 'https://github.com/BearJ/picklog';
+const origin = 'https://BearJ@github.com/BearJ/picklog';
 const comparePath = `${origin}/compare/`;
 const commitPath = `${origin}/commit/`;
 
@@ -19,35 +19,35 @@ module.exports = {
     {
       name: 'Reverts',
       regExp: /^revert(\(.*?\))?:\s/i,
-    }
+    },
   ],
-  parse(picklog){
+  parse(picklog) {
     // RegExp.prototype.toJSON = RegExp.prototype.toString; // JSON.stringify会调用正则表达式的toJSON
     // return JSON.stringify(picklog, null, 2);
 
     let output = '';
 
     picklog.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)}`;
 
-      output += `### [${log.tag}](${comparePath}${log.previousTag || ''}...${log.tag}) (${date})\n\n`;
+      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) => {
-          const regExp = result.filter.regExp;
+          const { regExp } = result.filter;
           let subject = commit.s.match(regExp) || '';
 
-          if(subject[1]){
+          if (subject[1]) {
             const type = subject[1].match(/\((.*?)\)/)[1];
-
             subject = `**${type}:** ${commit.s.replace(regExp, '')}`;
-          }else{
+          } else {
             subject = commit.s.replace(regExp, '');
           }
-
           output += `* ${subject}([${commit.h}](${commitPath}${commit.h}))\n`;
         });
 

bin/.picklogrc.js

@@ -0,0 +1,62 @@
+const origin = '<%= GitURL %>';
+const comparePath = `${origin}/compare/`;
+const commitPath = `${origin}/commit/`;
+
+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(picklog) {
+    // RegExp.prototype.toJSON = RegExp.prototype.toString; // JSON.stringify会调用正则表达式的toJSON
+    // return JSON.stringify(picklog, null, 2);
+
+    let output = '';
+
+    picklog.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) => {
+          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 += '\n';
+      });
+
+      output += '\n\n';
+    });
+
+    return output;
+  },
+};

bin/picklog.js

@@ -3,12 +3,29 @@
 const fs = require('fs');
 const { resolve } = require('path');
 const yargs = require('yargs');
+const git = require('simple-git')();
 const picklog = require('../index');
 
+function initPicklog() {
+  try {
+    fs.accessSync(resolve('.picklogrc.js'));
+    console.log('File .picklogrc is in your project, so it\'s no need to init.');
+  } catch (err) {
+    git.raw(['config', '--get', 'remote.origin.url'], (err, result) => {
+      if (err) throw err;
+
+      const gitUrl = result.replace(/\n/g, '').replace(/\.git$/, '');
+      fs.writeFileSync('.picklogrc.js', fs.readFileSync(resolve(__dirname, '.picklogrc.js'), 'utf-8').replace(/<%= GitURL %>/, gitUrl));
+      console.log('Init Success!');
+    });
+  }
+}
+
 const { argv } = yargs
   .alias('h', 'help')
   .alias('v', 'version')
 
+  .command('init', 'Generator a .picklogrc file.')
   .option('g', {
     alias: 'gitLogArgs',
     describe: 'Pass the arg to "git log". Splited by comma. e.g: picklog -g v2.0.0',
@@ -27,23 +44,28 @@ const { argv } = yargs
     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._.indexOf('init') > -1) {
+  initPicklog();
+} else {
+  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;
-}
+  if (argv.write && typeof argv.write !== 'string') {
+    console.warn('Please type a file name. eg: picklog -w changelog.md');
+    return;
+  }
 
-picklog(argv)
-  .then((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);
-    }
-  });
+
+  picklog(argv)
+    .then((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);
+      }
+    });
+}