typia 6.6.2 → 6.7.0-dev.20240802

package/src/executable/setup/FileRetriever.ts

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

package/src/executable/setup/PackageManager.ts

@@ -1,86 +1,86 @@
-import fs from "fs";
-import path from "path";
-
-import { CommandExecutor } from "./CommandExecutor";
-import { FileRetriever } from "./FileRetriever";
-
-const managers = ["npm", "pnpm", "yarn", "bun"] as const;
-type Manager = (typeof managers)[number];
-
-const installCmdTable = {
-  npm: "install",
-  pnpm: "add",
-  yarn: "add",
-  bun: "add",
-} as const satisfies Record<Manager, string>;
-const devOptionTable = {
-  npm: "--save-dev",
-  pnpm: "--save-dev",
-  yarn: "--dev",
-  bun: "--dev",
-} as const satisfies Record<Manager, string>;
-
-export class PackageManager {
-  public manager: Manager = "npm";
-  public get file(): string {
-    return path.join(this.directory, "package.json");
-  }
-
-  public static async mount(): Promise<PackageManager> {
-    const location: string | null = await FileRetriever.directory(
-      "package.json",
-    )(process.cwd());
-    if (location === null)
-      throw new URIError(`Unable to find "package.json" file`);
-
-    return new PackageManager(
-      location,
-      await this.load(path.join(location, "package.json")),
-    );
-  }
-
-  public async save(modifier: (data: Package.Data) => void): Promise<void> {
-    const content: string = await fs.promises.readFile(this.file, "utf8");
-    this.data = JSON.parse(content);
-    modifier(this.data);
-
-    return fs.promises.writeFile(
-      this.file,
-      JSON.stringify(this.data, null, 2),
-      "utf8",
-    );
-  }
-
-  public install(props: {
-    dev: boolean;
-    modulo: string;
-    version: string;
-  }): boolean {
-    const cmd = installCmdTable[this.manager];
-    const option = props.dev ? devOptionTable[this.manager] : "";
-    const middle: string = `${cmd} ${option}` as const;
-    CommandExecutor.run(
-      `${this.manager} ${middle} ${props.modulo}${
-        props.version ? `@${props.version}` : ""
-      }`,
-    );
-    return true;
-  }
-
-  private constructor(
-    public readonly directory: string,
-    public data: Package.Data,
-  ) {}
-
-  private static async load(file: string): Promise<Package.Data> {
-    const content: string = await fs.promises.readFile(file, "utf8");
-    return JSON.parse(content);
-  }
-}
-export namespace Package {
-  export interface Data {
-    scripts?: Record<string, string>;
-    dependencies?: Record<string, string>;
-    devDependencies?: Record<string, string>;
-  }
-}
+import fs from "fs";
+import path from "path";
+
+import { CommandExecutor } from "./CommandExecutor";
+import { FileRetriever } from "./FileRetriever";
+
+const managers = ["npm", "pnpm", "yarn", "bun"] as const;
+type Manager = (typeof managers)[number];
+
+const installCmdTable = {
+  npm: "install",
+  pnpm: "add",
+  yarn: "add",
+  bun: "add",
+} as const satisfies Record<Manager, string>;
+const devOptionTable = {
+  npm: "--save-dev",
+  pnpm: "--save-dev",
+  yarn: "--dev",
+  bun: "--dev",
+} as const satisfies Record<Manager, string>;
+
+export class PackageManager {
+  public manager: Manager = "npm";
+  public get file(): string {
+    return path.join(this.directory, "package.json");
+  }
+
+  public static async mount(): Promise<PackageManager> {
+    const location: string | null = await FileRetriever.directory(
+      "package.json",
+    )(process.cwd());
+    if (location === null)
+      throw new URIError(`Unable to find "package.json" file`);
+
+    return new PackageManager(
+      location,
+      await this.load(path.join(location, "package.json")),
+    );
+  }
+
+  public async save(modifier: (data: Package.Data) => void): Promise<void> {
+    const content: string = await fs.promises.readFile(this.file, "utf8");
+    this.data = JSON.parse(content);
+    modifier(this.data);
+
+    return fs.promises.writeFile(
+      this.file,
+      JSON.stringify(this.data, null, 2),
+      "utf8",
+    );
+  }
+
+  public install(props: {
+    dev: boolean;
+    modulo: string;
+    version: string;
+  }): boolean {
+    const cmd = installCmdTable[this.manager];
+    const option = props.dev ? devOptionTable[this.manager] : "";
+    const middle: string = `${cmd} ${option}` as const;
+    CommandExecutor.run(
+      `${this.manager} ${middle} ${props.modulo}${
+        props.version ? `@${props.version}` : ""
+      }`,
+    );
+    return true;
+  }
+
+  private constructor(
+    public readonly directory: string,
+    public data: Package.Data,
+  ) {}
+
+  private static async load(file: string): Promise<Package.Data> {
+    const content: string = await fs.promises.readFile(file, "utf8");
+    return JSON.parse(content);
+  }
+}
+export namespace Package {
+  export interface Data {
+    scripts?: Record<string, string>;
+    dependencies?: Record<string, string>;
+    devDependencies?: Record<string, string>;
+  }
+}

package/src/executable/setup/PluginConfigurator.ts

@@ -1,69 +1,69 @@
-import comments from "comment-json";
-import fs from "fs";
-
-import { TypiaSetupWizard } from "../TypiaSetupWizard";
-
-export namespace PluginConfigurator {
-  export async function configure(
-    args: TypiaSetupWizard.IArguments,
-  ): Promise<void> {
-    // GET COMPILER-OPTIONS
-    const config: comments.CommentObject = comments.parse(
-      await fs.promises.readFile(args.project!, "utf8"),
-    ) as comments.CommentObject;
-    const compilerOptions = config.compilerOptions as
-      | comments.CommentObject
-      | undefined;
-    if (compilerOptions === undefined)
-      throw new ReferenceError(
-        `${args.project} file does not have "compilerOptions" property.`,
-      );
-
-    // PREPARE PLUGINS
-    const plugins: comments.CommentArray<comments.CommentObject> = (() => {
-      const plugins = compilerOptions.plugins as
-        | comments.CommentArray<comments.CommentObject>
-        | undefined;
-      if (plugins === undefined) return (compilerOptions.plugins = [] as any);
-      else if (!Array.isArray(plugins))
-        throw new TypeError(
-          `"plugins" property of ${args.project} must be array type.`,
-        );
-      return plugins;
-    })();
-
-    const strict: boolean | undefined = compilerOptions.strict as
-      | boolean
-      | undefined;
-    const strictNullChecks: boolean | undefined =
-      compilerOptions.strictNullChecks as boolean | undefined;
-    const oldbie: comments.CommentObject | undefined = plugins.find(
-      (p) =>
-        typeof p === "object" &&
-        p !== null &&
-        p.transform === "typia/lib/transform",
-    );
-    if (
-      strictNullChecks !== false &&
-      (strict === true || strictNullChecks === true) &&
-      oldbie !== undefined
-    )
-      return;
-
-    // DO CONFIGURE
-    compilerOptions.strictNullChecks = true;
-    if (strict === undefined && strictNullChecks === undefined)
-      compilerOptions.strict = true;
-    if (oldbie === undefined)
-      plugins.push(
-        comments.parse(`
-                        {
-                            "transform": "typia/lib/transform"
-                        }`) as comments.CommentObject,
-      );
-    await fs.promises.writeFile(
-      args.project!,
-      comments.stringify(config, null, 2),
-    );
-  }
-}
+import comments from "comment-json";
+import fs from "fs";
+
+import { TypiaSetupWizard } from "../TypiaSetupWizard";
+
+export namespace PluginConfigurator {
+  export async function configure(
+    args: TypiaSetupWizard.IArguments,
+  ): Promise<void> {
+    // GET COMPILER-OPTIONS
+    const config: comments.CommentObject = comments.parse(
+      await fs.promises.readFile(args.project!, "utf8"),
+    ) as comments.CommentObject;
+    const compilerOptions = config.compilerOptions as
+      | comments.CommentObject
+      | undefined;
+    if (compilerOptions === undefined)
+      throw new ReferenceError(
+        `${args.project} file does not have "compilerOptions" property.`,
+      );
+
+    // PREPARE PLUGINS
+    const plugins: comments.CommentArray<comments.CommentObject> = (() => {
+      const plugins = compilerOptions.plugins as
+        | comments.CommentArray<comments.CommentObject>
+        | undefined;
+      if (plugins === undefined) return (compilerOptions.plugins = [] as any);
+      else if (!Array.isArray(plugins))
+        throw new TypeError(
+          `"plugins" property of ${args.project} must be array type.`,
+        );
+      return plugins;
+    })();
+
+    const strict: boolean | undefined = compilerOptions.strict as
+      | boolean
+      | undefined;
+    const strictNullChecks: boolean | undefined =
+      compilerOptions.strictNullChecks as boolean | undefined;
+    const oldbie: comments.CommentObject | undefined = plugins.find(
+      (p) =>
+        typeof p === "object" &&
+        p !== null &&
+        p.transform === "typia/lib/transform",
+    );
+    if (
+      strictNullChecks !== false &&
+      (strict === true || strictNullChecks === true) &&
+      oldbie !== undefined
+    )
+      return;
+
+    // DO CONFIGURE
+    compilerOptions.strictNullChecks = true;
+    if (strict === undefined && strictNullChecks === undefined)
+      compilerOptions.strict = true;
+    if (oldbie === undefined)
+      plugins.push(
+        comments.parse(`
+                        {
+                            "transform": "typia/lib/transform"
+                        }`) as comments.CommentObject,
+      );
+    await fs.promises.writeFile(
+      args.project!,
+      comments.stringify(config, null, 2),
+    );
+  }
+}

package/src/executable/typia.ts

@@ -1,55 +1,55 @@
-#!/usr/bin/env node
-const USAGE = `Wrong command has been detected. Use like below:
-
-  npx typia setup \\
-    --manager (npm|pnpm|yarn) \\
-    --project {tsconfig.json file path}
-
-    - npx typia setup
-    - npx typia setup --manager pnpm
-    - npx typia setup --project tsconfig.test.json
-
-  npx typia generate 
-    --input {directory} \\
-    --output {directory}
-
-    --npx typia generate --input src/templates --output src/functinoal
-`;
-
-const halt = (desc: string): never => {
-  console.error(desc);
-  process.exit(-1);
-};
-
-const main = async (): Promise<void> => {
-  try {
-    await import("comment-json");
-    await import("inquirer");
-    await import("commander");
-  } catch {
-    halt(`typia has not been installed. Run "npm i typia" before.`);
-  }
-
-  const type: string | undefined = process.argv[2];
-  if (type === "setup") {
-    const { TypiaSetupWizard } = await import("./TypiaSetupWizard");
-    await TypiaSetupWizard.setup();
-  } else if (type === "patch") {
-    const { TypiaPatchWizard } = await import("./TypiaPatchWizard");
-    await TypiaPatchWizard.main();
-  } else if (type === "generate") {
-    try {
-      await import("typescript");
-    } catch {
-      halt(
-        `typescript has not been installed. Run "npm i -D typescript" before.`,
-      );
-    }
-    const { TypiaGenerateWizard } = await import("./TypiaGenerateWizard");
-    await TypiaGenerateWizard.generate();
-  } else halt(USAGE);
-};
-main().catch((exp) => {
-  console.error(exp);
-  process.exit(-1);
-});
+#!/usr/bin/env node
+const USAGE = `Wrong command has been detected. Use like below:
+
+  npx typia setup \\
+    --manager (npm|pnpm|yarn) \\
+    --project {tsconfig.json file path}
+
+    - npx typia setup
+    - npx typia setup --manager pnpm
+    - npx typia setup --project tsconfig.test.json
+
+  npx typia generate 
+    --input {directory} \\
+    --output {directory}
+
+    --npx typia generate --input src/templates --output src/functinoal
+`;
+
+const halt = (desc: string): never => {
+  console.error(desc);
+  process.exit(-1);
+};
+
+const main = async (): Promise<void> => {
+  try {
+    await import("comment-json");
+    await import("inquirer");
+    await import("commander");
+  } catch {
+    halt(`typia has not been installed. Run "npm i typia" before.`);
+  }
+
+  const type: string | undefined = process.argv[2];
+  if (type === "setup") {
+    const { TypiaSetupWizard } = await import("./TypiaSetupWizard");
+    await TypiaSetupWizard.setup();
+  } else if (type === "patch") {
+    const { TypiaPatchWizard } = await import("./TypiaPatchWizard");
+    await TypiaPatchWizard.main();
+  } else if (type === "generate") {
+    try {
+      await import("typescript");
+    } catch {
+      halt(
+        `typescript has not been installed. Run "npm i -D typescript" before.`,
+      );
+    }
+    const { TypiaGenerateWizard } = await import("./TypiaGenerateWizard");
+    await TypiaGenerateWizard.generate();
+  } else halt(USAGE);
+};
+main().catch((exp) => {
+  console.error(exp);
+  process.exit(-1);
+});

package/src/factories/CommentFactory.ts

@@ -1,79 +1,79 @@
-import ts from "typescript";
-
-export namespace CommentFactory {
-  export const description = (
-    symbol: ts.Symbol,
-    includeTags: boolean = false,
-  ): string | undefined => {
-    const node = symbol.declarations?.[0];
-    if (!node) return undefined;
-
-    // FOR LEGACY TS < 5.2
-    const [major, minor] = ts.versionMajorMinor.split(".").map(Number) as [
-      number,
-      number,
-    ];
-    if (major < 5 || (major === 5 && minor < 1)) {
-      const content: string[] = [];
-      const main: string = ts.displayPartsToString(
-        symbol.getDocumentationComment(undefined),
-      );
-      if (main.length) {
-        content.push(main);
-        if (includeTags && symbol.getJsDocTags().length) content.push("");
-      }
-      if (includeTags)
-        for (const tag of symbol.getJsDocTags()) {
-          content.push(
-            tag.text
-              ? `@${tag.name} ${ts.displayPartsToString(tag.text)}`
-              : `@${tag.name}`,
-          );
-        }
-      return content.length
-        ? content.map((line) => line.split("\r\n").join("\n")).join("\n")
-        : undefined;
-    }
-
-    // NEW FEATURE OF TS 5.2
-    const elements: readonly (ts.JSDoc | ts.JSDocTag)[] =
-      ts.getJSDocCommentsAndTags(node);
-    if (elements.length === 0) return undefined;
-
-    const content: string[] = [];
-    for (const comment of elements) {
-      if (ts.isJSDoc(comment)) {
-        const parsed: string | undefined = ts.getTextOfJSDocComment(
-          comment.comment,
-        );
-        if (parsed?.length) {
-          content.push(parsed);
-          if (includeTags && comment.tags?.length) content.push("");
-        }
-        if (includeTags)
-          for (const tag of comment.tags ?? [])
-            content.push(parseJSDocTag(tag));
-      } else if (includeTags) content.push(parseJSDocTag(comment));
-    }
-    const output: string = content
-      .map((line) => line.split("\r\n").join("\n"))
-      .join("\n");
-    return output.length ? output : undefined;
-  };
-
-  export const merge = (comments: ts.SymbolDisplayPart[]): string =>
-    comments
-      .map((part) => part.text)
-      .map((str) => str.split("\r\n").join("\n"))
-      .join("");
-}
-
-const parseJSDocTag = (tag: ts.JSDocTag): string => {
-  const name: string | undefined = (
-    tag as ts.JSDocParameterTag
-  ).name?.getText();
-  const parsed: string | undefined = ts.getTextOfJSDocComment(tag.comment);
-  return [`@${tag.tagName.text}`, name, parsed]
-    .filter((str) => !!str?.length)
-    .join(" ");
-};
+import ts from "typescript";
+
+export namespace CommentFactory {
+  export const description = (
+    symbol: ts.Symbol,
+    includeTags: boolean = false,
+  ): string | undefined => {
+    const node = symbol.declarations?.[0];
+    if (!node) return undefined;
+
+    // FOR LEGACY TS < 5.2
+    const [major, minor] = ts.versionMajorMinor.split(".").map(Number) as [
+      number,
+      number,
+    ];
+    if (major < 5 || (major === 5 && minor < 1)) {
+      const content: string[] = [];
+      const main: string = ts.displayPartsToString(
+        symbol.getDocumentationComment(undefined),
+      );
+      if (main.length) {
+        content.push(main);
+        if (includeTags && symbol.getJsDocTags().length) content.push("");
+      }
+      if (includeTags)
+        for (const tag of symbol.getJsDocTags()) {
+          content.push(
+            tag.text
+              ? `@${tag.name} ${ts.displayPartsToString(tag.text)}`
+              : `@${tag.name}`,
+          );
+        }
+      return content.length
+        ? content.map((line) => line.split("\r\n").join("\n")).join("\n")
+        : undefined;
+    }
+
+    // NEW FEATURE OF TS 5.2
+    const elements: readonly (ts.JSDoc | ts.JSDocTag)[] =
+      ts.getJSDocCommentsAndTags(node);
+    if (elements.length === 0) return undefined;
+
+    const content: string[] = [];
+    for (const comment of elements) {
+      if (ts.isJSDoc(comment)) {
+        const parsed: string | undefined = ts.getTextOfJSDocComment(
+          comment.comment,
+        );
+        if (parsed?.length) {
+          content.push(parsed);
+          if (includeTags && comment.tags?.length) content.push("");
+        }
+        if (includeTags)
+          for (const tag of comment.tags ?? [])
+            content.push(parseJSDocTag(tag));
+      } else if (includeTags) content.push(parseJSDocTag(comment));
+    }
+    const output: string = content
+      .map((line) => line.split("\r\n").join("\n"))
+      .join("\n");
+    return output.length ? output : undefined;
+  };
+
+  export const merge = (comments: ts.SymbolDisplayPart[]): string =>
+    comments
+      .map((part) => part.text)
+      .map((str) => str.split("\r\n").join("\n"))
+      .join("");
+}
+
+const parseJSDocTag = (tag: ts.JSDocTag): string => {
+  const name: string | undefined = (
+    tag as ts.JSDocParameterTag
+  ).name?.getText();
+  const parsed: string | undefined = ts.getTextOfJSDocComment(tag.comment);
+  return [`@${tag.tagName.text}`, name, parsed]
+    .filter((str) => !!str?.length)
+    .join(" ");
+};