@nestia/migrate 6.0.5 → 7.0.0-dev.20250605

package/src/{internal/MigrateCommander.ts → executable/NestiaMigrateCommander.ts}

@@ -1,94 +1,98 @@
-import { OpenApiV3, OpenApiV3_1, SwaggerV2 } from "@samchon/openapi";
-import sortImport from "@trivago/prettier-plugin-sort-imports";
-import fs from "fs";
-import path from "path";
-import { format } from "prettier";
-import jsDoc from "prettier-plugin-jsdoc";
-import typia, { IValidation, tags } from "typia";
-
-import { MigrateApplication } from "../MigrateApplication";
-import { MigrateFileArchiver } from "../archivers/MigrateFileArchiver";
-import { MigrateInquirer } from "./MigrateInquirer";
-
-export namespace MigrateCommander {
-  export const main = async (): Promise<void> => {
-    const resolve = (str: string | undefined) =>
-      str ? path.resolve(str).split("\\").join("/") : undefined;
-    const options: MigrateInquirer.IOutput = await MigrateInquirer.parse();
-
-    // VALIDATE OUTPUT DIRECTORY
-    const parent: string = resolve(options.output + "/..")!;
-    if (fs.existsSync(options.output)) halt("Output directory already exists.");
-    else if (fs.existsSync(parent) === false)
-      halt("Output directory's parent directory does not exist.");
-    else if (fs.statSync(parent).isDirectory() === false)
-      halt("Output directory's parent is not a directory.");
-
-    // READ SWAGGER
-    const document:
-      | SwaggerV2.IDocument
-      | OpenApiV3.IDocument
-      | OpenApiV3_1.IDocument = await (async () => {
-      if (typia.is<string & tags.Format<"uri">>(options.input)) {
-        const response: Response = await fetch(options.input);
-        const content: string = await response.text();
-        return JSON.parse(content);
-      }
-      if (fs.existsSync(options.input) === false)
-        halt("Unable to find the input swagger.json file.");
-      const stats: fs.Stats = fs.statSync(options.input);
-      if (stats.isFile() === false)
-        halt("The input swagger.json is not a file.");
-      const content: string = await fs.promises.readFile(
-        options.input,
-        "utf-8",
-      );
-      return JSON.parse(content);
-    })();
-
-    const result: IValidation<MigrateApplication> =
-      MigrateApplication.create(document);
-    if (result.success === false) {
-      console.log(result.errors);
-      throw new Error(
-        `Invalid swagger file (must follow the OpenAPI 3.0 spec).`,
-      );
-    }
-
-    const app: MigrateApplication = result.data;
-    const program =
-      options.mode === "nest" ? app.nest(options) : app.sdk(options);
-    if (program.errors)
-      for (const error of program.errors)
-        console.error(
-          `Failed to migrate ${error.method} ${error.path}`,
-          ...error.messages.map((msg) => `  - ${msg}`),
-        );
-    await MigrateFileArchiver.archive({
-      mkdir: fs.promises.mkdir,
-      writeFile: async (file, content) =>
-        fs.promises.writeFile(file, await beautify(content), "utf-8"),
-    })(options.output)(program.files);
-  };
-
-  export const beautify = async (script: string): Promise<string> => {
-    try {
-      return await format(script, {
-        parser: "typescript",
-        plugins: [sortImport, jsDoc],
-        importOrder: ["<THIRD_PARTY_MODULES>", "^[./]"],
-        importOrderSeparation: true,
-        importOrderSortSpecifiers: true,
-        importOrderParserPlugins: ["decorators-legacy", "typescript", "jsx"],
-        bracketSpacing: true,
-      });
-    } catch {
-      return script;
-    }
-  };
-
-  const halt = (desc: string): never => {
-    console.error(desc);
-    process.exit(-1);
-  };
-}
+import { OpenApiV3, OpenApiV3_1, SwaggerV2 } from "@samchon/openapi";
+import sortImport from "@trivago/prettier-plugin-sort-imports";
+import fs from "fs";
+import path from "path";
+import { format } from "prettier";
+import jsDoc from "prettier-plugin-jsdoc";
+import typia, { IValidation, tags } from "typia";
+
+import { NestiaMigrateApplication } from "../NestiaMigrateApplication";
+import { NestiaMigrateFileArchiver } from "../archivers/NestiaMigrateFileArchiver";
+import { NestiaMigrateInquirer } from "./NestiaMigrateInquirer";
+
+export namespace NestiaMigrateCommander {
+  export const main = async (): Promise<void> => {
+    const resolve = (str: string | undefined) =>
+      str ? path.resolve(str).split("\\").join("/") : undefined;
+    const options: NestiaMigrateInquirer.IOutput =
+      await NestiaMigrateInquirer.parse();
+
+    // VALIDATE OUTPUT DIRECTORY
+    const parent: string = resolve(options.output + "/..")!;
+    if (fs.existsSync(options.output))
+      halt("Response directory already exists.");
+    else if (fs.existsSync(parent) === false)
+      halt("Response directory's parent directory does not exist.");
+    else if (fs.statSync(parent).isDirectory() === false)
+      halt("Response directory's parent is not a directory.");
+
+    // READ SWAGGER
+    const document:
+      | SwaggerV2.IDocument
+      | OpenApiV3.IDocument
+      | OpenApiV3_1.IDocument = await (async () => {
+      if (typia.is<string & tags.Format<"uri">>(options.input)) {
+        const response: Response = await fetch(options.input);
+        const content: string = await response.text();
+        return JSON.parse(content);
+      }
+      if (fs.existsSync(options.input) === false)
+        halt("Unable to find the input swagger.json file.");
+      const stats: fs.Stats = fs.statSync(options.input);
+      if (stats.isFile() === false)
+        halt("The input swagger.json is not a file.");
+      const content: string = await fs.promises.readFile(
+        options.input,
+        "utf-8",
+      );
+      return JSON.parse(content);
+    })();
+
+    const result: IValidation<NestiaMigrateApplication> =
+      NestiaMigrateApplication.validate(document);
+    if (result.success === false) {
+      console.log(result.errors);
+      throw new Error(
+        `Invalid swagger file (must follow the OpenAPI 3.0 spec).`,
+      );
+    }
+
+    const app: NestiaMigrateApplication = result.data;
+    const files: Record<string, string> =
+      options.mode === "nest" ? app.nest(options) : app.sdk(options);
+    if (app.getErrors())
+      for (const error of app.getErrors())
+        console.error(
+          `Failed to migrate ${error.method} ${error.path}`,
+          ...error.messages.map((msg) => `  - ${msg}`),
+        );
+    await NestiaMigrateFileArchiver.archive({
+      mkdir: fs.promises.mkdir,
+      writeFile: async (file, content) =>
+        fs.promises.writeFile(file, await beautify(content), "utf-8"),
+      root: options.output,
+      files,
+    });
+  };
+
+  export const beautify = async (script: string): Promise<string> => {
+    try {
+      return await format(script, {
+        parser: "typescript",
+        plugins: [sortImport, jsDoc],
+        importOrder: ["<THIRD_PARTY_MODULES>", "^[./]"],
+        importOrderSeparation: true,
+        importOrderSortSpecifiers: true,
+        importOrderParserPlugins: ["decorators-legacy", "typescript", "jsx"],
+        bracketSpacing: true,
+      });
+    } catch {
+      return script;
+    }
+  };
+
+  const halt = (desc: string): never => {
+    console.error(desc);
+    process.exit(-1);
+  };
+}

package/src/{internal/MigrateInquirer.ts → executable/NestiaMigrateInquirer.ts}

@@ -1,89 +1,106 @@
-import commander from "commander";
-import inquirer from "inquirer";
-
-export namespace MigrateInquirer {
-  export interface IOutput {
-    mode: "nest" | "sdk";
-    input: string;
-    output: string;
-    simulate: boolean;
-    e2e: boolean;
-    package: string;
-  }
-
-  export const parse = async (): Promise<IOutput> => {
-    // PREPARE ASSETS
-    commander.program.option("--mode [nest/sdk]", "migration mode");
-    commander.program.option(
-      "--input [swagger.json]",
-      "location of target swagger.json file",
-    );
-    commander.program.option("--output [directory]", "output directory path");
-    commander.program.option("--simulate", "Mockup simulator");
-    commander.program.option("--e2e [boolean]", "Generate E2E tests");
-    commander.program.option("--package [name]", "Package name");
-
-    // INTERNAL PROCEDURES
-    const questioned = { value: false };
-    const action = (closure: (options: Partial<IOutput>) => Promise<IOutput>) =>
-      new Promise<IOutput>((resolve, reject) => {
-        commander.program.action(async (options) => {
-          try {
-            resolve(await closure(options));
-          } catch (exp) {
-            reject(exp);
-          }
-        });
-        commander.program.parseAsync().catch(reject);
-      });
-    const select =
-      (name: string) =>
-      (message: string) =>
-      async <Choice extends string>(
-        choices: Choice[],
-        filter?: (value: string) => Choice,
-      ): Promise<Choice> => {
-        questioned.value = true;
-        return (
-          await inquirer.createPromptModule()({
-            type: "list",
-            name: name,
-            message: message,
-            choices: choices,
-            filter,
-          })
-        )[name];
-      };
-    const input = (name: string) => async (message: string) =>
-      (
-        await inquirer.createPromptModule()({
-          type: "input",
-          name,
-          message,
-        })
-      )[name];
-
-    // DO CONSTRUCT
-    return action(async (partial) => {
-      partial.mode ??= await select("mode")("Migration mode")(
-        ["NestJS" as "nest", "SDK" as "sdk"],
-        (value) => (value === "NestJS" ? "nest" : "sdk"),
-      );
-      partial.input ??= await input("input")("Swagger file location");
-      partial.output ??= await input("output")("Output directory path");
-      partial.package ??= await input("package")("Package name");
-      if (partial.simulate)
-        partial.simulate = (partial.simulate as any) === "true";
-      else
-        partial.simulate =
-          (await select("simulate")("Mokup Simulator")(["true", "false"])) ===
-          "true";
-      if (partial.e2e) partial.e2e = (partial.e2e as any) === "true";
-      else
-        partial.e2e =
-          (await select("e2e")("Generate E2E tests")(["true", "false"])) ===
-          "true";
-      return partial as IOutput;
-    });
-  };
-}
+import commander from "commander";
+import inquirer from "inquirer";
+
+export namespace NestiaMigrateInquirer {
+  export interface IOutput {
+    mode: "nest" | "sdk";
+    input: string;
+    output: string;
+    keyword: boolean;
+    simulate: boolean;
+    e2e: boolean;
+    package: string;
+  }
+
+  export const parse = async (): Promise<IOutput> => {
+    // PREPARE ASSETS
+    commander.program.option("--mode [nest/sdk]", "migration mode");
+    commander.program.option(
+      "--input [swagger.json]",
+      "location of target swagger.json file",
+    );
+    commander.program.option("--output [directory]", "output directory path");
+    commander.program.option("--keyword [boolean]", "Keyword parameter mode");
+    commander.program.option("--simulate [boolean]", "Mockup simulator");
+    commander.program.option("--e2e [boolean]", "Generate E2E tests");
+    commander.program.option("--package [name]", "Package name");
+
+    // INTERNAL PROCEDURES
+    const questioned = { value: false };
+    const action = (closure: (options: Partial<IOutput>) => Promise<IOutput>) =>
+      new Promise<IOutput>((resolve, reject) => {
+        commander.program.action(async (options) => {
+          try {
+            resolve(await closure(options));
+          } catch (exp) {
+            reject(exp);
+          }
+        });
+        commander.program.parseAsync().catch(reject);
+      });
+    const select =
+      (name: string) =>
+      (message: string) =>
+      async <Choice extends string>(
+        choices: Choice[],
+        filter?: (value: string) => Choice,
+      ): Promise<Choice> => {
+        questioned.value = true;
+        return (
+          await inquirer.createPromptModule()({
+            type: "list",
+            name: name,
+            message: message,
+            choices: choices,
+            filter,
+          })
+        )[name];
+      };
+    const input = (name: string) => async (message: string) =>
+      (
+        await inquirer.createPromptModule()({
+          type: "input",
+          name,
+          message,
+        })
+      )[name];
+
+    // DO CONSTRUCT
+    return action(async (partial) => {
+      partial.mode ??= await select("mode")("Migration mode")(
+        ["NestJS" as "nest", "SDK" as "sdk"],
+        (value) => (value === "NestJS" ? "nest" : "sdk"),
+      );
+      partial.input ??= await input("input")("Swagger file location");
+      partial.output ??= await input("output")("Response directory path");
+      partial.package ??= await input("package")("Package name");
+      partial.keyword ??=
+        (await select("keyword")("Keyword parameter mode")([
+          "true",
+          "false",
+        ])) === "true";
+
+      if (partial.keyword)
+        partial.keyword = (partial.keyword as any) === "true";
+      else
+        partial.keyword =
+          (await select("keyword")("Keyword parameter mode")([
+            "true",
+            "false",
+          ])) === "true";
+      if (partial.simulate)
+        partial.simulate = (partial.simulate as any) === "true";
+      else
+        partial.simulate =
+          (await select("simulate")("Mokup Simulator")(["true", "false"])) ===
+          "true";
+
+      if (partial.e2e) partial.e2e = (partial.e2e as any) === "true";
+      else
+        partial.e2e =
+          (await select("e2e")("Generate E2E tests")(["true", "false"])) ===
+          "true";
+      return partial as IOutput;
+    });
+  };
+}

package/src/executable/bundle.js

@@ -1,127 +1,129 @@
-const { version } = require("../../../../package.json");
-const cp = require("child_process");
-const fs = require("fs");
-
-const ROOT = `${__dirname}/../..`;
-const ASSETS = `${ROOT}/assets`;
-
-const update = (content) => {
-  const parsed = JSON.parse(content);
-  for (const record of [
-    parsed.dependencies ?? {},
-    parsed.devDependencies ?? {},
-  ])
-    for (const key of Object.keys(record))
-      if (
-        key === "@nestia/core" ||
-        key === "@nestia/fetcher" ||
-        key === "@nestia/sdk"
-      )
-        record[key] = `^${version}`;
-  return JSON.stringify(parsed, null, 2);
-};
-
-const bundle = async ({ mode, repository, exceptions, transform }) => {
-  const root = `${__dirname}/../..`;
-  const assets = `${root}/assets`;
-  const template = `${assets}/${mode}`;
-
-  const clone = async () => {
-    // CLONE REPOSITORY
-    if (fs.existsSync(template))
-      await fs.promises.rm(template, { recursive: true });
-    else
-      try {
-        await fs.promises.mkdir(ASSETS);
-      } catch {}
-
-    cp.execSync(`git clone https://github.com/samchon/${repository} ${mode}`, {
-      cwd: ASSETS,
-    });
-
-    // REMOVE VULNERABLE FILES
-    for (const location of exceptions ?? [])
-      await fs.promises.rm(`${template}/${location}`, { recursive: true });
-  };
-
-  const iterate = (collection) => async (location) => {
-    const directory = await fs.promises.readdir(location);
-    for (const file of directory) {
-      const absolute = location + "/" + file;
-      const stats = await fs.promises.stat(absolute);
-      if (stats.isDirectory()) await iterate(collection)(absolute);
-      else {
-        const content = await fs.promises.readFile(absolute, "utf-8");
-        collection.push({
-          location: (() => {
-            const str = location.replace(template, "");
-            return str[0] === "/" ? str.substring(1) : str;
-          })(),
-          file,
-          content,
-        });
-      }
-    }
-  };
-
-  const archive = async (collection) => {
-    const name = `${mode.toUpperCase()}_TEMPLATE`;
-    const body = JSON.stringify(collection, null, 2);
-    const content = `export const ${name} = ${body}`;
-
-    try {
-      await fs.promises.mkdir(`${ROOT}/src/bundles`);
-    } catch {}
-    await fs.promises.writeFile(
-      `${ROOT}/src/bundles/${name}.ts`,
-      content,
-      "utf8",
-    );
-  };
-
-  const collection = [];
-  await clone();
-  await iterate(collection)(template);
-  if (transform) for (const it of collection) transform(it);
-  await archive(collection);
-};
-
-const main = async () => {
-  await bundle({
-    mode: "nest",
-    repository: "nestia-start",
-    exceptions: [
-      ".git",
-      ".github/dependabot.yml",
-      ".github/workflows/dependabot-automerge.yml",
-      "src/api/functional",
-      "src/controllers",
-      "src/MyModule.ts",
-      "src/providers",
-      "test/features",
-    ],
-    transform: (it) => {
-      if (it.file === "package.json") it.content = update(it.content);
-    },
-  });
-  await bundle({
-    mode: "sdk",
-    repository: "nestia-sdk-template",
-    exceptions: [
-      ".git",
-      ".github/dependabot.yml",
-      ".github/workflows/build.yml",
-      ".github/workflows/dependabot-automerge.yml",
-      "src/functional",
-      "src/structures",
-      "test/features",
-    ],
-    transform: (it) => {
-      if (it.file === "package.json") it.content = update(it.content);
-    },
-  });
-};
-main().catch((exp) => {
-  console.error(exp);
-  process.exit(-1);
-});
+const { version } = require("../../../../package.json");
+const cp = require("child_process");
+const fs = require("fs");
+
+const ROOT = `${__dirname}/../..`;
+const ASSETS = `${ROOT}/assets`;
+
+const update = (content) => {
+  const parsed = JSON.parse(content);
+  for (const record of [
+    parsed.dependencies ?? {},
+    parsed.devDependencies ?? {},
+  ])
+    for (const key of Object.keys(record))
+      if (
+        key === "@nestia/core" ||
+        key === "@nestia/fetcher" ||
+        key === "@nestia/sdk"
+      )
+        record[key] = `^${version}`;
+  return JSON.stringify(parsed, null, 2);
+};
+
+const bundle = async ({ mode, repository, exceptions, transform }) => {
+  const root = `${__dirname}/../..`;
+  const assets = `${root}/assets`;
+  const template = `${assets}/${mode}`;
+
+  const clone = async () => {
+    // CLONE REPOSITORY
+    if (fs.existsSync(template))
+      await fs.promises.rm(template, { recursive: true });
+    else
+      try {
+        await fs.promises.mkdir(ASSETS);
+      } catch {}
+
+    cp.execSync(`git clone https://github.com/samchon/${repository} ${mode}`, {
+      cwd: ASSETS,
+    });
+
+    // REMOVE VULNERABLE FILES
+    for (const location of exceptions ?? [])
+      await fs.promises.rm(`${template}/${location}`, { recursive: true });
+  };
+
+  const iterate = (collection) => async (location) => {
+    const directory = await fs.promises.readdir(location);
+    for (const file of directory) {
+      const absolute = location + "/" + file;
+      const stats = await fs.promises.stat(absolute);
+      if (stats.isDirectory()) await iterate(collection)(absolute);
+      else {
+        const content = await fs.promises.readFile(absolute, "utf-8");
+        collection[
+          (() => {
+            const str = absolute.replace(template, "");
+            return str[0] === "/" ? str.substring(1) : str;
+          })()
+        ] = content;
+      }
+    }
+  };
+
+  const archive = async (collection) => {
+    const name = `${mode.toUpperCase()}_TEMPLATE`;
+    const body = JSON.stringify(collection, null, 2);
+    const content = `export const ${name}: Record<string, string> = ${body}`;
+
+    try {
+      await fs.promises.mkdir(`${ROOT}/src/bundles`);
+    } catch {}
+    await fs.promises.writeFile(
+      `${ROOT}/src/bundles/${name}.ts`,
+      content,
+      "utf8",
+    );
+  };
+
+  const collection = {};
+  await clone();
+  await iterate(collection)(template);
+  if (transform)
+    for (const [key, value] of Object.entries(collection))
+      collection[key] = transform(key, value);
+  await archive(collection);
+};
+
+const main = async () => {
+  await bundle({
+    mode: "nest",
+    repository: "nestia-start",
+    exceptions: [
+      ".git",
+      ".github/dependabot.yml",
+      ".github/workflows/dependabot-automerge.yml",
+      "src/api/functional",
+      "src/controllers",
+      "src/MyModule.ts",
+      "src/providers",
+      "test/features",
+    ],
+    transform: (key, value) => {
+      if (key === "package.json") return update(value);
+      return value;
+    },
+  });
+  await bundle({
+    mode: "sdk",
+    repository: "nestia-sdk-template",
+    exceptions: [
+      ".git",
+      ".github/dependabot.yml",
+      ".github/workflows/build.yml",
+      ".github/workflows/dependabot-automerge.yml",
+      "src/functional",
+      "src/structures",
+      "test/features",
+    ],
+    transform: (key, value) => {
+      if (key === "package.json") return update(value);
+      return value;
+    },
+  });
+};
+main().catch((exp) => {
+  console.error(exp);
+  process.exit(-1);
+});