typia 8.0.0 → 8.0.2-dev.20250314

package/src/executable/TypiaPatchWizard.ts

@@ -1,45 +1,45 @@
-import fs from "fs";
-
-export namespace TypiaPatchWizard {
-  export const main = async (): Promise<void> => {
-    console.log("----------------------------------------");
-    console.log(" Typia Setup Wizard");
-    console.log("----------------------------------------");
-    console.log(
-      [
-        `Since TypeScript v5.3 update, "tsc" no more parses JSDoc comments.`,
-        ``,
-        `Therefore, "typia" revives the JSDoc parsing feature by patching "tsc".`,
-        ``,
-        `This is a temporary feature of "typia", and it would be removed when "ts-patch" being updated.`,
-      ].join("\n"),
-    );
-
-    await patch();
-  };
-
-  export const patch = async (): Promise<void> => {
-    for (const file of ["tsc.js", "_tsc.js"])
-      try {
-        const location: string = require.resolve(`typescript/lib/${file}`);
-        const content: string = await fs.promises.readFile(location, "utf8");
-        if (content.indexOf(FROM_WITH_COMMENT) !== -1)
-          await fs.promises.writeFile(
-            location,
-            content.replace(FROM_WITH_COMMENT, TO_WITH_COMMENT),
-            "utf8",
-          );
-        else if (content.indexOf(FROM_ONLY) !== -1)
-          await fs.promises.writeFile(
-            location,
-            content.replace(FROM_ONLY, TO_ONLY),
-            "utf8",
-          );
-      } catch {}
-  };
-}
-
-const FROM_WITH_COMMENT = `var defaultJSDocParsingMode = 2 /* ParseForTypeErrors */`;
-const TO_WITH_COMMENT = `var defaultJSDocParsingMode = 0 /* ParseAll */`;
-const FROM_ONLY = `var defaultJSDocParsingMode = 2`;
-const TO_ONLY = `var defaultJSDocParsingMode = 0`;
+import fs from "fs";
+
+export namespace TypiaPatchWizard {
+  export const main = async (): Promise<void> => {
+    console.log("----------------------------------------");
+    console.log(" Typia Setup Wizard");
+    console.log("----------------------------------------");
+    console.log(
+      [
+        `Since TypeScript v5.3 update, "tsc" no more parses JSDoc comments.`,
+        ``,
+        `Therefore, "typia" revives the JSDoc parsing feature by patching "tsc".`,
+        ``,
+        `This is a temporary feature of "typia", and it would be removed when "ts-patch" being updated.`,
+      ].join("\n"),
+    );
+
+    await patch();
+  };
+
+  export const patch = async (): Promise<void> => {
+    for (const file of ["tsc.js", "_tsc.js"])
+      try {
+        const location: string = require.resolve(`typescript/lib/${file}`);
+        const content: string = await fs.promises.readFile(location, "utf8");
+        if (content.indexOf(FROM_WITH_COMMENT) !== -1)
+          await fs.promises.writeFile(
+            location,
+            content.replace(FROM_WITH_COMMENT, TO_WITH_COMMENT),
+            "utf8",
+          );
+        else if (content.indexOf(FROM_ONLY) !== -1)
+          await fs.promises.writeFile(
+            location,
+            content.replace(FROM_ONLY, TO_ONLY),
+            "utf8",
+          );
+      } catch {}
+  };
+}
+
+const FROM_WITH_COMMENT = `var defaultJSDocParsingMode = 2 /* ParseForTypeErrors */`;
+const TO_WITH_COMMENT = `var defaultJSDocParsingMode = 0 /* ParseAll */`;
+const FROM_ONLY = `var defaultJSDocParsingMode = 2`;
+const TO_ONLY = `var defaultJSDocParsingMode = 0`;

package/src/executable/TypiaSetupWizard.ts

@@ -1,171 +1,171 @@
-import fs from "fs";
-import { DetectResult, detect } from "package-manager-detector";
-
-import { ArgumentParser } from "./setup/ArgumentParser";
-import { CommandExecutor } from "./setup/CommandExecutor";
-import { PackageManager } from "./setup/PackageManager";
-import { PluginConfigurator } from "./setup/PluginConfigurator";
-
-export namespace TypiaSetupWizard {
-  export interface IArguments {
-    manager: "npm" | "pnpm" | "yarn" | "bun";
-    project: string | null;
-  }
-
-  export const setup = async (): Promise<void> => {
-    console.log("----------------------------------------");
-    console.log(" Typia Setup Wizard");
-    console.log("----------------------------------------");
-
-    // PREPARE ASSETS
-    const pack: PackageManager = await PackageManager.mount();
-    const args: IArguments = await ArgumentParser.parse(pack, inquiry);
-
-    // INSTALL TYPESCRIPT COMPILERS
-    pack.install({
-      dev: true,
-      modulo: "typescript",
-      version: await getTypeScriptVersion(),
-    });
-    pack.install({ dev: true, modulo: "ts-patch", version: "latest" });
-    args.project ??= (() => {
-      const runner: string = pack.manager === "npm" ? "npx" : pack.manager;
-      CommandExecutor.run(`${runner} tsc --init`);
-      return (args.project = "tsconfig.json");
-    })();
-
-    // SETUP TRANSFORMER
-    await pack.save((data) => {
-      // COMPOSE PREPARE COMMAND
-      data.scripts ??= {};
-      if (
-        typeof data.scripts.prepare === "string" &&
-        data.scripts.prepare.trim().length !== 0
-      ) {
-        if (data.scripts.prepare.includes("ts-patch install") === false)
-          data.scripts.prepare = "ts-patch install && " + data.scripts.prepare;
-      } else data.scripts.prepare = "ts-patch install";
-
-      // NO MORE "typia patch" REQUIRED
-      data.scripts.prepare = data.scripts.prepare
-        .split("&&")
-        .map((str) => str.trim())
-        .filter((str) => str !== "typia patch")
-        .join(" && ");
-
-      // FOR OLDER VERSIONS
-      if (typeof data.scripts.postinstall === "string") {
-        data.scripts.postinstall = data.scripts.postinstall
-          .split("&&")
-          .map((str) => str.trim())
-          .filter((str) => str.indexOf("ts-patch install") === -1)
-          .join(" && ");
-        if (data.scripts.postinstall.length === 0)
-          delete data.scripts.postinstall;
-      }
-    });
-
-    // CONFIGURE TYPIA
-    await PluginConfigurator.configure(args);
-    CommandExecutor.run(`${pack.manager} run prepare`);
-  };
-
-  const inquiry: ArgumentParser.Inquiry<IArguments> = async (
-    pack,
-    command,
-    prompt,
-    action,
-  ) => {
-    // PREPARE ASSETS
-    command.option("--manager [manager", "package manager");
-    command.option("--project [project]", "tsconfig.json file location");
-
-    // INTERNAL PROCEDURES
-    const questioned = { value: false };
-    const select =
-      (name: string) =>
-      (message: string) =>
-      async <Choice extends string>(
-        choices: Choice[],
-        filter?: (choice: string) => Choice,
-      ): Promise<Choice> => {
-        questioned.value = true;
-        return (
-          await prompt()({
-            type: "list",
-            name: name,
-            message: message,
-            choices: choices,
-            ...(filter ? { filter } : {}),
-          })
-        )[name];
-      };
-    const configure = async (): Promise<string | null> => {
-      const fileList: string[] = await (
-        await fs.promises.readdir(process.cwd())
-      )
-        .filter(
-          (str) =>
-            str.substring(0, 8) === "tsconfig" &&
-            str.substring(str.length - 5) === ".json",
-        )
-        .sort((x, y) =>
-          x === "tsconfig.json"
-            ? -1
-            : y === "tsconfig.json"
-              ? 1
-              : x < y
-                ? -1
-                : 1,
-        );
-      if (fileList.length === 0) {
-        if (process.cwd() !== pack.directory)
-          throw new URIError(`Unable to find "tsconfig.json" file.`);
-        return null;
-      } else if (fileList.length === 1) return fileList[0]!;
-      return select("tsconfig")("TS Config File")(fileList);
-    };
-
-    // DO CONSTRUCT
-    return action(async (options) => {
-      pack.manager = options.manager ??=
-        (await detectManager()) ??
-        (await select("manager")("Package Manager")(
-          [
-            "npm" as const,
-            "pnpm" as const,
-            "bun" as const,
-            "yarn (berry is not supported)" as "yarn",
-          ],
-          (value) => value.split(" ")[0] as "yarn",
-        ));
-      options.project ??= await configure();
-
-      if (questioned.value) console.log("");
-      return options as IArguments;
-    });
-  };
-
-  const detectManager = async (): Promise<
-    "npm" | "pnpm" | "yarn" | "bun" | null
-  > => {
-    const result: DetectResult | null = await detect({ cwd: process.cwd() });
-    switch (result?.name) {
-      case "npm":
-      case "deno":
-        return null; // NPM case is still selectable & Deno is not supported
-      default:
-        return result?.name ?? null;
-    }
-  };
-
-  const getTypeScriptVersion = async (): Promise<string> => {
-    const content: string = await fs.promises.readFile(
-      `${__dirname}/../../package.json`,
-      "utf-8",
-    );
-    const json: { devDependencies: { typescript: string } } =
-      JSON.parse(content);
-    return json.devDependencies.typescript;
-  };
-}
+import fs from "fs";
+import { DetectResult, detect } from "package-manager-detector";
+
+import { ArgumentParser } from "./setup/ArgumentParser";
+import { CommandExecutor } from "./setup/CommandExecutor";
+import { PackageManager } from "./setup/PackageManager";
+import { PluginConfigurator } from "./setup/PluginConfigurator";
+
+export namespace TypiaSetupWizard {
+  export interface IArguments {
+    manager: "npm" | "pnpm" | "yarn" | "bun";
+    project: string | null;
+  }
+
+  export const setup = async (): Promise<void> => {
+    console.log("----------------------------------------");
+    console.log(" Typia Setup Wizard");
+    console.log("----------------------------------------");
+
+    // PREPARE ASSETS
+    const pack: PackageManager = await PackageManager.mount();
+    const args: IArguments = await ArgumentParser.parse(pack, inquiry);
+
+    // INSTALL TYPESCRIPT COMPILERS
+    pack.install({
+      dev: true,
+      modulo: "typescript",
+      version: await getTypeScriptVersion(),
+    });
+    pack.install({ dev: true, modulo: "ts-patch", version: "latest" });
+    args.project ??= (() => {
+      const runner: string = pack.manager === "npm" ? "npx" : pack.manager;
+      CommandExecutor.run(`${runner} tsc --init`);
+      return (args.project = "tsconfig.json");
+    })();
+
+    // SETUP TRANSFORMER
+    await pack.save((data) => {
+      // COMPOSE PREPARE COMMAND
+      data.scripts ??= {};
+      if (
+        typeof data.scripts.prepare === "string" &&
+        data.scripts.prepare.trim().length !== 0
+      ) {
+        if (data.scripts.prepare.includes("ts-patch install") === false)
+          data.scripts.prepare = "ts-patch install && " + data.scripts.prepare;
+      } else data.scripts.prepare = "ts-patch install";
+
+      // NO MORE "typia patch" REQUIRED
+      data.scripts.prepare = data.scripts.prepare
+        .split("&&")
+        .map((str) => str.trim())
+        .filter((str) => str !== "typia patch")
+        .join(" && ");
+
+      // FOR OLDER VERSIONS
+      if (typeof data.scripts.postinstall === "string") {
+        data.scripts.postinstall = data.scripts.postinstall
+          .split("&&")
+          .map((str) => str.trim())
+          .filter((str) => str.indexOf("ts-patch install") === -1)
+          .join(" && ");
+        if (data.scripts.postinstall.length === 0)
+          delete data.scripts.postinstall;
+      }
+    });
+
+    // CONFIGURE TYPIA
+    await PluginConfigurator.configure(args);
+    CommandExecutor.run(`${pack.manager} run prepare`);
+  };
+
+  const inquiry: ArgumentParser.Inquiry<IArguments> = async (
+    pack,
+    command,
+    prompt,
+    action,
+  ) => {
+    // PREPARE ASSETS
+    command.option("--manager [manager", "package manager");
+    command.option("--project [project]", "tsconfig.json file location");
+
+    // INTERNAL PROCEDURES
+    const questioned = { value: false };
+    const select =
+      (name: string) =>
+      (message: string) =>
+      async <Choice extends string>(
+        choices: Choice[],
+        filter?: (choice: string) => Choice,
+      ): Promise<Choice> => {
+        questioned.value = true;
+        return (
+          await prompt()({
+            type: "list",
+            name: name,
+            message: message,
+            choices: choices,
+            ...(filter ? { filter } : {}),
+          })
+        )[name];
+      };
+    const configure = async (): Promise<string | null> => {
+      const fileList: string[] = await (
+        await fs.promises.readdir(process.cwd())
+      )
+        .filter(
+          (str) =>
+            str.substring(0, 8) === "tsconfig" &&
+            str.substring(str.length - 5) === ".json",
+        )
+        .sort((x, y) =>
+          x === "tsconfig.json"
+            ? -1
+            : y === "tsconfig.json"
+              ? 1
+              : x < y
+                ? -1
+                : 1,
+        );
+      if (fileList.length === 0) {
+        if (process.cwd() !== pack.directory)
+          throw new URIError(`Unable to find "tsconfig.json" file.`);
+        return null;
+      } else if (fileList.length === 1) return fileList[0]!;
+      return select("tsconfig")("TS Config File")(fileList);
+    };
+
+    // DO CONSTRUCT
+    return action(async (options) => {
+      pack.manager = options.manager ??=
+        (await detectManager()) ??
+        (await select("manager")("Package Manager")(
+          [
+            "npm" as const,
+            "pnpm" as const,
+            "bun" as const,
+            "yarn (berry is not supported)" as "yarn",
+          ],
+          (value) => value.split(" ")[0] as "yarn",
+        ));
+      options.project ??= await configure();
+
+      if (questioned.value) console.log("");
+      return options as IArguments;
+    });
+  };
+
+  const detectManager = async (): Promise<
+    "npm" | "pnpm" | "yarn" | "bun" | null
+  > => {
+    const result: DetectResult | null = await detect({ cwd: process.cwd() });
+    switch (result?.name) {
+      case "npm":
+      case "deno":
+        return null; // NPM case is still selectable & Deno is not supported
+      default:
+        return result?.name ?? null;
+    }
+  };
+
+  const getTypeScriptVersion = async (): Promise<string> => {
+    const content: string = await fs.promises.readFile(
+      `${__dirname}/../../package.json`,
+      "utf-8",
+    );
+    const json: { devDependencies: { typescript: string } } =
+      JSON.parse(content);
+    return json.devDependencies.typescript;
+  };
+}

package/src/executable/setup/ArgumentParser.ts

@@ -1,42 +1,42 @@
-import commander from "commander";
-import inquirer from "inquirer";
-
-import { PackageManager } from "./PackageManager";
-
-export namespace ArgumentParser {
-  export type Inquiry<T> = (
-    pack: PackageManager,
-    command: commander.Command,
-    prompt: (opt?: inquirer.StreamOptions) => inquirer.PromptModule,
-    action: (closure: (options: Partial<T>) => Promise<T>) => Promise<T>,
-  ) => Promise<T>;
-
-  export const parse = async <T>(
-    pack: PackageManager,
-    inquiry: (
-      pack: PackageManager,
-      command: commander.Command,
-      prompt: (opt?: inquirer.StreamOptions) => inquirer.PromptModule,
-      action: (closure: (options: Partial<T>) => Promise<T>) => Promise<T>,
-    ) => Promise<T>,
-  ): Promise<T> => {
-    // TAKE OPTIONS
-    const action = (closure: (options: Partial<T>) => Promise<T>) =>
-      new Promise<T>((resolve, reject) => {
-        commander.program.action(async (options) => {
-          try {
-            resolve(await closure(options));
-          } catch (exp) {
-            reject(exp);
-          }
-        });
-        commander.program.parseAsync().catch(reject);
-      });
-    return inquiry(
-      pack,
-      commander.program,
-      inquirer.createPromptModule,
-      action,
-    );
-  };
-}
+import commander from "commander";
+import inquirer from "inquirer";
+
+import { PackageManager } from "./PackageManager";
+
+export namespace ArgumentParser {
+  export type Inquiry<T> = (
+    pack: PackageManager,
+    command: commander.Command,
+    prompt: (opt?: inquirer.StreamOptions) => inquirer.PromptModule,
+    action: (closure: (options: Partial<T>) => Promise<T>) => Promise<T>,
+  ) => Promise<T>;
+
+  export const parse = async <T>(
+    pack: PackageManager,
+    inquiry: (
+      pack: PackageManager,
+      command: commander.Command,
+      prompt: (opt?: inquirer.StreamOptions) => inquirer.PromptModule,
+      action: (closure: (options: Partial<T>) => Promise<T>) => Promise<T>,
+    ) => Promise<T>,
+  ): Promise<T> => {
+    // TAKE OPTIONS
+    const action = (closure: (options: Partial<T>) => Promise<T>) =>
+      new Promise<T>((resolve, reject) => {
+        commander.program.action(async (options) => {
+          try {
+            resolve(await closure(options));
+          } catch (exp) {
+            reject(exp);
+          }
+        });
+        commander.program.parseAsync().catch(reject);
+      });
+    return inquiry(
+      pack,
+      commander.program,
+      inquirer.createPromptModule,
+      action,
+    );
+  };
+}

package/src/executable/setup/CommandExecutor.ts

@@ -1,8 +1,8 @@
-import cp from "child_process";
-
-export namespace CommandExecutor {
-  export const run = (str: string): void => {
-    console.log(`\n$ ${str}`);
-    cp.execSync(str, { stdio: "inherit" });
-  };
-}
+import cp from "child_process";
+
+export namespace CommandExecutor {
+  export const run = (str: string): void => {
+    console.log(`\n$ ${str}`);
+    cp.execSync(str, { stdio: "inherit" });
+  };
+}

package/src/executable/setup/FileRetriever.ts

@@ -1,19 +1,19 @@
-import fs from "fs";
-import path from "path";
-
-export namespace FileRetriever {
-  export const directory = (props: {
-    file: string;
-    location: string;
-    depth?: number;
-  }): string | null => {
-    const location: string = path.join(props.location, props.file);
-    if (fs.existsSync(location)) return props.location;
-    else if ((props.depth ?? 0) > 2) return null;
-    return directory({
-      file: props.file,
-      location: path.join(props.location, ".."),
-      depth: (props.depth ?? 0) + 1,
-    });
-  };
-}
+import fs from "fs";
+import path from "path";
+
+export namespace FileRetriever {
+  export const directory = (props: {
+    file: string;
+    location: string;
+    depth?: number;
+  }): string | null => {
+    const location: string = path.join(props.location, props.file);
+    if (fs.existsSync(location)) return props.location;
+    else if ((props.depth ?? 0) > 2) return null;
+    return directory({
+      file: props.file,
+      location: path.join(props.location, ".."),
+      depth: (props.depth ?? 0) + 1,
+    });
+  };
+}