Setup esbuild build script

eslint.config.mjs

@@ -11,6 +11,7 @@ export default tseslint.config(
             "**/node_modules/**",
             "**/.turbo/**",
             "**/coverage/**",
+            "**/.coverage/**",
             "**/.yarn/**",
             "**/.pnp.*",
             "**/*.mjs",
@@ -48,11 +49,19 @@ export default tseslint.config(
                     argsIgnorePattern: "^_",
                 },
             ],
+            "@typescript-eslint/consistent-type-imports": [
+                "error",
+                {
+                    prefer: "type-imports",
+                    disallowTypeAnnotations: false,
+                },
+            ],
         },
     },
     {
         files: ["**/*.{test,spec}.{ts,tsx,js,jsx}"],
         rules: {
+            "@typescript-eslint/no-explicit-any": "off",
             "no-restricted-imports": [
                 "error",
                 {

package.json

@@ -10,6 +10,7 @@
         "build": "turbo run build --cache-dir=.turbo",
         "test": "turbo run test --cache-dir=.turbo",
         "lint": "turbo run lint --cache-dir=.turbo",
+        "lint:fix": "turbo run lint:fix --cache-dir=.turbo",
         "typecheck": "turbo run typecheck --cache-dir=.turbo",
         "clean": "turbo run clean && rm -rf node_modules .turbo"
     },

packages/patchlogr-cli/esbuild.mjs

@@ -5,6 +5,8 @@ await build({
     entryPoints: [path.resolve("src/index.ts")],
     outfile: "dist/index.js",
     platform: "node",
+    bundle: true,
+    sourcemap: true,
     banner: {
         js: "#!/usr/bin/env node",
     },

packages/patchlogr-cli/package.json

@@ -4,17 +4,24 @@
     "publishConfig": {
         "access": "public"
     },
+    "bin": {
+        "patchlogr": "./dist/index.js"
+    },
     "scripts": {
         "clean": "rm -rf dist",
         "typecheck": "tsc -p tsconfig.json --noEmit",
         "build:types": "tsc -p tsconfig.json --emitDeclarationOnly",
         "build:js": "node ./esbuild.mjs",
         "build": "yarn clean && yarn build:types && yarn build:js",
+        "preview": "node dist/index.js",
         "test": "vitest",
-        "lint": "eslint ."
+        "lint": "eslint .",
+        "lint:fix": "eslint . --fix"
     },
     "dependencies": {
-        "@patchlogr/core": "workspace:*"
+        "@patchlogr/core": "workspace:*",
+        "@patchlogr/oas": "workspace:*",
+        "commander": "^14.0.2"
     },
     "devDependencies": {
         "@types/node": "24",

packages/patchlogr-cli/src/cli.ts

@@ -0,0 +1,37 @@
+import { Command } from "commander";
+
+export function createCLI() {
+    const program = new Command();
+
+    program
+        .name("patchlogr")
+        .version("0.0.0")
+        .description("PatchlogrCLI : changelogs from openapi specs");
+
+    program
+        .command("help")
+        .description("Display help information about patchlogr commands");
+
+    program
+        .command("canonicalize")
+        .argument("<api-docs>", "Path to the OpenAPI specification file")
+        .option("--canonicalize", "Canonicalize the OpenAPI specification")
+        .option(
+            "--skipValidation",
+            "Skip validation of the OpenAPI specification",
+        )
+        .option(
+            "-o, --output <file>",
+            "Write result to file instead of stdout (default: stdout)",
+        )
+        .action(async (apiDocs, options) => {
+            try {
+                console.log("[patchlogr] Processing:", apiDocs, options);
+            } catch (error) {
+                console.error("[patchlogr] Error:", (error as Error).message);
+                process.exitCode = 1;
+            }
+        });
+
+    return program;
+}

packages/patchlogr-cli/src/commands/runCanonicalize.ts

@@ -0,0 +1,11 @@
+import { preprocessOASDocument } from "@patchlogr/oas";
+import { type OASStageOptions } from "@patchlogr/oas";
+
+export type RunCanonicalizeOptions = OASStageOptions;
+
+export async function runCanonicalize(
+    apiDocs: any,
+    options: RunCanonicalizeOptions,
+) {
+    preprocessOASDocument(apiDocs, { ...options });
+}

packages/patchlogr-cli/src/index.ts

@@ -0,0 +1,8 @@
+import { createCLI } from "./cli";
+
+const program = createCLI();
+
+program.parseAsync(process.argv).catch((error) => {
+    console.error("[patchlogr] Error:", error);
+    process.exitCode = 1;
+});

packages/patchlogr-core/package.json

@@ -22,7 +22,8 @@
         "build:js": "node ./esbuild.mjs",
         "build": "yarn clean && yarn build:types && yarn build:js",
         "test": "vitest",
-        "lint": "eslint ."
+        "lint": "eslint .",
+        "lint:fix": "eslint . --fix"
     },
     "dependencies": {
         "@apidevtools/swagger-parser": "^12.1.0",

packages/patchlogr-oas/esbuild.mjs

@@ -0,0 +1,16 @@
+import { build } from "esbuild";
+import pkg from "./package.json" with { type: "json" };
+
+await build({
+    entryPoints: ["src/index.ts"],
+    outdir: "dist",
+    bundle: true,
+    platform: "node",
+    target: ["node18", "node20", "node24"],
+    format: "esm",
+    sourcemap: true,
+    external: [
+        ...Object.keys(pkg.dependencies || {}),
+        ...Object.keys(pkg.peerDependencies || {}),
+    ],
+});

packages/patchlogr-oas/package.json

@@ -5,12 +5,24 @@
         "access": "public"
     },
     "scripts": {
+        "clean": "rm -rf dist",
         "lint": "eslint .",
+        "lint:fix": "eslint . --fix",
         "test": "vitest",
-        "typecheck": "tsc --noEmit"
+        "typecheck": "tsc --noEmit",
+        "build:types": "tsc -p tsconfig.json --emitDeclarationOnly",
+        "build:js": "node ./esbuild.mjs",
+        "build": "yarn clean && yarn build:types && yarn build:js"
+    },
+    "exports": {
+        ".": {
+            "import": "./dist/index.js",
+            "types": "./dist/index.d.ts"
+        }
     },
     "devDependencies": {
         "@types/node": "24",
+        "esbuild": "^0.27.2",
         "openapi-types": "^12.1.3",
         "vitest": "^4.0.16"
     },

packages/patchlogr-oas/src/__tests__/preprocessOASDocument.test.ts

@@ -1,6 +1,6 @@
 import { describe, expect, test } from "vitest";
 import { preprocessOASDocument } from "../index";
-import { OpenAPIV2, OpenAPIV3 } from "openapi-types";
+import type { OpenAPIV2, OpenAPIV3 } from "openapi-types";
 
 const docV2: OpenAPIV2.Document = {
     swagger: "2.0",

packages/patchlogr-oas/src/canonicalize/__fixtures__/docV2.ts

@@ -1,4 +1,4 @@
-import { OpenAPIV2 } from "openapi-types";
+import type { OpenAPIV2 } from "openapi-types";
 
 export const docV2: OpenAPIV2.Document = {
     swagger: "2.0",

packages/patchlogr-oas/src/canonicalize/__fixtures__/docV3.ts

@@ -1,4 +1,4 @@
-import { OpenAPIV3 } from "openapi-types";
+import type { OpenAPIV3 } from "openapi-types";
 
 export const docV3: OpenAPIV3.Document = {
     openapi: "3.0.0",

packages/patchlogr-oas/src/canonicalize/__tests__/v3/canonicalizeOASV3.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, test } from "vitest";
-import { CanonicalSchema } from "@patchlogr/types";
+import type { CanonicalSchema } from "@patchlogr/types";
 
 import {
     canonicalizeOASV3,

packages/patchlogr-oas/src/canonicalize/v2/index.ts

@@ -1,4 +1,4 @@
-import {
+import type {
     CanonicalOperation,
     CanonicalParam,
     CanonicalSpec,
@@ -9,7 +9,7 @@
     CanonicalOperationDoc,
     CanonicalSecurityRequirement,
 } from "@patchlogr/types";
-import { OpenAPIV2 } from "openapi-types";
+import type { OpenAPIV2 } from "openapi-types";
 import { toCanonicalSchema } from "../../utils/toCanonicalSchema";
 
 const HTTP_METHODS = [
@@ -353,16 +353,16 @@
     operation: OpenAPIV2.OperationObject,
     formDataParams: OpenAPIV2.GeneralParameterObject[],
 ): CanonicalBody {
     const properties: Record<string, any> = {};
     const required: string[] = [];
 
     for (const param of formDataParams) {
         const {
             name,
             in: inParam,
             required: requiredParam,
             description,
             allowEmptyValue,
             items,
             ...schemaProps
         } = param;

packages/patchlogr-oas/src/canonicalize/v3/index.ts

@@ -1,4 +1,4 @@
-import {
+import type {
     CanonicalOperation,
     CanonicalParam,
     CanonicalSpec,
@@ -9,7 +9,7 @@ import {
     CanonicalOperationDoc,
     CanonicalSecurityRequirement,
 } from "@patchlogr/types";
-import { OpenAPIV3 } from "openapi-types";
+import type { OpenAPIV3 } from "openapi-types";
 import { toCanonicalSchema } from "../../utils/toCanonicalSchema";
 
 const HTTP_METHODS = [

packages/patchlogr-oas/src/guards/parameterGuards.ts

@@ -1,4 +1,4 @@
-import { CanonicalParam } from "@patchlogr/types";
+import type { CanonicalParam } from "@patchlogr/types";
 
 export function isValidCanonicalParamIn(
     val: string,

packages/patchlogr-oas/src/guards/schemaGuards.ts

@@ -1,21 +1,21 @@
-import { OpenAPIV2, OpenAPIV3 } from "openapi-types";
+import type { OpenAPIV2, OpenAPIV3 } from "openapi-types";
 
 export type OpenAPISchemaObject =
     | OpenAPIV2.SchemaObject
     | OpenAPIV3.SchemaObject;
 
 export type OpenAPISchemaObjectWithItems = OpenAPISchemaObject & {
     items?: any;
 };
 
 export type OpenAPISchemaObjectWithCommonProps =
     OpenAPISchemaObjectWithItems & {
         required?: string[];
         properties?: Record<string, any>;
         [key: string]: any;
     };
 
 export function isSchemaObject(obj: any): obj is OpenAPISchemaObject {
     return (
         typeof obj === "object" &&
         obj !== null &&
@@ -25,7 +25,7 @@
 }
 
 export function isSchemaWithCommonProps(
     obj: any,
 ): obj is OpenAPISchemaObjectWithCommonProps {
     return (
         isSchemaObject(obj) &&
@@ -36,7 +36,7 @@
 }
 
 export function isReferenceObject(
     obj: any,
 ): obj is OpenAPIV2.ReferenceObject | OpenAPIV3.ReferenceObject {
     return (
         typeof obj === "object" &&

packages/patchlogr-oas/src/index.ts

@@ -1,24 +1,2 @@
-import { OpenAPI } from "openapi-types";
-import { PipelineExecutor } from "./pipeline/PipelineExecutor";
-import { OASValidationStage } from "./pipeline/OASValidationStage";
-import { OASCanonicalizeStage } from "./pipeline/OASCanonicalizeStage";
-import { OASBundleStage } from "./pipeline/OASBundleStage";
-import { OASStageContext, OASStageOptions } from "./pipeline/OASStageContext";
-import { OASDereferenceStage } from "./pipeline/OASDereferenceStage";
-
-export function preprocessOASDocument(
-    doc: OpenAPI.Document,
-    options: OASStageOptions = {},
-) {
-    const pipelineExecutor = new PipelineExecutor<OASStageContext>();
-
-    pipelineExecutor.add(new OASBundleStage());
-    pipelineExecutor.add(new OASValidationStage());
-    pipelineExecutor.add(new OASDereferenceStage());
-    pipelineExecutor.add(new OASCanonicalizeStage());
-
-    return pipelineExecutor.run({
-        source: doc,
-        options,
-    });
-}
+export { type OASStageOptions } from "./pipeline/OASStageContext";
+export { preprocessOASDocument } from "./preprocessOASDocument";

packages/patchlogr-oas/src/pipeline/OASBundleStage.ts

@@ -1,6 +1,6 @@
 import SwaggerParser from "@apidevtools/swagger-parser";
-import { OASStageContext } from "./OASStageContext";
-import { PipelineStage } from "./PipelineExecutor";
+import type { OASStageContext } from "./OASStageContext";
+import type { PipelineStage } from "./PipelineExecutor";
 
 /**
  * 외부 $ref, schema 를 포함한 모든 문서를 합침

packages/patchlogr-oas/src/pipeline/OASCanonicalizeStage.ts

@@ -1,6 +1,6 @@
-import { CanonicalSpec } from "@patchlogr/types";
-import { OASStageContext } from "./OASStageContext";
-import { PipelineStage } from "./PipelineExecutor";
+import type { CanonicalSpec } from "@patchlogr/types";
+import type { OASStageContext } from "./OASStageContext";
+import type { PipelineStage } from "./PipelineExecutor";
 import { canonicalizeOASV2 } from "../canonicalize/v2";
 import { canonicalizeOASV3 } from "../canonicalize/v3";
 import { isOpenAPIV2, isOpenAPIV3 } from "../utils/oasVersionUtils";

packages/patchlogr-oas/src/pipeline/OASDereferenceStage.ts

@@ -1,6 +1,6 @@
 import SwaggerParser from "@apidevtools/swagger-parser";
-import { OASStageContext } from "./OASStageContext";
-import { PipelineStage } from "./PipelineExecutor";
+import type { OASStageContext } from "./OASStageContext";
+import type { PipelineStage } from "./PipelineExecutor";
 
 /**
  * OAS 문서의 모든 $ref를 평탄화함

packages/patchlogr-oas/src/pipeline/OASStageContext.ts

@@ -1,5 +1,5 @@
-import { CanonicalSpec } from "@patchlogr/types";
-import { OpenAPI } from "openapi-types";
+import type { CanonicalSpec } from "@patchlogr/types";
+import type { OpenAPI } from "openapi-types";
 
 export type OASStageInput = string | OpenAPI.Document;
 

packages/patchlogr-oas/src/pipeline/OASValidationStage.ts

@@ -1,7 +1,7 @@
 import SwaggerParser from "@apidevtools/swagger-parser";
 
-import { PipelineStage } from "./PipelineExecutor";
-import { OASStageContext } from "./OASStageContext";
+import type { PipelineStage } from "./PipelineExecutor";
+import type { OASStageContext } from "./OASStageContext";
 import { getOASVersion } from "../utils/oasVersionUtils";
 
 /**

packages/patchlogr-oas/src/pipeline/__tests__/OASBundleStage.test.ts

@@ -1,8 +1,8 @@
 import { describe, expect, test } from "vitest";
 import { OASBundleStage } from "../OASBundleStage";
-import { OASStageContext } from "../OASStageContext";
+import type { OASStageContext } from "../OASStageContext";
 import path from "path";
-import { OpenAPIV3 } from "openapi-types";
+import type { OpenAPIV3 } from "openapi-types";
 
 describe("OASBundleStage", () => {
     test("should dereference external $ref correctly", async () => {

packages/patchlogr-oas/src/pipeline/__tests__/OASDereferenceStage.test.ts

@@ -1,6 +1,6 @@
 import { describe, test, expect } from "vitest";
 import { OASDereferenceStage } from "../OASDereferenceStage";
-import { OASStageContext } from "../OASStageContext";
+import type { OASStageContext } from "../OASStageContext";
 
 describe("OASDereferenceStage", () => {
     test("should throw an error if input.oas is missing", async () => {

packages/patchlogr-oas/src/pipeline/__tests__/OASValidationStage.test.ts

@@ -1,8 +1,8 @@
-import { OpenAPIV2, OpenAPIV3, OpenAPIV3_1 } from "openapi-types";
+import type { OpenAPIV2, OpenAPIV3, OpenAPIV3_1 } from "openapi-types";
 import { describe, expect, test } from "vitest";
 import SwaggerParser from "@apidevtools/swagger-parser";
 import { OASValidationStage } from "../OASValidationStage";
-import { OASStageContext } from "../OASStageContext";
+import type { OASStageContext } from "../OASStageContext";
 
 const oasFixtureV2: OpenAPIV2.Document = {
     swagger: "2.0",

packages/patchlogr-oas/src/pipeline/__tests__/PipelineExecutor.test.ts

@@ -1,5 +1,6 @@
 import { describe, expect, test, vitest } from "vitest";
-import { PipelineExecutor, PipelineStage } from "../PipelineExecutor";
+import type { PipelineStage } from "../PipelineExecutor";
+import { PipelineExecutor } from "../PipelineExecutor";
 
 describe("PipelineExecutor", () => {
     test("should append stages correctly", () => {

packages/patchlogr-oas/src/preprocessOASDocument.ts

@@ -0,0 +1,27 @@
+import type { OpenAPI } from "openapi-types";
+import { OASBundleStage } from "./pipeline/OASBundleStage";
+import { OASCanonicalizeStage } from "./pipeline/OASCanonicalizeStage";
+import { OASDereferenceStage } from "./pipeline/OASDereferenceStage";
+import type {
+    OASStageOptions,
+    OASStageContext,
+} from "./pipeline/OASStageContext";
+import { OASValidationStage } from "./pipeline/OASValidationStage";
+import { PipelineExecutor } from "./pipeline/PipelineExecutor";
+
+export function preprocessOASDocument(
+    doc: OpenAPI.Document,
+    options: OASStageOptions = {},
+) {
+    const pipelineExecutor = new PipelineExecutor<OASStageContext>();
+
+    pipelineExecutor.add(new OASBundleStage());
+    pipelineExecutor.add(new OASValidationStage());
+    pipelineExecutor.add(new OASDereferenceStage());
+    pipelineExecutor.add(new OASCanonicalizeStage());
+
+    return pipelineExecutor.run({
+        source: doc,
+        options,
+    });
+}

packages/patchlogr-oas/src/utils/__tests__/toCanonicalSchema.test.ts

@@ -1,6 +1,6 @@
 import { describe, test, expect } from "vitest";
 import { toCanonicalSchema } from "../toCanonicalSchema";
-import { OpenAPISchemaObjectWithItems } from "../../guards/schemaGuards";
+import type { OpenAPISchemaObjectWithItems } from "../../guards/schemaGuards";
 
 describe("toCanonicalSchema", () => {
     test("should normalize simple schema", () => {