feat: add crd import command to register new types via local, remote or cluster CRD (#24)

Author: jeff-mccoy

package-lock.json

@@ -2,6 +2,7 @@
   "name": "kubernetes-fluent-client",
   "version": "0.0.0-development",
   "description": "A @kubernetes/client-node fluent API wrapper that leverages K8s Server Side Apply",
+  "bin": "./dist/cli.js",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
@@ -39,13 +40,17 @@
     "fast-json-patch": "3.1.1",
     "http-status-codes": "2.3.0",
     "node-fetch": "2.7.0",
-    "type-fest": "4.4.0"
+    "quicktype-core": "23.0.76",
+    "type-fest": "4.4.0",
+    "yargs": "17.7.2"
   },
   "devDependencies": {
     "@commitlint/cli": "17.7.2",
     "@commitlint/config-conventional": "17.7.0",
     "@jest/globals": "29.7.0",
     "@types/byline": "4.2.34",
+    "@types/readable-stream": "4.0.3",
+    "@types/yargs": "17.0.28",
     "@typescript-eslint/eslint-plugin": "6.7.5",
     "@typescript-eslint/parser": "6.7.5",
     "eslint-plugin-jsdoc": "46.8.2",

package.json

@@ -0,0 +1,44 @@
+#!/usr/bin/env node
+
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
+
+import { hideBin } from "yargs/helpers";
+import yargs from "yargs/yargs";
+import { GenerateOptions, generate } from "./generate";
+
+void yargs(hideBin(process.argv))
+  .version(false)
+  .command(
+    "crd [source] [directory]",
+    "generate usable types from a K8s CRD",
+    yargs => {
+      return yargs
+        .positional("source", {
+          describe: "the yaml file path, remote url, or K8s CRD name",
+          type: "string",
+        })
+        .positional("directory", {
+          describe: "the directory to output the generated types to",
+          type: "string",
+        })
+        .option("plain", {
+          alias: "p",
+          type: "boolean",
+          description:
+            "generate plain types without binding to the fluent client, automatically enabled when an alternate language is specified",
+        })
+        .option("language", {
+          alias: "l",
+          type: "string",
+          default: "ts",
+          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 generate(argv as GenerateOptions);
+    },
+  )
+  .parse();

src/cli.ts

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 
 import { expect, test, beforeEach } from "@jest/globals";
 

src/fetch.test.ts

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 
 import { StatusCodes } from "http-status-codes";
 import fetchRaw, { FetchError, RequestInfo, RequestInit } from "node-fetch";

src/fetch.ts

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 
 /**
  * Configuration for the apply function.

src/fluent/apply.ts

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 
 import { KubernetesListObject, KubernetesObject } from "@kubernetes/client-node";
 import { Operation } from "fast-json-patch";

src/fluent/index.ts

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 
 import { KubernetesListObject, KubernetesObject } from "@kubernetes/client-node";
 import { Operation } from "fast-json-patch";

src/fluent/types.ts

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 
 import { beforeEach, describe, expect, it, jest } from "@jest/globals";
 

src/fluent/utils.test.ts

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 
 import { KubeConfig, PatchStrategy } from "@kubernetes/client-node";