clean up

Author: alexvuong

.eslintrc.json

@@ -19,7 +19,7 @@
     "max-lines": [
       "error",
       {
-        "max": 600
+        "max": 700
       }
     ],
     "@typescript-eslint/naming-convention": [

src/diff/diffCommand.test.ts

@@ -13,7 +13,7 @@ import { Rule } from "json-rules-engine";
 import chai from "chai";
 import chaiFs from "chai-fs";
 
-import { DiffCommand as cmd, DiffCommand } from "./diffCommand";
+import { DiffCommand as cmd } from "./diffCommand";
 import * as diffDirectories from "./diffDirectories";
 import { NodeChanges } from "./changes/nodeChanges";
 import { ApiChanges } from "./changes/apiChanges";
@@ -24,10 +24,8 @@ import { RuleCategory } from "./ruleCategory";
 import * as oasDiff from "./oasDiff";
 
 import proxyquire from "proxyquire";
-import sinon from "sinon";
 
 chai.use(chaiFs);
-const pq = proxyquire.noCallThru();
 
 const nodeChanges = new NodeChanges("test-id", ["test:type"]);
 nodeChanges.added = { "core:name": "oldName" };

src/diff/oasDiff.test.ts

@@ -193,10 +193,10 @@ describe("oasDiffChangelog", () => {
     execStub.callsArgWith(1, null, "version 1.0.0", "");
     execStub
       .onSecondCall()
-      .callsArgWith(1, null, '{"changes": "in api-v1"}', "");
+      .callsArgWith(1, null, '[{"changes": "in api-v1"}]', "");
     execStub
       .onThirdCall()
-      .callsArgWith(1, null, '{"changes": "in api-v2"}', "");
+      .callsArgWith(1, null, '[{"changes": "in api-v2"}]', "");
 
     const fsStub = {
       readdir: sinon.stub().returns(["api-v1", "api-v2"]),
@@ -226,13 +226,11 @@ describe("oasDiffChangelog", () => {
     expect(writtenContent).to.be.an("array").with.lengthOf(2);
     expect(writtenContent[0]).to.deep.equal({
       directory: "api-v1",
-      status: "modified",
-      changes: { changes: "in api-v1" },
+      changes: [{ changes: "in api-v1" }],
     });
     expect(writtenContent[1]).to.deep.equal({
       directory: "api-v2",
-      status: "modified",
-      changes: { changes: "in api-v2" },
+      changes: [{ changes: "in api-v2" }],
     });
   });
 
@@ -526,6 +524,102 @@ describe("oasDiffChangelog", () => {
     });
   });
 
+  it("should not include directories with empty changes in JSON format", async () => {
+    const execStub = sinon.stub();
+    execStub.callsArgWith(1, null, "version 1.0.0", "");
+    execStub
+      .onSecondCall()
+      .callsArgWith(1, null, '[{"changes": "in api-v1"}]', "");
+    execStub.onThirdCall().callsArgWith(1, null, "[]", ""); // empty array
+
+    const fsStub = {
+      readdir: sinon.stub().returns(["api-v1", "api-v2"]),
+      stat: sinon.stub().returns({ isDirectory: () => true }),
+      writeJson: sinon.stub(),
+    };
+
+    const oasDiff = pq("./oasDiff", {
+      child_process: {
+        exec: execStub,
+      },
+      "fs-extra": fsStub,
+    });
+
+    const baseApi = "base";
+    const newApi = "new";
+    const flags = {
+      "out-file": "output.json",
+      format: "json",
+      dir: true,
+    };
+
+    await oasDiff.oasDiffChangelog(baseApi, newApi, flags);
+
+    expect(fsStub.writeJson.called).to.be.true;
+    const writtenContent = fsStub.writeJson.args[0][1];
+    expect(writtenContent).to.be.an("array").with.lengthOf(1);
+    expect(writtenContent[0]).to.deep.equal({
+      directory: "api-v1",
+      changes: [{ changes: "in api-v1" }],
+    });
+  });
+
+  it("should not include empty results in single file JSON mode", async () => {
+    const execStub = sinon.stub();
+    execStub.callsArgWith(1, null, "", ""); // version check
+    execStub.onSecondCall().callsArgWith(1, null, "[]", ""); // empty array result
+
+    const fsStub = {
+      readdir: sinon.stub().returns(["api-v1"]),
+      stat: sinon.stub().returns({ isDirectory: () => true }),
+    };
+
+    const oasDiff = pq("./oasDiff", {
+      child_process: {
+        exec: execStub,
+      },
+      "fs-extra": fsStub,
+    });
+
+    // Arrange
+    const baseApi = "base.yaml";
+    const newApi = "new.yaml";
+    const flags = { format: "json" };
+    const result = await oasDiff.oasDiffChangelog(baseApi, newApi, flags);
+
+    expect(execStub.called).to.be.true;
+    expect(result).to.equal(0); // No changes should be reported
+  });
+
+  it("should include non-empty results in single file JSON mode", async () => {
+    const execStub = sinon.stub();
+    execStub.callsArgWith(1, null, "", ""); // version check
+    execStub
+      .onSecondCall()
+      .callsArgWith(1, null, '[{"change": "something"}]', ""); // non-empty array result
+
+    const fsStub = {
+      readdir: sinon.stub().returns(["api-v1"]),
+      stat: sinon.stub().returns({ isDirectory: () => true }),
+    };
+
+    const oasDiff = pq("./oasDiff", {
+      child_process: {
+        exec: execStub,
+      },
+      "fs-extra": fsStub,
+    });
+
+    // Arrange
+    const baseApi = "base.yaml";
+    const newApi = "new.yaml";
+    const flags = { format: "json" };
+    const result = await oasDiff.oasDiffChangelog(baseApi, newApi, flags);
+
+    expect(execStub.called).to.be.true;
+    expect(result).to.equal(1); // Changes should be reported
+  });
+
   it("should throw an error if oasdiff is not installed", async () => {
     const execStub = sinon.stub();
     execStub.callsArgWith(1, new Error("oasdiff not installed"));

src/diff/oasDiff.ts

@@ -133,18 +133,19 @@ export async function oasDiffChangelog(baseApi: string, newApi: string, flags) {
             console.log(`Changes found in ${baseDir}`);
             if (flags.format === "json") {
               const outputJson = JSON.parse(oasdiffOutput);
-              if (outputJson.length) {
+              if (outputJson?.length > 0) {
                 allResults.push({
                   directory: baseDir,
                   changes: outputJson,
                 });
+                hasChanges = true;
               }
             } else {
               // For text format, add section headers
               const formattedOutput = `=== Changes in ${baseDir} ===\n${oasdiffOutput}`;
               allResults.push(formattedOutput);
+              hasChanges = true;
             }
-            hasChanges = true;
           } else {
             console.log(`No changes found in ${baseDir}`);
           }
@@ -187,11 +188,14 @@ export async function oasDiffChangelog(baseApi: string, newApi: string, flags) {
           if (flags.format === "json") {
             // For JSON format, parse the output
             const outputJson = JSON.parse(oasdiffOutput);
-            allResults.push(outputJson);
+            if (outputJson?.length > 0) {
+              allResults.push(outputJson);
+              hasChanges = true;
+            }
           } else {
             allResults.push(oasdiffOutput);
+            hasChanges = true;
           }
-          hasChanges = true;
         } else {
           console.log("No changes found");
         }

src/generate-from-oas/generateCommand.ts

@@ -10,7 +10,6 @@ import { allCommonFlags } from "../common/flags";
 import {
   generateFromOas,
   DEFAULT_CONFIG_PACKAGE_PATH,
-  DEFAULT_CONFIG_PATH,
 } from "./generateFromOas";
 
 export class GenerateCommand extends Command {

src/generate-from-oas/generateFromOas.ts

@@ -7,7 +7,6 @@
 
 import path from "path";
 import { execSync } from "child_process";
-import { string, boolean } from "@oclif/parser/lib/flags";
 
 // Path relative to project root
 export const DEFAULT_CONFIG_BASE_PATH =