feat(types): publish type declarations

lib/index.js

@@ -0,0 +1,3 @@
+const { init } = require("./init");
+
+module.exports.init = init;

lib/init.js

@@ -17,7 +17,7 @@ const packagePath = (elem, ...elems) => path.join(...[__dirname, "..", elem, ...
 
 /**
  * @param {string} baseDir
- * @param {import("ybiq").Logger} logger
+ * @param {import("../types/ybiq").Logger} logger
  */
 // eslint-disable-next-line max-lines-per-function
 const initCommand = (baseDir, logger) => {
@@ -113,9 +113,7 @@ const initCommand = (baseDir, logger) => {
   };
 };
 
-/**
- * @param {import("ybiq").CommandParams} params
- */
+/** @type {import("../types/ybiq").InitCommand} */
 async function init({ cwd = process.cwd(), logger = defaultLogger } = {}) {
   const cmd = initCommand(cwd, logger);
 

lib/logger.js

@@ -1,4 +1,6 @@
 const { EOL } = require("os");
 
-/** @type {import("ybiq").Logger} */
-module.exports.defaultLogger = (msg) => process.stdout.write(`${msg}${EOL}`);
+/** @type {import("../types/ybiq").Logger} */
+module.exports.defaultLogger = (msg) => {
+  process.stdout.write(`${msg}${EOL}`);
+};

package.json

@@ -11,11 +11,13 @@
     "utility",
     "tool"
   ],
-  "main": "index.js",
+  "main": "lib/index.js",
   "bin": "bin/cli.js",
+  "types": "types/ybiq.d.ts",
   "files": [
     "bin",
     "lib",
+    "types",
     ".editorconfig",
     ".remarkignore",
     ".github/workflows/commitlint.yml",
@@ -52,9 +54,10 @@
     "typescript": "^3.9.7"
   },
   "scripts": {
-    "test": "nyc --check-coverage --lines 100 --branches 90 tape \"test/**/*.test.js\"",
+    "test": "nyc --check-coverage --lines 100 --branches 90 tape \"test/**/*.test.js\" && npm run test:types",
     "test:watch": "nodemon --ext js,json --watch . --exec \"tape test/**/*.test.js\"",
     "test:coverage": "nyc report --reporter=html",
+    "test:types": "tsc --project test/tsconfig.test.json --noEmit",
     "lint:js": "eslint .",
     "lint:js:fix": "npm run lint:js -- --fix",
     "lint:md": "remark . --frail",
@@ -132,15 +135,15 @@
           "release",
           "remark",
           "standard-version",
-          "travis"
+          "types"
         ]
       ]
     }
   },
   "eslintConfig": {
     "root": true,
     "ignorePatterns": [
-      "*.d.ts"
+      "*.ts"
     ],
     "extends": [
       "ybiquitous/node"

test/tsconfig.test.json

@@ -0,0 +1,6 @@
+{
+  "compilerOptions": {
+    "strict": true
+  },
+  "include": ["./**/*.test.ts"]
+}

test/types.test.ts

@@ -0,0 +1,6 @@
+import * as ybiq from "..";
+
+ybiq.init().then(() => console.log("none"));
+ybiq.init({ cwd: "lib" }).then(() => console.log("none"));
+ybiq.init({ logger: (msg: string) => {} }).then(() => console.log("none"));
+ybiq.init({ cwd: "lib", logger: (msg: string) => {} }).then(() => console.log("none"));

tsconfig.json

@@ -11,5 +11,5 @@
     "forceConsistentCasingInFileNames": true,
     "resolveJsonModule": true
   },
-  "include": ["lib", "types"]
+  "include": ["lib/**/*", "types/**/*"]
 }

types/ybiq.d.ts

@@ -1,4 +1,5 @@
-declare module "ybiq" {
-  type Logger = (msg: string) => any;
-  type CommandParams = { cwd?: string; logger?: Logger };
-}
+export type Logger = (msg: string) => void;
+export type CommandParams = { cwd?: string; logger?: Logger };
+
+export declare function init(params?: CommandParams): Promise<void>;
+type InitCommand = typeof init;