feat: publish types (#58)

* feat: publish types

* feat: export types at index.ts

README.md

@@ -69,16 +69,13 @@ module.exports = {
 
 If you love to develop with types, you can use that with `JSDocs`.
 
-```shell
-npm install -D @types/inquirer git-repo-info
-```
-
 ```js
+/**
+ * @typedef {{questionType1: string; questionType2: string}} Answers
+ */
+
+/** @type import('cz-format-extension').Config<Answers> */
 module.exports = {
-  /**
-   * @param {{inquirer: import('inquirer').Inquirer, gitInfo: import('git-repo-info').GitRepoInfo}}
-   * @returns {import('inquirer').QuestionCollection}
-   */
   questions({inquirer, gitInfo}) {
     return [
       {
@@ -92,12 +89,6 @@ module.exports = {
       },
     ]
   },
-  /**
-   * @typedef {{questionType1: string; questionType2: string}} Answers
-   *
-   * @param {{answers: Answers, gitInfo: import('git-repo-info').GitRepoInfo}}
-   * @returns {string}
-   */
   commitMessage({answers, gitInfo}) {
     return `${answers.questionType1}${answers.questionType2}`
   }

package.json

@@ -23,6 +23,7 @@
     }
   ],
   "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "files": [
     "dist"
   ],
@@ -36,13 +37,13 @@
     "typecheck": "tsc --project ./tsconfig.build.json --noEmit"
   },
   "dependencies": {
+    "@types/inquirer": "^7.3.0",
     "cosmiconfig": "^6.0.0",
     "git-repo-info": "^2.1.1",
     "inquirer": "^7.3.3",
     "tslib": "2.0.0"
   },
   "devDependencies": {
-    "@types/inquirer": "^7.3.0",
     "@types/node": "^14.0.27",
     "@typescript-eslint/eslint-plugin": "3.7.1",
     "@typescript-eslint/parser": "3.7.1",

src/engine.ts

@@ -1,13 +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>;
-};
-
-type Commit = (commitMessage: string) => void;
+import { initialize } from "./util";
+import { CZ, Commit } from "./types";
 
 export const engine = () => {
   const { config } = initialize();

src/index.ts

@@ -1,3 +1,3 @@
 import { engine } from "./engine";
-
-export = engine();
+export * from "./types";
+export default engine();

src/types.ts

@@ -0,0 +1,22 @@
+import { Inquirer, QuestionCollection } from "inquirer";
+import { GitRepoInfo } from "git-repo-info";
+
+export type CZ = Inquirer;
+export type Commit = (commitMessage: string) => void;
+
+export type Config<T> = {
+  questions: ({
+    inquirer,
+    gitInfo,
+  }: {
+    inquirer: Inquirer;
+    gitInfo: GitRepoInfo;
+  }) => QuestionCollection;
+  commitMessage: ({
+    answers,
+    gitInfo,
+  }: {
+    answers: T;
+    gitInfo: GitRepoInfo;
+  }) => string;
+};

src/util/initialize.ts

@@ -1,29 +1,11 @@
 import * as Cosmiconfig from "cosmiconfig";
 import * as Const from "./const";
-import { QuestionCollection, Answers, Inquirer } from "inquirer";
-import { GitRepoInfo } from "git-repo-info";
+import { Config } from "../types";
 
 const explorer = Cosmiconfig.cosmiconfigSync(Const.MODULE_NAME);
 
-type Config = {
-  questions: ({
-    inquirer,
-    gitInfo,
-  }: {
-    inquirer: Inquirer;
-    gitInfo: GitRepoInfo;
-  }) => QuestionCollection;
-  commitMessage: ({
-    answers,
-    gitInfo,
-  }: {
-    answers: Answers;
-    gitInfo: GitRepoInfo;
-  }) => string;
-};
-
 type Initialize = {
-  config: Partial<Config>;
+  config: Partial<Config<unknown>>;
 };
 
 export const initialize = (): Initialize => {
@@ -32,6 +14,6 @@ export const initialize = (): Initialize => {
   if (result === null) throw new Error("Could not find config file.");
 
   return {
-    config: result.config as Config,
+    config: result.config as Config<unknown>,
   };
 };

tsconfig.build.json

@@ -1,6 +1,7 @@
 {
   "extends": "./tsconfig.json",
   "compilerOptions": {
-    "removeComments": true
+    "removeComments": true,
+    "declaration": true
   }
 }