feat: add git-repo-info (#56)

README.md

@@ -40,45 +40,46 @@ Make `.czferc.js`
 
 ```js
 module.exports = {
-  questions(inquirer) {
+  questions({inquirer, gitInfo}) {
     return [
       {...},
       {...},
     ]
   },
-  commitMessage(answers) {
+  commitMessage({answers, gitInfo}) {
     return ...
   }
 }
 ```
 
 - questions
   - params
-    - ([inquirer](https://github.com/SBoudrias/Inquirer.js))
+    - [inquirer](https://github.com/SBoudrias/Inquirer.js)
+    - [gitInfo](https://github.com/rwjblue/git-repo-info)
   - return
     - [Question Object](https://github.com/SBoudrias/Inquirer.js#question)
 - commitMessage
   - params
     - [answers](https://github.com/SBoudrias/Inquirer.js#answers)
+    - [gitInfo](https://github.com/rwjblue/git-repo-info)
   - return
     - string
 
 #### Tips: Configuration settings with types
 
-If you love to develop with types, you can use that with `JSDoc`.
-You should install `@types/inquirer`.
+If you love to develop with types, you can use that with `JSDocs`.
 
 ```shell
-npm install -D @types/inquirer
+npm install -D @types/inquirer git-repo-info
 ```
 
 ```js
 module.exports = {
   /**
-   * @param {import('inquirer').Inquirer} inquirer
+   * @param {{inquirer: import('inquirer').Inquirer, gitInfo: import('git-repo-info').GitRepoInfo}}
    * @returns {import('inquirer').QuestionCollection}
    */
-  questions(inquirer) {
+  questions({inquirer, gitInfo}) {
     return [
       {
         type: "list",
@@ -94,10 +95,10 @@ module.exports = {
   /**
    * @typedef {{questionType1: string; questionType2: string}} Answers
    *
-   * @param {Answers} answers
+   * @param {{answers: Answers, gitInfo: import('git-repo-info').GitRepoInfo}}
    * @returns {string}
    */
-  commitMessage(answers) {
+  commitMessage({answers, gitInfo}) {
     return `${answers.questionType1}${answers.questionType2}`
   }
 }

package.json

@@ -37,6 +37,7 @@
   },
   "dependencies": {
     "cosmiconfig": "^6.0.0",
+    "git-repo-info": "^2.1.1",
     "inquirer": "^7.3.3",
     "tslib": "2.0.0"
   },

src/engine.ts

@@ -1,6 +1,7 @@
 import { QuestionCollection } from "inquirer";
 import { initialize } from "./util";
 import * as inquirer from "inquirer";
+import getRepoInfo from "git-repo-info";
 
 type CZ = {
   prompt: <T>(questions: QuestionCollection<T>) => Promise<T>;
@@ -10,22 +11,25 @@ type Commit = (commitMessage: string) => void;
 
 export const engine = () => {
   const { config } = initialize();
+  const gitInfo = getRepoInfo();
 
   const prompter = (cz: CZ, commit: Commit) => {
     if (config.questions === undefined)
       throw new Error("Could not find questions.");
 
-    return cz.prompt(config.questions(inquirer)).then((answers) => {
-      if (config.commitMessage === undefined)
-        throw new Error("Could not find commitMessage.");
+    return cz
+      .prompt(config.questions({ inquirer, gitInfo }))
+      .then((answers) => {
+        if (config.commitMessage === undefined)
+          throw new Error("Could not find commitMessage.");
 
-      const commitMessage = config.commitMessage(answers);
+        const commitMessage = config.commitMessage({ answers, gitInfo });
 
-      if (typeof commitMessage !== "string")
-        throw new Error("commitMessage should return string.");
+        if (typeof commitMessage !== "string")
+          throw new Error("commitMessage should return string.");
 
-      commit(commitMessage);
-    });
+        commit(commitMessage);
+      });
   };
 
   return {

src/util/initialize.ts

@@ -1,12 +1,25 @@
 import * as Cosmiconfig from "cosmiconfig";
 import * as Const from "./const";
 import { QuestionCollection, Answers, Inquirer } from "inquirer";
+import { GitRepoInfo } from "git-repo-info";
 
 const explorer = Cosmiconfig.cosmiconfigSync(Const.MODULE_NAME);
 
 type Config = {
-  questions: (inquirer: Inquirer) => QuestionCollection;
-  commitMessage: (answers: Answers) => string;
+  questions: ({
+    inquirer,
+    gitInfo,
+  }: {
+    inquirer: Inquirer;
+    gitInfo: GitRepoInfo;
+  }) => QuestionCollection;
+  commitMessage: ({
+    answers,
+    gitInfo,
+  }: {
+    answers: Answers;
+    gitInfo: GitRepoInfo;
+  }) => string;
 };
 
 type Initialize = {