kubernetes-fluent-client 1.6.0 → 1.6.1

package/dist/cli.js

@@ -33,7 +33,14 @@ void (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv))
         description: "the language to generate types in, see https://github.com/glideapps/quicktype#target-languages for a list of supported languages",
     })
         .demandOption(["source", "directory"]);
-}, argv => {
-    void (0, generate_1.generate)(argv);
+}, async (argv) => {
+    const opts = argv;
+    opts.logFn = console.log;
+    try {
+        await (0, generate_1.generate)(opts);
+    }
+    catch (e) {
+        console.log(`\n❌ ${e.message}`);
+    }
 })
     .parse();

package/dist/generate.d.ts

@@ -1,4 +1,5 @@
 import { TargetLanguage } from "quicktype-core";
+import { LogFn } from "./types";
 export interface GenerateOptions {
     /** The source URL, yaml file path or K8s CRD name */
     source: string;
@@ -8,6 +9,10 @@ export interface GenerateOptions {
     plain?: boolean;
     /** The language to generate types in */
     language?: string | TargetLanguage;
+    /** Override the NPM package to import when generating formatted Typescript */
+    npmPackage?: string;
+    /** Log function callback */
+    logFn: LogFn;
 }
 /**
  * Generate TypeScript types from a K8s CRD

package/dist/generate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../src/generate.ts"],"names":[],"mappings":"AAMA,OAAO,EAIL,cAAc,EAEf,MAAM,gBAAgB,CAAC;AAMxB,MAAM,WAAW,eAAe;IAC9B,qDAAqD;IACrD,MAAM,EAAE,MAAM,CAAC;IACf,gCAAgC;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gDAAgD;IAChD,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC;CACpC;AAyID;;;;;GAKG;AACH,wBAAsB,QAAQ,CAAC,IAAI,EAAE,eAAe,qCAkBnD"}
+{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../src/generate.ts"],"names":[],"mappings":"AAMA,OAAO,EAIL,cAAc,EAEf,MAAM,gBAAgB,CAAC;AAKxB,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,MAAM,WAAW,eAAe;IAC9B,qDAAqD;IACrD,MAAM,EAAE,MAAM,CAAC;IACf,gCAAgC;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gDAAgD;IAChD,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC;IACnC,8EAA8E;IAC9E,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,4BAA4B;IAC5B,KAAK,EAAE,KAAK,CAAC;CACd;AAiKD;;;;;GAKG;AACH,wBAAsB,QAAQ,CAAC,IAAI,EAAE,eAAe,qCA4BnD"}

package/dist/generate.js

@@ -45,19 +45,25 @@ async function convertCRDtoTS(crd, opts) {
     const name = crd.spec.names.kind;
     const results = {};
     for (const match of crd.spec.versions) {
+        const version = match.name;
         // Get the schema from the matched version
         const schema = JSON.stringify(match?.schema?.openAPIV3Schema);
         // Create a new JSONSchemaInput
         const schemaInput = new quicktype_core_1.JSONSchemaInput(new quicktype_core_1.FetchingJSONSchemaStore());
+        opts.logFn(`- Generating ${crd.spec.group}/${version} types for ${name}`);
         // Add the schema to the input
         await schemaInput.addSource({ name, schema });
         // Create a new InputData object
         const inputData = new quicktype_core_1.InputData();
         inputData.addInput(schemaInput);
+        // If the language is not specified, default to TypeScript
+        if (!opts.language) {
+            opts.language = "ts";
+        }
         // Generate the types
         const out = await (0, quicktype_core_1.quicktype)({
             inputData,
-            lang: opts.language || "ts",
+            lang: opts.language,
             rendererOptions: { "just-types": "true" },
         });
         let processedLines = out.lines;
@@ -67,11 +73,14 @@ async function convertCRDtoTS(crd, opts) {
         }
         // If the language is TypeScript and plain is not specified, wire up the fluent client
         if (opts.language === "ts" && !opts.plain) {
+            if (!opts.npmPackage) {
+                opts.npmPackage = "kubernetes-fluent-client";
+            }
             processedLines.unshift(
             // Add warning that the file is auto-generated
-            `// This file is auto-generated by kubernetes-fluent-client, do not edit manually\n`, 
+            `// This file is auto-generated by ${opts.npmPackage}, do not edit manually\n`, 
             // Add the imports before any other lines
-            `import { GenericKind, RegisterKind } from "kubernetes-fluent-client";\n`);
+            `import { GenericKind, RegisterKind } from "${opts.npmPackage}";\n`);
             // Replace the interface with a named class that extends GenericKind
             const entryIdx = processedLines.findIndex(line => line.includes(`export interface ${name} {`));
             // Replace the interface with a named class that extends GenericKind
@@ -79,12 +88,12 @@ async function convertCRDtoTS(crd, opts) {
             // Add the RegisterKind call
             processedLines.push(`RegisterKind(${name}, {`);
             processedLines.push(`  group: "${crd.spec.group}",`);
-            processedLines.push(`  version: "${match.name}",`);
+            processedLines.push(`  version: "${version}",`);
             processedLines.push(`  kind: "${name}",`);
             processedLines.push(`});`);
         }
         const finalContents = processedLines.join("\n");
-        const fileName = `${name.toLowerCase()}-${match.name.toLowerCase()}`;
+        const fileName = `${name.toLowerCase()}-${version.toLowerCase()}`;
         // If an output file is specified, write the output to the file
         if (opts.directory) {
             // Create the directory if it doesn't exist
@@ -101,14 +110,16 @@ async function convertCRDtoTS(crd, opts) {
 /**
  * Reads a CustomResourceDefinition from a file, the cluster or the internet
  *
- * @param source The source to read from (file path, cluster or URL)
+ * @param opts The options to use when reading
  * @returns A promise that resolves when the CustomResourceDefinition has been read
  */
-async function readOrFetchCrd(source) {
+async function readOrFetchCrd(opts) {
+    const { source, logFn } = opts;
     const filePath = path.join(process.cwd(), source);
     // First try to read the source as a file
     try {
         if (fs.existsSync(filePath)) {
+            logFn(`Attempting to load ${source} as a local file`);
             const payload = fs.readFileSync(filePath, "utf8");
             return (0, client_node_1.loadAllYaml)(payload);
         }
@@ -121,6 +132,7 @@ async function readOrFetchCrd(source) {
         const url = new URL(source);
         // If the source is a URL, fetch it
         if (url.protocol === "http:" || url.protocol === "https:") {
+            logFn(`Attempting to load ${source} as a URL`);
             const { ok, data } = await (0, fetch_1.fetch)(source);
             // If the request failed, throw an error
             if (!ok) {
@@ -130,14 +142,18 @@ async function readOrFetchCrd(source) {
         }
     }
     catch (e) {
-        // Ignore errors
+        // If invalid, ignore the error
+        if (e.code !== "ERR_INVALID_URL") {
+            throw new Error(e);
+        }
     }
     // Finally, if the source is not a file or URL, try to read it as a CustomResourceDefinition from the cluster
     try {
+        logFn(`Attempting to read ${source} from the current Kubernetes context`);
         return [await (0, fluent_1.K8s)(upstream_1.CustomResourceDefinition).Get(source)];
     }
     catch (e) {
-        throw new Error(`Failed to read ${source} as a file, url or K8s CRD: ${e}`);
+        throw new Error(`Failed to read ${source} as a file, url or K8s CRD: ${e.data?.message || "Cluster not available"}`);
     }
 }
 /**
@@ -147,10 +163,12 @@ async function readOrFetchCrd(source) {
  * @returns A promise that resolves when the TypeScript types have been generated
  */
 async function generate(opts) {
-    const crds = await readOrFetchCrd(opts.source);
+    const crds = (await readOrFetchCrd(opts)).filter(crd => !!crd);
     const results = {};
+    opts.logFn("");
     for (const crd of crds) {
-        if (!crd || crd.kind !== "CustomResourceDefinition" || !crd.spec?.versions?.length) {
+        if (crd.kind !== "CustomResourceDefinition" || !crd.spec?.versions?.length) {
+            opts.logFn(`Skipping ${crd?.metadata?.name}, it does not appear to be a CRD`);
             // Ignore empty and non-CRD objects
             continue;
         }
@@ -160,6 +178,10 @@ async function generate(opts) {
             results[key] = out[key];
         }
     }
+    if (opts.directory) {
+        // Notify the user that the files have been generated
+        opts.logFn(`\n✅ Generated ${Object.keys(results).length} files in the ${opts.directory} directory`);
+    }
     return results;
 }
 exports.generate = generate;

package/dist/generate.test.js

@@ -112,25 +112,23 @@ globals_1.jest.mock("./fetch", () => ({
 globals_1.jest.mock("./fluent", () => ({
     K8s: globals_1.jest.fn(),
 }));
-(0, globals_1.describe)("CRD to TypeScript Conversion", () => {
+(0, globals_1.describe)("CRD Generate", () => {
     const originalReadFileSync = fs_1.default.readFileSync;
-    globals_1.jest.isolateModules(() => {
-        globals_1.jest.spyOn(fs_1.default, "existsSync").mockReturnValue(true);
-        globals_1.jest.spyOn(fs_1.default, "readFileSync").mockImplementation((...args) => {
-            // Super janky hack due ot source-map-support calling readFileSync internally
-            if (args[0].toString().includes("test-crd.yaml")) {
-                return sampleYaml;
-            }
-            return originalReadFileSync(...args);
-        });
-        globals_1.jest.spyOn(fs_1.default, "mkdirSync").mockReturnValue(undefined);
-        globals_1.jest.spyOn(fs_1.default, "writeFileSync").mockReturnValue(undefined);
+    globals_1.jest.spyOn(fs_1.default, "existsSync").mockReturnValue(true);
+    globals_1.jest.spyOn(fs_1.default, "readFileSync").mockImplementation((...args) => {
+        // Super janky hack due ot source-map-support calling readFileSync internally
+        if (args[0].toString().includes("test-crd.yaml")) {
+            return sampleYaml;
+        }
+        return originalReadFileSync(...args);
     });
+    const mkdirSyncSpy = globals_1.jest.spyOn(fs_1.default, "mkdirSync").mockReturnValue(undefined);
+    const writeFileSyncSpy = globals_1.jest.spyOn(fs_1.default, "writeFileSync").mockReturnValue(undefined);
     (0, globals_1.beforeEach)(() => {
         globals_1.jest.clearAllMocks();
     });
     (0, globals_1.test)("converts CRD to TypeScript", async () => {
-        const options = { source: "test-crd.yaml", language: "ts" }; // specify your options
+        const options = { source: "test-crd.yaml", language: "ts", logFn: globals_1.jest.fn() };
         const actual = await (0, generate_1.generate)(options);
         const expectedMovie = [
             "// This file is auto-generated by kubernetes-fluent-client, do not edit manually\n",
@@ -182,7 +180,7 @@ globals_1.jest.mock("./fluent", () => ({
         (0, globals_1.expect)(actual["book-v2"]).toEqual(expectedBookV2);
     });
     (0, globals_1.test)("converts CRD to TypeScript with plain option", async () => {
-        const options = { source: "test-crd.yaml", language: "ts", plain: true }; // specify your options
+        const options = { source: "test-crd.yaml", language: "ts", plain: true, logFn: globals_1.jest.fn() };
         const actual = await (0, generate_1.generate)(options);
         const expectedMovie = [
             "/**",
@@ -219,8 +217,121 @@ globals_1.jest.mock("./fluent", () => ({
         (0, globals_1.expect)(actual["book-v1"]).toEqual(expectedBookV1);
         (0, globals_1.expect)(actual["book-v2"]).toEqual(expectedBookV2);
     });
+    (0, globals_1.test)("converts CRD to TypeScript with other options", async () => {
+        const options = {
+            source: "test-crd.yaml",
+            npmPackage: "test-package",
+            logFn: globals_1.jest.fn(),
+        };
+        const actual = await (0, generate_1.generate)(options);
+        const expectedMovie = [
+            "// This file is auto-generated by test-package, do not edit manually\n",
+            'import { GenericKind, RegisterKind } from "test-package";\n',
+            "/**",
+            " * Movie nerd",
+            " */",
+            "export class Movie extends GenericKind {",
+            "    spec?: Spec;",
+            "}",
+            "",
+            "export interface Spec {",
+            "    author?: string;",
+            "    title?:  string;",
+            "}",
+            "",
+            "RegisterKind(Movie, {",
+            '  group: "example.com",',
+            '  version: "v1",',
+            '  kind: "Movie",',
+            "});",
+        ];
+        const expectedBookV1 = [
+            "// This file is auto-generated by test-package, do not edit manually\n",
+            'import { GenericKind, RegisterKind } from "test-package";\n',
+            "/**",
+            " * Book nerd",
+            " */",
+            "export class Book extends GenericKind {",
+            "    spec?: Spec;",
+            "}",
+            "",
+            "export interface Spec {",
+            "    author?: string;",
+            "    title?:  string;",
+            "}",
+            "",
+            "RegisterKind(Book, {",
+            '  group: "example.com",',
+            '  version: "v1",',
+            '  kind: "Book",',
+            "});",
+        ];
+        const expectedBookV2 = expectedBookV1
+            .filter(line => !line.includes("title?"))
+            .map(line => line.replace("v1", "v2"));
+        (0, globals_1.expect)(actual["movie-v1"]).toEqual(expectedMovie);
+        (0, globals_1.expect)(actual["book-v1"]).toEqual(expectedBookV1);
+        (0, globals_1.expect)(actual["book-v2"]).toEqual(expectedBookV2);
+    });
+    (0, globals_1.test)("converts CRD to TypeScript and writes to the given directory", async () => {
+        const options = {
+            source: "test-crd.yaml",
+            directory: "test",
+            logFn: globals_1.jest.fn(),
+        };
+        await (0, generate_1.generate)(options);
+        const expectedMovie = [
+            "// This file is auto-generated by kubernetes-fluent-client, do not edit manually\n",
+            'import { GenericKind, RegisterKind } from "kubernetes-fluent-client";\n',
+            "/**",
+            " * Movie nerd",
+            " */",
+            "export class Movie extends GenericKind {",
+            "    spec?: Spec;",
+            "}",
+            "",
+            "export interface Spec {",
+            "    author?: string;",
+            "    title?:  string;",
+            "}",
+            "",
+            "RegisterKind(Movie, {",
+            '  group: "example.com",',
+            '  version: "v1",',
+            '  kind: "Movie",',
+            "});",
+        ];
+        const expectedBookV1 = [
+            "// This file is auto-generated by kubernetes-fluent-client, do not edit manually\n",
+            'import { GenericKind, RegisterKind } from "kubernetes-fluent-client";\n',
+            "/**",
+            " * Book nerd",
+            " */",
+            "export class Book extends GenericKind {",
+            "    spec?: Spec;",
+            "}",
+            "",
+            "export interface Spec {",
+            "    author?: string;",
+            "    title?:  string;",
+            "}",
+            "",
+            "RegisterKind(Book, {",
+            '  group: "example.com",',
+            '  version: "v1",',
+            '  kind: "Book",',
+            "});",
+        ];
+        const expectedBookV2 = expectedBookV1
+            .filter(line => !line.includes("title?"))
+            .map(line => line.replace("v1", "v2"));
+        (0, globals_1.expect)(mkdirSyncSpy).toHaveBeenCalledWith("test", { recursive: true });
+        (0, globals_1.expect)(writeFileSyncSpy).toHaveBeenCalledWith("test/movie-v1.ts", expectedMovie.join("\n"));
+        (0, globals_1.expect)(writeFileSyncSpy).toHaveBeenCalledWith("test/book-v1.ts", expectedBookV1.join("\n"));
+        (0, globals_1.expect)(writeFileSyncSpy).toHaveBeenCalledWith("test/book-v2.ts", expectedBookV2.join("\n"));
+    });
     (0, globals_1.test)("converts CRD to Go", async () => {
-        const options = { source: "test-crd.yaml", language: "go" }; // specify your options
+        const options = { source: "test-crd.yaml", language: "go", logFn: globals_1.jest.fn() };
         const actual = await (0, generate_1.generate)(options);
         const expectedMovie = [
             "// Movie nerd",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kubernetes-fluent-client",
-  "version": "1.6.0",
+  "version": "1.6.1",
   "description": "A @kubernetes/client-node fluent API wrapper that leverages K8s Server Side Apply",
   "bin": "./dist/cli.js",
   "main": "dist/index.js",

package/src/cli.ts

@@ -37,8 +37,15 @@ void yargs(hideBin(process.argv))
         })
         .demandOption(["source", "directory"]);
     },
-    argv => {
-      void generate(argv as GenerateOptions);
+    async argv => {
+      const opts = argv as unknown as GenerateOptions;
+      opts.logFn = console.log;
+
+      try {
+        await generate(opts);
+      } catch (e) {
+        console.log(`\n❌ ${e.message}`);
+      }
     },
   )
   .parse();

package/src/generate.test.ts

@@ -111,28 +111,26 @@ jest.mock("./fluent", () => ({
   K8s: jest.fn(),
 }));
 
-describe("CRD to TypeScript Conversion", () => {
+describe("CRD Generate", () => {
   const originalReadFileSync = fs.readFileSync;
 
-  jest.isolateModules(() => {
-    jest.spyOn(fs, "existsSync").mockReturnValue(true);
-    jest.spyOn(fs, "readFileSync").mockImplementation((...args) => {
-      // Super janky hack due ot source-map-support calling readFileSync internally
-      if (args[0].toString().includes("test-crd.yaml")) {
-        return sampleYaml;
-      }
-      return originalReadFileSync(...args);
-    });
-    jest.spyOn(fs, "mkdirSync").mockReturnValue(undefined);
-    jest.spyOn(fs, "writeFileSync").mockReturnValue(undefined);
+  jest.spyOn(fs, "existsSync").mockReturnValue(true);
+  jest.spyOn(fs, "readFileSync").mockImplementation((...args) => {
+    // Super janky hack due ot source-map-support calling readFileSync internally
+    if (args[0].toString().includes("test-crd.yaml")) {
+      return sampleYaml;
+    }
+    return originalReadFileSync(...args);
   });
+  const mkdirSyncSpy = jest.spyOn(fs, "mkdirSync").mockReturnValue(undefined);
+  const writeFileSyncSpy = jest.spyOn(fs, "writeFileSync").mockReturnValue(undefined);
 
   beforeEach(() => {
     jest.clearAllMocks();
   });
 
   test("converts CRD to TypeScript", async () => {
-    const options = { source: "test-crd.yaml", language: "ts" }; // specify your options
+    const options = { source: "test-crd.yaml", language: "ts", logFn: jest.fn() };
 
     const actual = await generate(options);
     const expectedMovie = [
@@ -187,7 +185,7 @@ describe("CRD to TypeScript Conversion", () => {
   });
 
   test("converts CRD to TypeScript with plain option", async () => {
-    const options = { source: "test-crd.yaml", language: "ts", plain: true }; // specify your options
+    const options = { source: "test-crd.yaml", language: "ts", plain: true, logFn: jest.fn() };
 
     const actual = await generate(options);
     const expectedMovie = [
@@ -227,8 +225,127 @@ describe("CRD to TypeScript Conversion", () => {
     expect(actual["book-v2"]).toEqual(expectedBookV2);
   });
 
+  test("converts CRD to TypeScript with other options", async () => {
+    const options = {
+      source: "test-crd.yaml",
+      npmPackage: "test-package",
+      logFn: jest.fn(),
+    };
+
+    const actual = await generate(options);
+    const expectedMovie = [
+      "// This file is auto-generated by test-package, do not edit manually\n",
+      'import { GenericKind, RegisterKind } from "test-package";\n',
+      "/**",
+      " * Movie nerd",
+      " */",
+      "export class Movie extends GenericKind {",
+      "    spec?: Spec;",
+      "}",
+      "",
+      "export interface Spec {",
+      "    author?: string;",
+      "    title?:  string;",
+      "}",
+      "",
+      "RegisterKind(Movie, {",
+      '  group: "example.com",',
+      '  version: "v1",',
+      '  kind: "Movie",',
+      "});",
+    ];
+    const expectedBookV1 = [
+      "// This file is auto-generated by test-package, do not edit manually\n",
+      'import { GenericKind, RegisterKind } from "test-package";\n',
+      "/**",
+      " * Book nerd",
+      " */",
+      "export class Book extends GenericKind {",
+      "    spec?: Spec;",
+      "}",
+      "",
+      "export interface Spec {",
+      "    author?: string;",
+      "    title?:  string;",
+      "}",
+      "",
+      "RegisterKind(Book, {",
+      '  group: "example.com",',
+      '  version: "v1",',
+      '  kind: "Book",',
+      "});",
+    ];
+    const expectedBookV2 = expectedBookV1
+      .filter(line => !line.includes("title?"))
+      .map(line => line.replace("v1", "v2"));
+
+    expect(actual["movie-v1"]).toEqual(expectedMovie);
+    expect(actual["book-v1"]).toEqual(expectedBookV1);
+    expect(actual["book-v2"]).toEqual(expectedBookV2);
+  });
+
+  test("converts CRD to TypeScript and writes to the given directory", async () => {
+    const options = {
+      source: "test-crd.yaml",
+      directory: "test",
+      logFn: jest.fn(),
+    };
+
+    await generate(options);
+    const expectedMovie = [
+      "// This file is auto-generated by kubernetes-fluent-client, do not edit manually\n",
+      'import { GenericKind, RegisterKind } from "kubernetes-fluent-client";\n',
+      "/**",
+      " * Movie nerd",
+      " */",
+      "export class Movie extends GenericKind {",
+      "    spec?: Spec;",
+      "}",
+      "",
+      "export interface Spec {",
+      "    author?: string;",
+      "    title?:  string;",
+      "}",
+      "",
+      "RegisterKind(Movie, {",
+      '  group: "example.com",',
+      '  version: "v1",',
+      '  kind: "Movie",',
+      "});",
+    ];
+    const expectedBookV1 = [
+      "// This file is auto-generated by kubernetes-fluent-client, do not edit manually\n",
+      'import { GenericKind, RegisterKind } from "kubernetes-fluent-client";\n',
+      "/**",
+      " * Book nerd",
+      " */",
+      "export class Book extends GenericKind {",
+      "    spec?: Spec;",
+      "}",
+      "",
+      "export interface Spec {",
+      "    author?: string;",
+      "    title?:  string;",
+      "}",
+      "",
+      "RegisterKind(Book, {",
+      '  group: "example.com",',
+      '  version: "v1",',
+      '  kind: "Book",',
+      "});",
+    ];
+    const expectedBookV2 = expectedBookV1
+      .filter(line => !line.includes("title?"))
+      .map(line => line.replace("v1", "v2"));
+
+    expect(mkdirSyncSpy).toHaveBeenCalledWith("test", { recursive: true });
+    expect(writeFileSyncSpy).toHaveBeenCalledWith("test/movie-v1.ts", expectedMovie.join("\n"));
+    expect(writeFileSyncSpy).toHaveBeenCalledWith("test/book-v1.ts", expectedBookV1.join("\n"));
+    expect(writeFileSyncSpy).toHaveBeenCalledWith("test/book-v2.ts", expectedBookV2.join("\n"));
+  });
+
   test("converts CRD to Go", async () => {
-    const options = { source: "test-crd.yaml", language: "go" }; // specify your options
+    const options = { source: "test-crd.yaml", language: "go", logFn: jest.fn() };
 
     const actual = await generate(options);
     const expectedMovie = [

package/src/generate.ts

@@ -15,6 +15,7 @@ import {
 import { fetch } from "./fetch";
 import { K8s } from "./fluent";
 import { CustomResourceDefinition } from "./upstream";
+import { LogFn } from "./types";
 
 export interface GenerateOptions {
   /** The source URL, yaml file path or K8s CRD name */
@@ -25,6 +26,10 @@ export interface GenerateOptions {
   plain?: boolean;
   /** The language to generate types in */
   language?: string | TargetLanguage;
+  /** Override the NPM package to import when generating formatted Typescript */
+  npmPackage?: string;
+  /** Log function callback */
+  logFn: LogFn;
 }
 
 /**
@@ -44,12 +49,16 @@ async function convertCRDtoTS(
   const results: Record<string, string[]> = {};
 
   for (const match of crd.spec.versions) {
+    const version = match.name;
+
     // Get the schema from the matched version
     const schema = JSON.stringify(match?.schema?.openAPIV3Schema);
 
     // Create a new JSONSchemaInput
     const schemaInput = new JSONSchemaInput(new FetchingJSONSchemaStore());
 
+    opts.logFn(`- Generating ${crd.spec.group}/${version} types for ${name}`);
+
     // Add the schema to the input
     await schemaInput.addSource({ name, schema });
 
@@ -57,10 +66,15 @@ async function convertCRDtoTS(
     const inputData = new InputData();
     inputData.addInput(schemaInput);
 
+    // If the language is not specified, default to TypeScript
+    if (!opts.language) {
+      opts.language = "ts";
+    }
+
     // Generate the types
     const out = await quicktype({
       inputData,
-      lang: opts.language || "ts",
+      lang: opts.language,
       rendererOptions: { "just-types": "true" },
     });
 
@@ -73,11 +87,15 @@ async function convertCRDtoTS(
 
     // If the language is TypeScript and plain is not specified, wire up the fluent client
     if (opts.language === "ts" && !opts.plain) {
+      if (!opts.npmPackage) {
+        opts.npmPackage = "kubernetes-fluent-client";
+      }
+
       processedLines.unshift(
         // Add warning that the file is auto-generated
-        `// This file is auto-generated by kubernetes-fluent-client, do not edit manually\n`,
+        `// This file is auto-generated by ${opts.npmPackage}, do not edit manually\n`,
         // Add the imports before any other lines
-        `import { GenericKind, RegisterKind } from "kubernetes-fluent-client";\n`,
+        `import { GenericKind, RegisterKind } from "${opts.npmPackage}";\n`,
       );
 
       // Replace the interface with a named class that extends GenericKind
@@ -91,13 +109,13 @@ async function convertCRDtoTS(
       // Add the RegisterKind call
       processedLines.push(`RegisterKind(${name}, {`);
       processedLines.push(`  group: "${crd.spec.group}",`);
-      processedLines.push(`  version: "${match.name}",`);
+      processedLines.push(`  version: "${version}",`);
       processedLines.push(`  kind: "${name}",`);
       processedLines.push(`});`);
     }
 
     const finalContents = processedLines.join("\n");
-    const fileName = `${name.toLowerCase()}-${match.name.toLowerCase()}`;
+    const fileName = `${name.toLowerCase()}-${version.toLowerCase()}`;
 
     // If an output file is specified, write the output to the file
     if (opts.directory) {
@@ -119,15 +137,17 @@ async function convertCRDtoTS(
 /**
  * Reads a CustomResourceDefinition from a file, the cluster or the internet
  *
- * @param source The source to read from (file path, cluster or URL)
+ * @param opts The options to use when reading
  * @returns A promise that resolves when the CustomResourceDefinition has been read
  */
-async function readOrFetchCrd(source: string): Promise<CustomResourceDefinition[]> {
+async function readOrFetchCrd(opts: GenerateOptions): Promise<CustomResourceDefinition[]> {
+  const { source, logFn } = opts;
   const filePath = path.join(process.cwd(), source);
 
   // First try to read the source as a file
   try {
     if (fs.existsSync(filePath)) {
+      logFn(`Attempting to load ${source} as a local file`);
       const payload = fs.readFileSync(filePath, "utf8");
       return loadAllYaml(payload) as CustomResourceDefinition[];
     }
@@ -141,6 +161,7 @@ async function readOrFetchCrd(source: string): Promise<CustomResourceDefinition[
 
     // If the source is a URL, fetch it
     if (url.protocol === "http:" || url.protocol === "https:") {
+      logFn(`Attempting to load ${source} as a URL`);
       const { ok, data } = await fetch<string>(source);
 
       // If the request failed, throw an error
@@ -151,14 +172,22 @@ async function readOrFetchCrd(source: string): Promise<CustomResourceDefinition[
       return loadAllYaml(data) as CustomResourceDefinition[];
     }
   } catch (e) {
-    // Ignore errors
+    // If invalid, ignore the error
+    if (e.code !== "ERR_INVALID_URL") {
+      throw new Error(e);
+    }
   }
 
   // Finally, if the source is not a file or URL, try to read it as a CustomResourceDefinition from the cluster
   try {
+    logFn(`Attempting to read ${source} from the current Kubernetes context`);
     return [await K8s(CustomResourceDefinition).Get(source)];
   } catch (e) {
-    throw new Error(`Failed to read ${source} as a file, url or K8s CRD: ${e}`);
+    throw new Error(
+      `Failed to read ${source} as a file, url or K8s CRD: ${
+        e.data?.message || "Cluster not available"
+      }`,
+    );
   }
 }
 
@@ -169,11 +198,14 @@ async function readOrFetchCrd(source: string): Promise<CustomResourceDefinition[
  * @returns A promise that resolves when the TypeScript types have been generated
  */
 export async function generate(opts: GenerateOptions) {
-  const crds = await readOrFetchCrd(opts.source);
+  const crds = (await readOrFetchCrd(opts)).filter(crd => !!crd);
   const results: Record<string, string[]> = {};
 
+  opts.logFn("");
+
   for (const crd of crds) {
-    if (!crd || crd.kind !== "CustomResourceDefinition" || !crd.spec?.versions?.length) {
+    if (crd.kind !== "CustomResourceDefinition" || !crd.spec?.versions?.length) {
+      opts.logFn(`Skipping ${crd?.metadata?.name}, it does not appear to be a CRD`);
       // Ignore empty and non-CRD objects
       continue;
     }
@@ -185,5 +217,12 @@ export async function generate(opts: GenerateOptions) {
     }
   }
 
+  if (opts.directory) {
+    // Notify the user that the files have been generated
+    opts.logFn(
+      `\n✅ Generated ${Object.keys(results).length} files in the ${opts.directory} directory`,
+    );
+  }
+
   return results;
 }