Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import { type CanonicalSchema } from "@patchlogr/types";
import { type OpenAPIV2 } from "openapi-types";
import type { OpenAPISchemaObjectWithCommonProps } from "../oas-common/schemaGuards";
import { isSchemaObject } from "../oas-common/schemaGuards";

export function toCanonicalSchema(
Expand Down
6 changes: 5 additions & 1 deletion packages/patchlogr-cli/src/commands/canonicalize.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,11 @@ export type CanonicalizeOptions = OASStageOptions & {

export const canonicalizeCommand = new Command("canonicalize")
.argument("<api-docs>", "Path to the OpenAPI specification file")
.option("--skipValidation", "Skip validation of the OpenAPI specification")
.option(
"--skipValidation",
"Skip validation of the OpenAPI specification",
true,
)
.option(
"-o, --output <file>",
"Write result to file instead of stdout (default: stdout)",
Expand Down
84 changes: 84 additions & 0 deletions packages/patchlogr-cli/src/commands/diff.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
import { preprocessOASDocument } from "@patchlogr/adapter-oas";
import {
detectVersionBump,
diffSpec,
partitionByMethod,
partitionByTag,
type PartitionedSpec,
} from "@patchlogr/core";

import { Command } from "commander";
import { type OpenAPI } from "openapi-types";

import fs from "fs/promises";

export type DiffOptions = {
partition: "tag" | "method";
output?: "stdout" | string;
skipValidation: boolean;
};

export const diffCommand = new Command("diff")
.description("Diff two OpenAPI Specification files")
.argument("<base>", "Base OpenAPI Specification file")
.argument("<head>", "Head OpenAPI Specification file")
.option("-o, --output <file>", "Output file")
.option("--skipValidation", "Skip validation", true)
.option("-p, --partition <partition>", "Partition Strategy", "tag")
.action(diffAction);

export async function diffAction(
basePath: OpenAPI.Document,
headPath: OpenAPI.Document,
options: DiffOptions,
) {
const preprocessedBase = await preprocessOASDocument(basePath, {
skipValidation: options.skipValidation,
});
const preprocessedHead = await preprocessOASDocument(headPath, {
skipValidation: options.skipValidation,
});

const baseCanonicalSpec = preprocessedBase.canonicalSpec;
const headCanonicalSpec = preprocessedHead.canonicalSpec;

if (!baseCanonicalSpec || !headCanonicalSpec) {
throw new Error("Failed to preprocess OpenAPI Specification files");
}

let partitionedBase: PartitionedSpec;
let partitionedHead: PartitionedSpec;

switch (options.partition) {
case "method":
partitionedBase = partitionByMethod(baseCanonicalSpec);
partitionedHead = partitionByMethod(headCanonicalSpec);
break;
case "tag":
default:
partitionedBase = partitionByTag(baseCanonicalSpec);
partitionedHead = partitionByTag(headCanonicalSpec);
break;
}

const specChangeSet = diffSpec(partitionedBase, partitionedHead);
const versionBump = detectVersionBump(specChangeSet);

const result = { specChangeSet, versionBump };

if (options.output === "stdout" || options.output === undefined) {
console.log(JSON.stringify(result, null, 2));
} else {
try {
await fs.writeFile(
options.output,
JSON.stringify(result, null, 2),
"utf-8",
);
} catch (error) {
throw new Error(`Failed to write to file ${options.output}:`, {
cause: error,
});
}
}
}
4 changes: 3 additions & 1 deletion packages/patchlogr-cli/src/createCLI.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,14 @@ import pkg from "../package.json";

import { helpCommand } from "./commands/help";
import { canonicalizeCommand } from "./commands/canonicalize";
import { diffCommand } from "./commands/diff";

export function createCLI() {
return new Command()
.name("patchlogr")
.version(pkg.version)
.description("PatchlogrCLI : changelogs from openapi specs")
.addCommand(helpCommand)
.addCommand(canonicalizeCommand);
.addCommand(canonicalizeCommand)
.addCommand(diffCommand);
}
4 changes: 3 additions & 1 deletion packages/patchlogr-core/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@

"declaration": true,
"declarationMap": true,
"emitDeclarationOnly": false
"emitDeclarationOnly": false,

"noEmit": false
},
"include": ["src"]
}
Loading