typia 3.4.6 → 3.4.8

package/src/Primitive.ts

@@ -1,82 +1,82 @@
-/**
- * Primitive type.
- *
- * `Primitive` is a type of TMP (Type Meta Programming) type who converts its argument as a
- * primitive type.
- *
- * If the target argument is a built-in class who returns its origin primitive type through
- * the `valueOf()` method like the `String` or `Number`, its return type would be the
- * `string` or `number`.
- *
- * Otherwise, the target argument is a type of custom class, all of its custom method would
- * be erased and its prototype would be changed to the primitive `object`. Therefore, return
- * type of the TMP type finally be the primitive object.
- *
- * In addition, if the target argument is a type of custom class and it has a special
- * method `toJSON()`, return type of this `Primitive` would be not `Primitive<Instance>`
- * but `Primitive<ReturnType<Instance.toJSON>>`.
- *
- * Before                  | After
- * ------------------------|----------------------------------------
- * `Boolean`               | `boolean`
- * `Number`                | `number`
- * `String`                | `string`
- * `Class`                 | `object`
- * `Class` with `toJSON()` | `Primitive<ReturnType<Class.toJSON>>`
- * Others                  | No change
- *
- * @template Instance Target argument type.
- * @author Jenogho Nam - https://github.com/samchon
- */
-export type Primitive<T> = _Equal<T, _Primitive<T>> extends true
-    ? T
-    : _Primitive<T>;
-
-type _Equal<X, Y> = X extends Y ? (Y extends X ? true : false) : false;
-
-type _Primitive<Instance> = _ValueOf<Instance> extends object
-    ? Instance extends object
-        ? Instance extends IJsonable<infer Raw>
-            ? _ValueOf<Raw> extends object
-                ? Raw extends object
-                    ? _PrimitiveObject<Raw> // object would be primitified
-                    : never // cannot be
-                : _ValueOf<Raw> // atomic value
-            : _PrimitiveObject<Instance> // object would be primitified
-        : never // cannot be
-    : _ValueOf<Instance>;
-
-type _PrimitiveObject<Instance extends object> = Instance extends Array<infer T>
-    ? _Primitive<T>[]
-    : {
-          [P in keyof Instance]: Instance[P] extends Function
-              ? never
-              : _Primitive<Instance[P]>;
-      };
-
-type _ValueOf<Instance> = _IsValueOf<Instance, Boolean> extends true
-    ? boolean
-    : _IsValueOf<Instance, Number> extends true
-    ? number
-    : _IsValueOf<Instance, String> extends true
-    ? string
-    : Instance;
-
-type _IsValueOf<
-    Instance,
-    Object extends IValueOf<any>,
-> = Instance extends Object
-    ? Object extends IValueOf<infer Primitive>
-        ? Instance extends Primitive
-            ? false
-            : true // not Primitive, but Object
-        : false // cannot be
-    : false;
-
-interface IValueOf<T> {
-    valueOf(): T;
-}
-
-interface IJsonable<T> {
-    toJSON(): T;
-}
+/**
+ * Primitive type.
+ *
+ * `Primitive` is a type of TMP (Type Meta Programming) type who converts its argument as a
+ * primitive type.
+ *
+ * If the target argument is a built-in class who returns its origin primitive type through
+ * the `valueOf()` method like the `String` or `Number`, its return type would be the
+ * `string` or `number`.
+ *
+ * Otherwise, the target argument is a type of custom class, all of its custom method would
+ * be erased and its prototype would be changed to the primitive `object`. Therefore, return
+ * type of the TMP type finally be the primitive object.
+ *
+ * In addition, if the target argument is a type of custom class and it has a special
+ * method `toJSON()`, return type of this `Primitive` would be not `Primitive<Instance>`
+ * but `Primitive<ReturnType<Instance.toJSON>>`.
+ *
+ * Before                  | After
+ * ------------------------|----------------------------------------
+ * `Boolean`               | `boolean`
+ * `Number`                | `number`
+ * `String`                | `string`
+ * `Class`                 | `object`
+ * `Class` with `toJSON()` | `Primitive<ReturnType<Class.toJSON>>`
+ * Others                  | No change
+ *
+ * @template Instance Target argument type.
+ * @author Jenogho Nam - https://github.com/samchon
+ */
+export type Primitive<T> = _Equal<T, _Primitive<T>> extends true
+    ? T
+    : _Primitive<T>;
+
+type _Equal<X, Y> = X extends Y ? (Y extends X ? true : false) : false;
+
+type _Primitive<Instance> = _ValueOf<Instance> extends object
+    ? Instance extends object
+        ? Instance extends IJsonable<infer Raw>
+            ? _ValueOf<Raw> extends object
+                ? Raw extends object
+                    ? _PrimitiveObject<Raw> // object would be primitified
+                    : never // cannot be
+                : _ValueOf<Raw> // atomic value
+            : _PrimitiveObject<Instance> // object would be primitified
+        : never // cannot be
+    : _ValueOf<Instance>;
+
+type _PrimitiveObject<Instance extends object> = Instance extends Array<infer T>
+    ? _Primitive<T>[]
+    : {
+          [P in keyof Instance]: Instance[P] extends Function
+              ? never
+              : _Primitive<Instance[P]>;
+      };
+
+type _ValueOf<Instance> = _IsValueOf<Instance, Boolean> extends true
+    ? boolean
+    : _IsValueOf<Instance, Number> extends true
+    ? number
+    : _IsValueOf<Instance, String> extends true
+    ? string
+    : Instance;
+
+type _IsValueOf<
+    Instance,
+    Object extends IValueOf<any>,
+> = Instance extends Object
+    ? Object extends IValueOf<infer Primitive>
+        ? Instance extends Primitive
+            ? false
+            : true // not Primitive, but Object
+        : false // cannot be
+    : false;
+
+interface IValueOf<T> {
+    valueOf(): T;
+}
+
+interface IJsonable<T> {
+    toJSON(): T;
+}

package/src/TypeGuardError.ts

@@ -1,36 +1,36 @@
-export class TypeGuardError extends Error {
-    public readonly method: string;
-    public readonly path: string | undefined;
-    public readonly expected: string;
-    public readonly value: any;
-
-    public constructor(props: TypeGuardError.IProps) {
-        // MESSAGE CONSTRUCTION
-        super(
-            props.message ||
-                `Error on ${props.method}(): invalid type${
-                    props.path ? ` on ${props.path}` : ""
-                }, expect to be ${props.expected}`,
-        );
-
-        // INHERITANCE POLYFILL
-        const proto = new.target.prototype;
-        if (Object.setPrototypeOf) Object.setPrototypeOf(this, proto);
-        else (this as any).__proto__ = proto;
-
-        // ASSIGN MEMBERS
-        this.method = props.method;
-        this.path = props.path;
-        this.expected = props.expected;
-        this.value = props.value;
-    }
-}
-export namespace TypeGuardError {
-    export interface IProps {
-        method: string;
-        path?: string;
-        expected: string;
-        value: any;
-        message?: string;
-    }
-}
+export class TypeGuardError extends Error {
+    public readonly method: string;
+    public readonly path: string | undefined;
+    public readonly expected: string;
+    public readonly value: any;
+
+    public constructor(props: TypeGuardError.IProps) {
+        // MESSAGE CONSTRUCTION
+        super(
+            props.message ||
+                `Error on ${props.method}(): invalid type${
+                    props.path ? ` on ${props.path}` : ""
+                }, expect to be ${props.expected}`,
+        );
+
+        // INHERITANCE POLYFILL
+        const proto = new.target.prototype;
+        if (Object.setPrototypeOf) Object.setPrototypeOf(this, proto);
+        else (this as any).__proto__ = proto;
+
+        // ASSIGN MEMBERS
+        this.method = props.method;
+        this.path = props.path;
+        this.expected = props.expected;
+        this.value = props.value;
+    }
+}
+export namespace TypeGuardError {
+    export interface IProps {
+        method: string;
+        path?: string;
+        expected: string;
+        value: any;
+        message?: string;
+    }
+}

package/src/executable/internal/CommandParser.ts

@@ -0,0 +1,15 @@
+export namespace CommandParser {
+    export function parse(argList: string[]): Record<string, string> {
+        const output: Record<string, string> = {};
+        argList.forEach((arg, i) => {
+            if (arg.startsWith("--") === false) return;
+
+            const key = arg.slice(2);
+            const value: string | undefined = argList[i + 1];
+            if (value === undefined || value.startsWith("--")) return;
+
+            output[key] = value;
+        });
+        return output;
+    }
+}

package/src/executable/internal/TypiaSetupWizard.ts

@@ -3,23 +3,25 @@ import type Comment from "comment-json";
 import fs from "fs";
 
 export namespace TypiaSetupWizard {
-    export async function ttypescript(): Promise<void> {
+    export async function ttypescript(manager: string): Promise<void> {
         // INSTALL
-        const pack: any = await prepare();
-        install(pack, "ttypescript", "--save-dev");
-        install(pack, "ts-node", "--save-dev");
+        const pack: any = await prepare(manager);
+        add(manager)(pack)("ttypescript", true);
+        add(manager)(pack)("ts-node", true);
 
         // TSCONFIG.JSON
-        await configure();
+        await configure(manager);
     }
 
-    export async function tsPatch(): Promise<void> {
+    export async function tsPatch(manager: string): Promise<void> {
         // INSTALL
-        const pack: any = await prepare();
-        install(pack, "ts-patch", "--save-dev");
+        add(manager)(await prepare(manager))("ts-patch", true);
         execute("npx ts-patch install");
 
         // PACKAGE.JSON
+        const pack: any = JSON.parse(
+            await fs.promises.readFile("package.json", "utf8"),
+        );
         if (!pack.scripts || typeof pack.scripts !== "object")
             pack.scripts = {};
         if (typeof pack.scripts.prepare === "string") {
@@ -35,105 +37,124 @@ export namespace TypiaSetupWizard {
         );
 
         // TSCONFIG.JSON
-        await configure();
+        await configure(manager);
     }
 
-    async function prepare(): Promise<any> {
+    async function prepare(manager: string): Promise<any> {
         if (fs.existsSync("package.json") === false)
             halt(() => {})("make package.json file or move to it.");
+
         const pack: any = JSON.parse(
             await fs.promises.readFile("package.json", "utf8"),
         );
-        install(pack, "typia", "--save");
-        install(pack, "typescript", "--save-dev");
+        const wizard = add(manager)(pack);
+
+        wizard("typia", false);
+        wizard("typescript", true);
         return pack;
     }
 
-    async function configure(): Promise<void> {
-        // VALIDATE PRERATATION
-        if (fs.existsSync("tsconfig.json") === false) {
-            execute("npx tsc --init");
-            if (fs.existsSync("tsconfig.json") === false)
-                halt(() => {})("tsconfig.json file does not exist.");
-        }
-
-        const temporary: boolean = !fs.existsSync("node_modules/comment-json");
-        if (temporary === true)
-            cp.execSync("npm install --save-dev comment-json");
-
-        const halter: (msg: string) => never = halt(() => {
-            if (temporary === true)
-                cp.execSync("npm uninstall --save-dev comment-json");
-        });
-
-        // READ TSCONFIG FILE
-        const Comment: typeof import("comment-json") = await import(
-            process.cwd() + "/node_modules/comment-json"
-        );
-        const config: Comment.CommentObject = Comment.parse(
-            await fs.promises.readFile("tsconfig.json", "utf8"),
-        ) as Comment.CommentObject;
-        const options = config.compilerOptions as
-            | Comment.CommentObject
-            | undefined;
-        if (options === undefined)
-            halter(
-                `tsconfig.json file does not have "compilerOptions" property.`,
+    const configure =
+        (manager: string) =>
+        async (pack: any): Promise<void> => {
+            // VALIDATE PRERATATION
+            if (fs.existsSync("tsconfig.json") === false) {
+                execute("npx tsc --init");
+                if (fs.existsSync("tsconfig.json") === false)
+                    halt(() => {})("tsconfig.json file does not exist.");
+            }
+
+            const temporary: boolean = !fs.existsSync(
+                "node_modules/comment-json",
             );
+            if (temporary === true) add(manager)(pack)("comment-json", true);
+
+            const halter: (msg: string) => never = halt(() => {
+                if (temporary === true) remove(manager)("comment-json", true);
+            });
 
-        const plugins: Comment.CommentArray<Comment.CommentObject> = (() => {
-            const plugins = options.plugins as
-                | Comment.CommentArray<Comment.CommentObject>
+            // READ TSCONFIG FILE
+            const Comment: typeof import("comment-json") = await import(
+                process.cwd() + "/node_modules/comment-json"
+            );
+            const config: Comment.CommentObject = Comment.parse(
+                await fs.promises.readFile("tsconfig.json", "utf8"),
+            ) as Comment.CommentObject;
+            const options = config.compilerOptions as
+                | Comment.CommentObject
                 | undefined;
-            if (plugins === undefined) return (options.plugins = [] as any);
-            else if (!Array.isArray(plugins))
+            if (options === undefined)
                 halter(
-                    `"plugins" property of tsconfig.json must be array type.`,
+                    `tsconfig.json file does not have "compilerOptions" property.`,
                 );
-            return plugins;
-        })();
-
-        // CHECK WHETHER CONFIGURED
-        const strict: boolean = options.strict === true;
-        const oldbie: Comment.CommentObject | undefined = plugins.find(
-            (p) =>
-                typeof p === "object" &&
-                p !== null &&
-                p.transform === "typia/lib/transform",
-        );
 
-        if (strict === true && oldbie !== undefined) {
-            console.log(
-                "you've been already configured the tsconfig.json file.",
+            const plugins: Comment.CommentArray<Comment.CommentObject> =
+                (() => {
+                    const plugins = options.plugins as
+                        | Comment.CommentArray<Comment.CommentObject>
+                        | undefined;
+                    if (plugins === undefined)
+                        return (options.plugins = [] as any);
+                    else if (!Array.isArray(plugins))
+                        halter(
+                            `"plugins" property of tsconfig.json must be array type.`,
+                        );
+                    return plugins;
+                })();
+
+            // CHECK WHETHER CONFIGURED
+            const strict: boolean = options.strict === true;
+            const oldbie: Comment.CommentObject | undefined = plugins.find(
+                (p) =>
+                    typeof p === "object" &&
+                    p !== null &&
+                    p.transform === "typia/lib/transform",
             );
-        } else {
-            // DO CONFIGURE
-            options.strict = true;
-            plugins.push({ transform: "typia/lib/transform" } as any);
-
-            await fs.promises.writeFile(
-                "tsconfig.json",
-                Comment.stringify(config, null, 2),
-            );
-        }
-        if (temporary === true)
-            cp.execSync("npm uninstall --save-dev comment-json");
-    }
-}
 
-function install(
-    pack: any,
-    modulo: string,
-    mode: "--save" | "--save-dev",
-): void {
-    const exists: boolean =
-        (mode === "--save"
-            ? !!pack.dependencies && !!pack.dependencies[modulo]
-            : !!pack.devDependencies && !!pack.devDependencies[modulo]) &&
-        fs.existsSync("node_modules/" + modulo);
-    if (exists === false) execute(`npm install ${mode} ${modulo}`);
+            if (strict === true && oldbie !== undefined) {
+                console.log(
+                    "you've been already configured the tsconfig.json file.",
+                );
+            } else {
+                // DO CONFIGURE
+                options.strict = true;
+                plugins.push({ transform: "typia/lib/transform" } as any);
+
+                await fs.promises.writeFile(
+                    "tsconfig.json",
+                    Comment.stringify(config, null, 2),
+                );
+            }
+            if (temporary === true) remove(manager)("comment-json", false);
+        };
 }
 
+const add =
+    (manager: string) =>
+    (pack: any) =>
+    (modulo: string, devOnly: boolean): void => {
+        const exists: boolean =
+            (devOnly === false
+                ? !!pack.dependencies && !!pack.dependencies[modulo]
+                : !!pack.devDependencies && !!pack.devDependencies[modulo]) &&
+            fs.existsSync("node_modules/" + modulo);
+        const middle: string =
+            manager === "yarn"
+                ? `add${devOnly ? " -D" : ""}`
+                : `install ${devOnly ? "--save-dev" : "--save"}`;
+        if (exists === false) execute(`${manager} ${middle} ${modulo}`);
+    };
+
+const remove =
+    (manager: string) =>
+    (modulo: string, devOnly: boolean): void => {
+        const middle: string =
+            manager === "yarn"
+                ? `remove${devOnly ? " -D" : ""}`
+                : `uninstall ${devOnly ? "--save-dev" : "--save"}`;
+        execute(`${manager} ${middle} ${modulo}`);
+    };
+
 const halt =
     (closer: () => any) =>
     (desc: string): never => {

package/src/executable/typia.ts

@@ -1,11 +1,17 @@
 #!/usr/bin/env node
+import { CommandParser } from "./internal/CommandParser";
 import { TypiaSetupWizard } from "./internal/TypiaSetupWizard";
 
-const USAGE = `Usage: npx typia setup (transformer?: "ttypescript" | "ts-patch")
+const USAGE = `Wrong command has been detected. Use like below:
+
+  npx typia setup \\
+    --compiler (ttypescript|ts-patch) \\
+    --manager (npm|pnpm|yarn)
 
   - npx typia setup
-  - npx typia setup ttypescript
-  - npx typia setup ts-patch`;
+  - npx typia setup --compiler ttypescript
+  - npx typia setup --compiler ts-patch
+  - npx typia setup --manager pnpm`;
 
 function halt(desc: string): never {
     console.error(desc);
@@ -13,21 +19,26 @@ function halt(desc: string): never {
 }
 
 async function setup(): Promise<void> {
-    const compiler: string = process.argv[3] ?? "ttypescript";
-    if (compiler !== "ttypescript" && compiler !== "ts-patch")
-        halt(
-            "typia supports only two transformers: ttypescript and ts-patch" +
-                "\n\n" +
-                USAGE,
-        );
-    else if (compiler === "ttypescript") await TypiaSetupWizard.ttypescript();
-    else await TypiaSetupWizard.tsPatch();
+    const options: Record<string, string> = CommandParser.parse(
+        process.argv.slice(3),
+    );
+    const manager: string = options.manager ?? "npm";
+    const compiler: string = options.compiler ?? "ttypescript";
+
+    if (
+        (compiler !== "ttypescript" && compiler !== "ts-patch") ||
+        (manager !== "npm" && manager !== "pnpm" && manager !== "yarn")
+    )
+        halt(USAGE);
+    else if (compiler === "ttypescript")
+        await TypiaSetupWizard.ttypescript(manager);
+    else await TypiaSetupWizard.tsPatch(manager);
 }
 
 async function main(): Promise<void> {
     const type: string | undefined = process.argv[2];
-    if (type === undefined) halt(USAGE);
-    else if (type === "setup") await setup();
+    if (type === "setup") await setup();
+    else halt(USAGE);
 }
 main().catch((exp) => {
     console.error(exp);

package/src/factories/CommentFactory.ts

@@ -1,10 +1,10 @@
-import ts from "typescript";
-
-export namespace CommentFactory {
-    export function generate(comments: ts.SymbolDisplayPart[]): string {
-        return comments
-            .map((part) => part.text)
-            .map((str) => str.split("\r\n").join("\n"))
-            .join("");
-    }
-}
+import ts from "typescript";
+
+export namespace CommentFactory {
+    export function generate(comments: ts.SymbolDisplayPart[]): string {
+        return comments
+            .map((part) => part.text)
+            .map((str) => str.split("\r\n").join("\n"))
+            .join("");
+    }
+}