typia 3.4.15 → 3.5.0-dev.20221222

package/src/executable/internal/TypiaSetupWizard.ts

@@ -1,173 +1,173 @@
-import cp from "child_process";
-import type Comment from "comment-json";
-import fs from "fs";
-
-export namespace TypiaSetupWizard {
-    export async function ttypescript(manager: string): Promise<void> {
-        // INSTALL
-        const pack: any = await prepare(manager);
-        add(manager)(pack)("ttypescript", true);
-        add(manager)(pack)("ts-node", true);
-
-        // TSCONFIG.JSON
-        await configure(manager)(pack);
-    }
-
-    export async function tsPatch(manager: string): Promise<void> {
-        // INSTALL
-        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") {
-            if (pack.scripts.prepare.indexOf("ts-patch install") === -1)
-                pack.scripts.prepare =
-                    "ts-patch install && " + pack.scripts.prepare;
-        } else pack.scripts.prepare = "ts-patch install";
-
-        await fs.promises.writeFile(
-            "package.json",
-            JSON.stringify(pack, null, 2),
-            "utf8",
-        );
-
-        // TSCONFIG.JSON
-        await configure(manager)(pack);
-    }
-
-    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"),
-        );
-        const wizard = add(manager)(pack);
-        wizard("typia", false);
-        wizard("typescript", true);
-        return pack;
-    }
-
-    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);
-            });
-
-            // 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 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",
-            );
-
-            if (strict === true && oldbie !== undefined) {
-                console.log(
-                    "you've been already configured the tsconfig.json file.",
-                );
-            } else {
-                // DO CONFIGURE
-                options.strict = true;
-                if (oldbie === undefined)
-                    plugins.push(
-                        Comment.parse(`
-                            {
-                                "transform": "typia/lib/transform"
-                            }`) as Comment.CommentObject,
-                    );
-                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 => {
-        closer();
-        console.error(desc);
-        process.exit(-1);
-    };
-
-function execute(command: string): void {
-    console.log(command);
-    cp.execSync(command, { stdio: "inherit" });
-}
+import cp from "child_process";
+import type Comment from "comment-json";
+import fs from "fs";
+
+export namespace TypiaSetupWizard {
+    export async function ttypescript(manager: string): Promise<void> {
+        // INSTALL
+        const pack: any = await prepare(manager);
+        add(manager)(pack)("ttypescript", true);
+        add(manager)(pack)("ts-node", true);
+
+        // TSCONFIG.JSON
+        await configure(manager)(pack);
+    }
+
+    export async function tsPatch(manager: string): Promise<void> {
+        // INSTALL
+        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") {
+            if (pack.scripts.prepare.indexOf("ts-patch install") === -1)
+                pack.scripts.prepare =
+                    "ts-patch install && " + pack.scripts.prepare;
+        } else pack.scripts.prepare = "ts-patch install";
+
+        await fs.promises.writeFile(
+            "package.json",
+            JSON.stringify(pack, null, 2),
+            "utf8",
+        );
+
+        // TSCONFIG.JSON
+        await configure(manager)(pack);
+    }
+
+    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"),
+        );
+        const wizard = add(manager)(pack);
+        wizard("typia", false);
+        wizard("typescript", true);
+        return pack;
+    }
+
+    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);
+            });
+
+            // 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 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",
+            );
+
+            if (strict === true && oldbie !== undefined) {
+                console.log(
+                    "you've been already configured the tsconfig.json file.",
+                );
+            } else {
+                // DO CONFIGURE
+                options.strict = true;
+                if (oldbie === undefined)
+                    plugins.push(
+                        Comment.parse(`
+                            {
+                                "transform": "typia/lib/transform"
+                            }`) as Comment.CommentObject,
+                    );
+                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 => {
+        closer();
+        console.error(desc);
+        process.exit(-1);
+    };
+
+function execute(command: string): void {
+    console.log(command);
+    cp.execSync(command, { stdio: "inherit" });
+}

package/src/factories/MetadataCollection.ts

@@ -1,122 +1,83 @@
-import ts from "typescript";
-
-import { Metadata } from "../metadata/Metadata";
-import { MetadataObject } from "../metadata/MetadataObject";
-
-import { MapUtil } from "../utils/MapUtil";
-
-import { CommentFactory } from "./CommentFactory";
-import { TypeFactory } from "./TypeFactory";
-
-export class MetadataCollection {
-    private readonly dict_: Map<ts.Type, MetadataObject>;
-    private readonly names_: Map<string, Map<ts.Type, string>>;
-    private readonly unions_: Map<string, MetadataObject[]>;
-    private index_: number;
-
-    public constructor(
-        private readonly options?: Partial<MetadataCollection.IOptions>,
-    ) {
-        this.dict_ = new Map();
-        this.names_ = new Map();
-        this.unions_ = new Map();
-        this.index_ = 0;
-    }
-
-    public objects(): MetadataObject[] {
-        return [...this.dict_.values()];
-    }
-    public unions(): MetadataObject[][] {
-        return [...this.unions_.values()];
-    }
-
-    public emplace(
-        checker: ts.TypeChecker,
-        type: ts.Type,
-    ): [MetadataObject, boolean] {
-        const oldbie = this.dict_.get(type);
-        if (oldbie !== undefined) return [oldbie, false];
-
-        const $id: string = this.get_name(checker, type);
-        const obj: MetadataObject = MetadataObject.create({
-            name: $id,
-            properties: [],
-            description:
-                (type.symbol &&
-                    CommentFactory.generate(
-                        type.symbol.getDocumentationComment(checker),
-                    )) ||
-                undefined,
-            jsDocTags: type.symbol?.getJsDocTags() || [],
-            validated: false,
-            index: this.index_++,
-            recursive: false,
-            nullables: [],
-        });
-        this.dict_.set(type, obj);
-        return [obj, true];
-    }
-
-    /**
-     * @internal
-     */
-    public getUnionIndex(meta: Metadata): number {
-        const key: string = meta.objects.map((obj) => obj.name).join(" | ");
-        MapUtil.take(this.unions_, key, () => meta.objects);
-        return [...this.unions_.keys()].indexOf(key);
-    }
-
-    private get_name(checker: ts.TypeChecker, type: ts.Type): string {
-        const name: string = (() => {
-            const str: string = TypeFactory.getFullName(checker, type);
-            return this.options?.replace ? this.options.replace(str) : str;
-        })();
-
-        const duplicates: Map<ts.Type, string> = MapUtil.take(
-            this.names_,
-            name,
-            () => new Map(),
-        );
-        const oldbie: string | undefined = duplicates.get(type);
-        if (oldbie !== undefined) return oldbie;
-
-        const addicted: string = duplicates.size
-            ? `${name}.o${duplicates.size}`
-            : name;
-        duplicates.set(type, addicted);
-        return addicted;
-    }
-}
-export namespace MetadataCollection {
-    export interface IOptions {
-        replace?(str: string): string;
-    }
-
-    export function replace(str: string): string {
-        for (const [before, after] of REPLACERS)
-            str = str.split(before).join(after);
-        return str;
-    }
-
-    export function escape(str: string): string {
-        for (const [before, after] of REPLACERS)
-            if (after !== "") str = str.split(after).join(before);
-        return str;
-    }
-}
-const REPLACERS: [string, string][] = [
-    ["$", "_dollar_"],
-    ["&", "_and_"],
-    ["|", "_or_"],
-    ["{", "_blt_"],
-    ["}", "_bgt_"],
-    ["<", "_lt_"],
-    [">", "_gt_"],
-    ["[", "_alt_"],
-    ["]", "_agt_"],
-    [",", "_comma_"],
-    ["`", "_backquote_"],
-    ["'", "_singlequote_"],
-    ['"', "_doublequote_"],
-    [" ", "_space_"],
-];
+import ts from "typescript";
+
+import { Metadata } from "../metadata/Metadata";
+import { MetadataObject } from "../metadata/MetadataObject";
+
+import { MapUtil } from "../utils/MapUtil";
+
+import { CommentFactory } from "./CommentFactory";
+import { TypeFactory } from "./TypeFactory";
+
+export class MetadataCollection {
+    private readonly dict_: Map<ts.Type, MetadataObject>;
+    private readonly names_: Map<string, Map<ts.Type, string>>;
+    private readonly unions_: Map<string, MetadataObject[]>;
+    private index_: number;
+
+    public constructor() {
+        this.dict_ = new Map();
+        this.names_ = new Map();
+        this.unions_ = new Map();
+        this.index_ = 0;
+    }
+
+    public objects(): MetadataObject[] {
+        return [...this.dict_.values()];
+    }
+    public unions(): MetadataObject[][] {
+        return [...this.unions_.values()];
+    }
+
+    public emplace(
+        checker: ts.TypeChecker,
+        type: ts.Type,
+    ): [MetadataObject, boolean] {
+        const oldbie = this.dict_.get(type);
+        if (oldbie !== undefined) return [oldbie, false];
+
+        const $id: string = this.get_name(checker, type);
+        const obj: MetadataObject = MetadataObject.create({
+            name: $id,
+            properties: [],
+            description:
+                (type.symbol &&
+                    CommentFactory.generate(
+                        type.symbol.getDocumentationComment(checker),
+                    )) ||
+                undefined,
+            jsDocTags: type.symbol?.getJsDocTags() || [],
+            validated: false,
+            index: this.index_++,
+            recursive: false,
+            nullables: [],
+        });
+        this.dict_.set(type, obj);
+        return [obj, true];
+    }
+
+    /**
+     * @internal
+     */
+    public getUnionIndex(meta: Metadata): number {
+        const key: string = meta.objects.map((obj) => obj.name).join(" | ");
+        MapUtil.take(this.unions_, key, () => meta.objects);
+        return [...this.unions_.keys()].indexOf(key);
+    }
+
+    private get_name(checker: ts.TypeChecker, type: ts.Type): string {
+        const name: string = TypeFactory.getFullName(checker, type);
+        const duplicates: Map<ts.Type, string> = MapUtil.take(
+            this.names_,
+            name,
+            () => new Map(),
+        );
+        const oldbie: string | undefined = duplicates.get(type);
+        if (oldbie !== undefined) return oldbie;
+
+        const addicted: string = duplicates.size
+            ? `${name}.o${duplicates.size}`
+            : name;
+        duplicates.set(type, addicted);
+        return addicted;
+    }
+}

package/src/factories/MetadataFactory.ts

@@ -1,47 +1,47 @@
-import ts from "typescript";
-
-import { Metadata } from "../metadata/Metadata";
-import { explore_metadata } from "./internal/metadata/explore_metadata";
-
-import { ArrayUtil } from "../utils/ArrayUtil";
-
-import { MetadataCollection } from "./MetadataCollection";
-
-export namespace MetadataFactory {
-    export interface IOptions {
-        resolve: boolean;
-        constant: boolean;
-        validate?: (meta: Metadata) => void;
-    }
-
-    export function generate(
-        checker: ts.TypeChecker,
-        collection: MetadataCollection,
-        type: ts.Type | null,
-        options: IOptions,
-    ): Metadata {
-        // CONSTRUCT SCHEMA WITH OBJECTS
-        const metadata: Metadata = explore_metadata(checker)(options)(
-            collection,
-        )(type, false);
-
-        // FIND RECURSIVE OBJECTS
-        for (const object of collection.objects())
-            object.recursive = object.properties.some(
-                (prop) =>
-                    ArrayUtil.has(
-                        prop.value.objects,
-                        (elem) => elem.name === object.name,
-                    ) ||
-                    prop.value.arrays.some((meta) =>
-                        ArrayUtil.has(
-                            meta.objects,
-                            (elem) => elem.name === object.name,
-                        ),
-                    ),
-            );
-
-        // RETURNS
-        return metadata;
-    }
-}
+import ts from "typescript";
+
+import { Metadata } from "../metadata/Metadata";
+import { explore_metadata } from "./internal/metadata/explore_metadata";
+
+import { ArrayUtil } from "../utils/ArrayUtil";
+
+import { MetadataCollection } from "./MetadataCollection";
+
+export namespace MetadataFactory {
+    export interface IOptions {
+        resolve: boolean;
+        constant: boolean;
+        validate?: (meta: Metadata) => void;
+    }
+
+    export function generate(
+        checker: ts.TypeChecker,
+        collection: MetadataCollection,
+        type: ts.Type | null,
+        options: IOptions,
+    ): Metadata {
+        // CONSTRUCT SCHEMA WITH OBJECTS
+        const metadata: Metadata = explore_metadata(checker)(options)(
+            collection,
+        )(type, false);
+
+        // FIND RECURSIVE OBJECTS
+        for (const object of collection.objects())
+            object.recursive = object.properties.some(
+                (prop) =>
+                    ArrayUtil.has(
+                        prop.value.objects,
+                        (elem) => elem.name === object.name,
+                    ) ||
+                    prop.value.arrays.some((meta) =>
+                        ArrayUtil.has(
+                            meta.objects,
+                            (elem) => elem.name === object.name,
+                        ),
+                    ),
+            );
+
+        // RETURNS
+        return metadata;
+    }
+}