feat(init): add lint:types script (#654)

lib/cli.js

@@ -5,7 +5,7 @@ module.exports = function cli() {
   // eslint-disable-next-line no-unused-expressions
   yargs
     .usage("$0 <command>")
-    .command("init", init.desc, {}, init)
+    .command("init", init.desc, {}, () => init())
     .demandCommand(1)
     .strict()
     .alias("help", "h")

lib/init.js

@@ -9,20 +9,45 @@ const write = promisify(fs.writeFile);
 const read = promisify(fs.readFile);
 const mkdir = promisify(fs.mkdir);
 
+/**
+ * @param {string} elem
+ * @param {...string} elems
+ */
 const packagePath = (elem, ...elems) => path.join(...[__dirname, "..", elem, ...elems]);
 
+/** @typedef {(msg: string) => boolean} Logger */
+
+/**
+ * @param {string} baseDir
+ * @param {Logger} logger
+ */
 // eslint-disable-next-line max-lines-per-function
 const initCommand = (baseDir, logger) => {
+  /**
+   * @param {string} elem
+   * @param {...string} elems
+   */
   const currentPath = (elem, ...elems) => path.join(...[baseDir, elem, ...elems]);
 
+  /**
+   * @param {string} fileName
+   */
   const readFile = (fileName) => read(currentPath(fileName), "utf8");
 
+  /**
+   * @param {string} src
+   * @param {string} dest
+   */
   const copyFile = async (src, dest) => {
     await mkdir(path.resolve(dest, ".."), { recursive: true });
     await copy(src, dest);
     logger(`=> \`${path.relative(baseDir, dest)}\` was updated`);
   };
 
+  /**
+   * @param {string} fileName
+   * @param {string} fileContent
+   */
   const writeFile = async (fileName, fileContent) => {
     const file = currentPath(fileName);
     await write(file, `${fileContent}\n`);
@@ -47,23 +72,31 @@ const initCommand = (baseDir, logger) => {
       Object.keys(originalPackage.scripts)
         .filter((key) => !(key === "test" || key.startsWith("test:")))
         .forEach((key) => {
+          // @ts-ignore
           scripts[key] = originalPackage.scripts[key];
         });
 
-      // update other keys
-      const keys = ["husky", "lint-staged", "standard-version", "remarkConfig"];
-      keys.forEach((key) => {
+      /**
+       * @param {"husky" | "lint-staged" | "standard-version" | "remarkConfig"} key
+       */
+      const updateOtherKey = (key) => {
         if (!(key in packageInfo)) {
           packageInfo[key] = {};
         }
         Object.assign(packageInfo[key], originalPackage[key]);
-      });
+      };
+      updateOtherKey("husky");
+      updateOtherKey("lint-staged");
+      updateOtherKey("standard-version");
+      updateOtherKey("remarkConfig");
+
       packageInfo.commitlint = {
         extends: ["@commitlint/config-conventional"],
         rules: {
           "body-max-line-length": [1, "always", 100],
         },
       };
+
       packageInfo.eslintConfig = {
         root: true,
         extends: ["ybiquitous"],
@@ -72,14 +105,22 @@ const initCommand = (baseDir, logger) => {
       await writeFile("package.json", JSON.stringify(packageInfo, null, 2));
     },
 
+    /**
+     * @param {string} name
+     * @param {...string} names
+     */
     async writePackageFile(name, ...names) {
       await copyFile(packagePath(name, ...names), currentPath(name, ...names));
     },
   };
 };
 
+/** @type {Logger} */
 const defaultLogger = (msg) => process.stdout.write(`${msg}${EOL}`);
 
+/**
+ * @param {{ cwd?: string, logger?: Logger }} params
+ */
 module.exports = async function init({ cwd = process.cwd(), logger = defaultLogger } = {}) {
   const cmd = initCommand(cwd, logger);
 

package.json

@@ -42,11 +42,14 @@
     "yargs": "^15.4.1"
   },
   "devDependencies": {
+    "@types/node": "^14.0.27",
+    "@types/yargs": "^15.0.5",
     "eslint-config-ybiquitous": "^11.0.0",
     "fs-extra": "^9.0.1",
     "nodemon": "^2.0.4",
     "nyc": "^15.1.0",
-    "tape": "^5.0.1"
+    "tape": "^5.0.1",
+    "typescript": "^3.9.7"
   },
   "scripts": {
     "test": "nyc --check-coverage --lines 100 --branches 90 tape \"test/**/*.test.js\"",
@@ -56,6 +59,7 @@
     "lint:js:fix": "npm run lint:js -- --fix",
     "lint:md": "remark . --frail",
     "lint:md:fix": "remark . --output",
+    "lint:types": "tsc --noEmit",
     "lint": "npm-run-all --print-label --parallel lint:*",
     "prettier": "prettier --ignore-path .gitignore .",
     "prettier:check": "npm run prettier -- --check",

test/fixtures/package-empty_expected.json

@@ -7,6 +7,7 @@
     "lint:js:fix": "npm run lint:js -- --fix",
     "lint:md": "remark . --frail",
     "lint:md:fix": "remark . --output",
+    "lint:types": "tsc --noEmit",
     "lint": "npm-run-all --print-label --parallel lint:*",
     "prettier": "prettier --ignore-path .gitignore .",
     "prettier:check": "npm run prettier -- --check",

test/fixtures/package-normal_expected.json

@@ -7,6 +7,7 @@
     "lint:js:fix": "npm run lint:js -- --fix",
     "lint:md": "remark . --frail",
     "lint:md:fix": "remark . --output",
+    "lint:types": "tsc --noEmit",
     "lint": "npm-run-all --print-label --parallel lint:*",
     "prettier": "prettier --ignore-path .gitignore .",
     "prettier:check": "npm run prettier -- --check",

tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "checkJs": true,
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true
+  },
+  "include": ["lib"]
+}