@shepherdjerred/helm-types 1.1.0 → 1.2.0-dev.891

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shepherdjerred/helm-types",
-  "version": "1.1.0",
+  "version": "1.2.0-dev.891",
   "description": "Generate TypeScript types from Helm chart values.yaml and values.schema.json",
   "type": "module",
   "main": "dist/index.js",
@@ -59,5 +59,9 @@
   "dependencies": {
     "yaml": "^2.8.1",
     "zod": "^4.1.11"
+  },
+  "devDependencies": {
+    "@types/bun": "^1.3.11",
+    "jiti": "^2.6.1"
   }
 }

package/src/chart-fetcher.ts

@@ -1,14 +1,16 @@
 // Using Bun.$ for path operations instead of node:path
 import { parse as yamlParse } from "yaml";
-import type { ChartInfo, JSONSchemaProperty } from "./types.js";
-import { HelmValueSchema, RecordSchema, ErrorSchema } from "./schemas.js";
-import type { HelmValue } from "./schemas.js";
-import { parseYAMLComments } from "./yaml-comments.js";
+import type { ChartInfo, JSONSchemaProperty } from "./types.ts";
+import { HelmValueSchema, RecordSchema, ErrorSchema } from "./schemas.ts";
+import type { HelmValue } from "./schemas.ts";
+import { parseYAMLComments } from "./yaml-comments.ts";
 
 /**
  * Load JSON schema if it exists in the chart
  */
-async function loadJSONSchema(chartPath: string): Promise<JSONSchemaProperty | null> {
+async function loadJSONSchema(
+  chartPath: string,
+): Promise<JSONSchemaProperty | null> {
   try {
     const schemaPath = `${chartPath}/values.schema.json`;
     const schemaContent = await Bun.file(schemaPath).text();
@@ -44,21 +46,29 @@ async function runCommand(command: string, args: string[]): Promise<string> {
     if (exitCode === 0) {
       return output;
     } else {
-      throw new Error(`Command "${command} ${args.join(" ")}" failed with code ${exitCode.toString()}`);
+      throw new Error(
+        `Command "${command} ${args.join(" ")}" failed with code ${exitCode.toString()}`,
+      );
     }
   } catch (error) {
     const parseResult = ErrorSchema.safeParse(error);
-    const errorMessage = parseResult.success ? parseResult.data.message : String(error);
-    throw new Error(`Failed to spawn command "${command} ${args.join(" ")}": ${errorMessage}`);
+    const errorMessage = parseResult.success
+      ? parseResult.data.message
+      : String(error);
+    throw new Error(
+      `Failed to spawn command "${command} ${args.join(" ")}": ${errorMessage}`,
+    );
   }
 }
 
 /**
  * Fetch a Helm chart and extract its values.yaml and optional schema
  */
-export async function fetchHelmChart(
-  chart: ChartInfo,
-): Promise<{ values: HelmValue; schema: JSONSchemaProperty | null; yamlComments: Map<string, string> }> {
+export async function fetchHelmChart(chart: ChartInfo): Promise<{
+  values: HelmValue;
+  schema: JSONSchemaProperty | null;
+  yamlComments: Map<string, string>;
+}> {
   const pwd = Bun.env["PWD"] ?? process.cwd();
   const tempDir = `${pwd}/temp/helm-${chart.name}`;
   const repoName = `temp-repo-${chart.name}-${String(Date.now())}`;
@@ -96,7 +106,9 @@ export async function fetchHelmChart(
 
       // Parse YAML comments
       const yamlComments = parseYAMLComments(valuesContent);
-      console.log(`  💬 Extracted ${String(yamlComments.size)} comments from values.yaml`);
+      console.log(
+        `  💬 Extracted ${String(yamlComments.size)} comments from values.yaml`,
+      );
 
       // Parse YAML using yaml package
       const parsedValues = yamlParse(valuesContent) as unknown;
@@ -106,13 +118,17 @@ export async function fetchHelmChart(
         console.log(
           `  🔍 Parsed values keys: ${Object.keys(recordParseResult.data)
             .slice(0, 10)
-            .join(", ")}${Object.keys(recordParseResult.data).length > 10 ? "..." : ""}`,
+            .join(
+              ", ",
+            )}${Object.keys(recordParseResult.data).length > 10 ? "..." : ""}`,
         );
       }
 
       // Check if parsedValues is a valid object using Zod before validation
       if (!recordParseResult.success) {
-        console.warn(`  ⚠️  Parsed values is not a valid record object: ${String(parsedValues)}`);
+        console.warn(
+          `  ⚠️  Parsed values is not a valid record object: ${String(parsedValues)}`,
+        );
         return { values: {}, schema: null, yamlComments: new Map() };
       }
 
@@ -128,8 +144,13 @@ export async function fetchHelmChart(
         return { values: parseResult.data, schema, yamlComments };
       } else {
         console.warn(`  ⚠️  Zod validation failed for ${chart.name}:`);
-        console.warn(`    First few errors:`, parseResult.error.issues.slice(0, 3));
-        console.warn(`  ⚠️  Falling back to unvalidated object for type generation`);
+        console.warn(
+          `    First few errors:`,
+          parseResult.error.issues.slice(0, 3),
+        );
+        console.warn(
+          `  ⚠️  Falling back to unvalidated object for type generation`,
+        );
         // Return the validated record data from the successful parse result
         return { values: recordParseResult.data, schema, yamlComments };
       }

package/src/chart-info-parser.ts

@@ -1,9 +1,11 @@
-import type { ChartInfo } from "./types.js";
+import type { ChartInfo } from "./types.ts";
 
 /**
  * Parse chart information from versions.ts comments and values
  */
-export async function parseChartInfoFromVersions(versionsPath = "src/versions.ts"): Promise<ChartInfo[]> {
+export async function parseChartInfoFromVersions(
+  versionsPath = "src/versions.ts",
+): Promise<ChartInfo[]> {
   const content = await Bun.file(versionsPath).text();
   const lines = content.split("\n");
   const charts: ChartInfo[] = [];
@@ -13,39 +15,57 @@ export async function parseChartInfoFromVersions(versionsPath = "src/versions.ts
     const nextLine = lines[i + 1];
 
     // Look for renovate comments that indicate Helm charts
-    if (line?.includes("renovate: datasource=helm") && nextLine) {
-      const repoUrlMatch = /registryUrl=([^\s]+)/.exec(line);
-      const versionKeyMatch = /^\s*"?([^":]+)"?:/.exec(nextLine);
-
-      if (repoUrlMatch && versionKeyMatch) {
-        const repoUrl = repoUrlMatch[1];
-        const versionKey = versionKeyMatch[1];
-
-        if (!repoUrl || !versionKey) continue;
-
-        // Extract version value
-        const versionMatch = /:\s*"([^"]+)"/.exec(nextLine);
-        if (versionMatch) {
-          const version = versionMatch[1];
-          if (!version) continue;
-
-          // Try to determine chart name from the version key or URL
-          let chartName = versionKey;
-
-          // Handle special cases like "argo-cd" vs "argocd"
-          if (versionKey === "argo-cd") {
-            chartName = "argo-cd";
-          }
-
-          charts.push({
-            name: versionKey,
-            repoUrl: repoUrl.replace(/\/$/, ""), // Remove trailing slash
-            version,
-            chartName,
-          });
-        }
-      }
+    if (
+      line == null ||
+      !line.includes("renovate: datasource=helm") ||
+      nextLine == null ||
+      nextLine === ""
+    ) {
+      continue;
     }
+
+    const repoUrlMatch = /registryUrl=(\S+)/.exec(line);
+    const versionKeyMatch = /^\s*"?([^":\s]+)"?:/.exec(nextLine);
+    if (!repoUrlMatch || !versionKeyMatch) {
+      continue;
+    }
+
+    const repoUrl = repoUrlMatch[1];
+    const versionKey = versionKeyMatch[1];
+    if (
+      repoUrl == null ||
+      repoUrl === "" ||
+      versionKey == null ||
+      versionKey === ""
+    ) {
+      continue;
+    }
+
+    // Extract version value
+    const versionMatch = /:\s*"([^"]+)"/.exec(nextLine);
+    if (!versionMatch) {
+      continue;
+    }
+
+    const version = versionMatch[1];
+    if (version == null || version === "") {
+      continue;
+    }
+
+    // Try to determine chart name from the version key or URL
+    let chartName = versionKey;
+
+    // Handle special cases like "argo-cd" vs "argocd"
+    if (versionKey === "argo-cd") {
+      chartName = "argo-cd";
+    }
+
+    charts.push({
+      name: versionKey,
+      repoUrl: repoUrl.replace(/\/$/, ""), // Remove trailing slash
+      version,
+      chartName,
+    });
   }
 
   return charts;

package/src/cli.ts

@@ -5,14 +5,16 @@
  * Generate TypeScript types from Helm charts
  */
 import { z } from "zod";
-import { fetchHelmChart, convertToTypeScriptInterface, generateTypeScriptCode } from "./helm-types.ts";
-import type { ChartInfo } from "./helm-types.ts";
+import { fetchHelmChart } from "./chart-fetcher.ts";
+import { convertToTypeScriptInterface } from "./type-converter.ts";
+import { generateTypeScriptCode } from "./interface-generator.ts";
+import type { ChartInfo } from "./types.ts";
 
 const ErrorSchema = z.object({
   message: z.string(),
 });
 
-const HELP_TEXT = `
+const HELP_TEXT = String.raw`
 helm-types - Generate TypeScript types from Helm charts
 
 USAGE:
@@ -29,25 +31,25 @@ OPTIONS:
 
 EXAMPLES:
   # Generate types for ArgoCD and print to stdout
-  bunx @homelab/helm-types \\
-    --name argo-cd \\
-    --repo https://argoproj.github.io/argo-helm \\
+  bunx @homelab/helm-types \
+    --name argo-cd \
+    --repo https://argoproj.github.io/argo-helm \
     --version 8.3.1
 
   # Generate types with custom output file
-  bunx @homelab/helm-types \\
-    --name argo-cd \\
-    --repo https://argoproj.github.io/argo-helm \\
-    --version 8.3.1 \\
+  bunx @homelab/helm-types \
+    --name argo-cd \
+    --repo https://argoproj.github.io/argo-helm \
+    --version 8.3.1 \
     --output argo-cd.types.ts
 
   # Generate types with custom chart name and interface name
-  bunx @homelab/helm-types \\
-    --name argocd \\
-    --chart argo-cd \\
-    --repo https://argoproj.github.io/argo-helm \\
-    --version 8.3.1 \\
-    --interface ArgocdHelmValues \\
+  bunx @homelab/helm-types \
+    --name argocd \
+    --chart argo-cd \
+    --repo https://argoproj.github.io/argo-helm \
+    --version 8.3.1 \
+    --interface ArgocdHelmValues \
     --output argocd.types.ts
 `;
 
@@ -61,6 +63,27 @@ type CliArgs = {
   help?: boolean;
 };
 
+/** String-valued flag names (excludes boolean 'help') */
+type StringCliArgsKey = Exclude<keyof CliArgs, "help">;
+
+/** Map from flag name to CliArgs key */
+const FLAG_MAP: Record<string, StringCliArgsKey> = {
+  "--name": "name",
+  "-n": "name",
+  "--chart": "chart",
+  "-c": "chart",
+  "--repo": "repo",
+  "-r": "repo",
+  "--version": "version",
+  "-v": "version",
+  "--output": "output",
+  "-o": "output",
+  "--interface": "interface",
+  "-i": "interface",
+};
+
+const HELP_FLAGS = new Set(["--help", "-h"]);
+
 /**
  * Simple argument parser for Bun CLI
  */
@@ -69,47 +92,26 @@ function parseCliArgs(args: string[]): CliArgs {
 
   for (let i = 0; i < args.length; i++) {
     const arg = args[i];
-    if (!arg) continue;
+    if (arg == null || arg === "") {
+      continue;
+    }
 
-    if (arg === "--help" || arg === "-h") {
+    if (HELP_FLAGS.has(arg)) {
       result.help = true;
-    } else if (arg === "--name" || arg === "-n") {
-      const value = args[i + 1];
-      if (value) {
-        result.name = value;
-        i += 1;
-      }
-    } else if (arg === "--chart" || arg === "-c") {
-      const value = args[i + 1];
-      if (value) {
-        result.chart = value;
-        i += 1;
-      }
-    } else if (arg === "--repo" || arg === "-r") {
-      const value = args[i + 1];
-      if (value) {
-        result.repo = value;
-        i += 1;
-      }
-    } else if (arg === "--version" || arg === "-v") {
-      const value = args[i + 1];
-      if (value) {
-        result.version = value;
-        i += 1;
-      }
-    } else if (arg === "--output" || arg === "-o") {
-      const value = args[i + 1];
-      if (value) {
-        result.output = value;
-        i += 1;
-      }
-    } else if (arg === "--interface" || arg === "-i") {
+      continue;
+    }
+
+    const key = FLAG_MAP[arg];
+    if (key != null) {
       const value = args[i + 1];
-      if (value) {
-        result.interface = value;
+      if (value != null && value !== "") {
+        result[key] = value;
         i += 1;
       }
-    } else if (arg.startsWith("-")) {
+      continue;
+    }
+
+    if (arg.startsWith("-")) {
       throw new Error(`Unknown argument: ${arg}`);
     }
   }
@@ -122,13 +124,20 @@ async function main() {
     const args = parseCliArgs(Bun.argv.slice(2));
 
     // Show help
-    if (args.help) {
+    if (args.help === true) {
       console.log(HELP_TEXT);
       process.exit(0);
     }
 
     // Validate required arguments
-    if (!args.name || !args.repo || !args.version) {
+    if (
+      args.name == null ||
+      args.name === "" ||
+      args.repo == null ||
+      args.repo === "" ||
+      args.version == null ||
+      args.version === ""
+    ) {
       console.error("Error: Missing required arguments");
       console.error("Required: --name, --repo, --version");
       console.error("\nRun with --help for usage information");
@@ -144,9 +153,12 @@ async function main() {
     };
 
     // Generate interface name from chart name if not provided
-    const interfaceName = args.interface ?? `${toPascalCase(args.name)}HelmValues`;
+    const interfaceName =
+      args.interface ?? `${toPascalCase(args.name)}HelmValues`;
 
-    console.error(`Fetching chart: ${chartInfo.chartName}@${chartInfo.version}`);
+    console.error(
+      `Fetching chart: ${chartInfo.chartName}@${chartInfo.version}`,
+    );
     console.error(`Repository: ${chartInfo.repoUrl}`);
     console.error("");
 
@@ -157,13 +169,19 @@ async function main() {
     console.error(`Converting to TypeScript interface: ${interfaceName}`);
 
     // Convert to TypeScript interface
-    const tsInterface = convertToTypeScriptInterface(values, interfaceName, schema, yamlComments, "", args.name);
+    const tsInterface = convertToTypeScriptInterface({
+      values,
+      interfaceName,
+      schema,
+      yamlComments,
+      chartName: args.name,
+    });
 
     // Generate TypeScript code
     const code = generateTypeScriptCode(tsInterface, args.name);
 
     // Write to file or stdout
-    if (args.output) {
+    if (args.output != null && args.output !== "") {
       await Bun.write(args.output, code);
       console.error("");
       console.error(`✅ Types written to: ${args.output}`);

package/src/code-generator.ts

@@ -1,11 +1,20 @@
-import type { TypeScriptInterface } from "./types.js";
-import { StringSchema, ArraySchema, RecordSchema, ActualNumberSchema, ActualBooleanSchema } from "./schemas.js";
-import { capitalizeFirst } from "./utils.js";
+import type { TypeScriptInterface } from "./types.ts";
+import {
+  StringSchema,
+  ArraySchema,
+  RecordSchema,
+  ActualNumberSchema,
+  ActualBooleanSchema,
+} from "./schemas.ts";
+import { capitalizeFirst } from "./utils.ts";
 
 /**
  * Generate TypeScript code from interface definition
  */
-export function generateTypeScriptCode(mainInterface: TypeScriptInterface, chartName: string): string {
+export function generateTypeScriptCode(
+  mainInterface: TypeScriptInterface,
+  chartName: string,
+): string {
   const interfaces: TypeScriptInterface[] = [];
 
   // Collect all nested interfaces
@@ -22,18 +31,20 @@ export function generateTypeScriptCode(mainInterface: TypeScriptInterface, chart
   // Generate parameter type (flattened dot notation)
   code += generateParameterType(mainInterface, chartName);
 
-  // Check if any 'any' types were generated and add ESLint disable if needed
+  // Add header comment for generated files
   if (code.includes(": any")) {
     code = `// Generated TypeScript types for ${chartName} Helm chart
-/* eslint-disable @typescript-eslint/no-explicit-any */
 
-${code.substring(code.indexOf("\n\n") + 2)}`;
+${code.slice(Math.max(0, code.indexOf("\n\n") + 2))}`;
   }
 
   return code;
 }
 
-function collectNestedInterfaces(iface: TypeScriptInterface, collected: TypeScriptInterface[]): void {
+function collectNestedInterfaces(
+  iface: TypeScriptInterface,
+  collected: TypeScriptInterface[],
+): void {
   for (const prop of Object.values(iface.properties)) {
     if (prop.nested) {
       collected.push(prop.nested);
@@ -61,13 +72,19 @@ function generateInterfaceCode(iface: TypeScriptInterface): string {
     const optional = prop.optional ? "?" : "";
 
     // Generate JSDoc comment if we have description or default
-    if (prop.description || prop.default !== undefined) {
+    if (
+      (prop.description != null && prop.description !== "") ||
+      prop.default !== undefined
+    ) {
       code += `  /**\n`;
 
-      if (prop.description) {
+      if (prop.description != null && prop.description !== "") {
         // Format multi-line descriptions properly with " * " prefix
         // Escape */ sequences to prevent premature comment closure
-        const escapedDescription = prop.description.replace(/\*\//g, "*\\/");
+        const escapedDescription = prop.description.replaceAll(
+          "*/",
+          String.raw`*\/`,
+        );
         const descLines = escapedDescription.split("\n");
         for (const line of descLines) {
           code += `   * ${line}\n`;
@@ -76,8 +93,12 @@ function generateInterfaceCode(iface: TypeScriptInterface): string {
 
       if (prop.default !== undefined) {
         const defaultStr = formatDefaultValue(prop.default);
-        if (defaultStr) {
-          if (prop.description) code += `   *\n`;
+        const hasDescription =
+          prop.description != null && prop.description !== "";
+        if (defaultStr != null && defaultStr !== "" && hasDescription) {
+          code += `   *\n`;
+        }
+        if (defaultStr != null && defaultStr !== "") {
           code += `   * @default ${defaultStr}\n`;
         }
       }
@@ -96,13 +117,19 @@ function generateInterfaceCode(iface: TypeScriptInterface): string {
  * Format a default value for display in JSDoc
  */
 function formatDefaultValue(value: unknown): string | null {
-  if (value === null) return "null";
-  if (value === undefined) return null;
+  if (value === null) {
+    return "null";
+  }
+  if (value === undefined) {
+    return null;
+  }
 
   // Handle arrays
   const arrayCheck = ArraySchema.safeParse(value);
   if (arrayCheck.success) {
-    if (arrayCheck.data.length === 0) return "[]";
+    if (arrayCheck.data.length === 0) {
+      return "[]";
+    }
     if (arrayCheck.data.length <= 3) {
       try {
         return JSON.stringify(arrayCheck.data);
@@ -117,7 +144,9 @@ function formatDefaultValue(value: unknown): string | null {
   const recordCheck = RecordSchema.safeParse(value);
   if (recordCheck.success) {
     const keys = Object.keys(recordCheck.data);
-    if (keys.length === 0) return "{}";
+    if (keys.length === 0) {
+      return "{}";
+    }
     if (keys.length <= 3) {
       try {
         return JSON.stringify(recordCheck.data);
@@ -133,7 +162,7 @@ function formatDefaultValue(value: unknown): string | null {
   if (stringCheck.success) {
     // Truncate long strings
     if (stringCheck.data.length > 50) {
-      return `"${stringCheck.data.substring(0, 47)}..."`;
+      return `"${stringCheck.data.slice(0, 47)}..."`;
     }
     return `"${stringCheck.data}"`;
   }
@@ -157,10 +186,13 @@ function formatDefaultValue(value: unknown): string | null {
   }
 }
 
-function generateParameterType(iface: TypeScriptInterface, chartName: string): string {
+function generateParameterType(
+  iface: TypeScriptInterface,
+  chartName: string,
+): string {
   const parameterKeys = flattenInterfaceKeys(iface);
 
-  const normalizedChartName = capitalizeFirst(chartName).replace(/-/g, "");
+  const normalizedChartName = capitalizeFirst(chartName).replaceAll("-", "");
   let code = `export type ${normalizedChartName}HelmParameters = {\n`;
 
   for (const key of parameterKeys) {
@@ -172,12 +204,15 @@ function generateParameterType(iface: TypeScriptInterface, chartName: string): s
   return code;
 }
 
-function flattenInterfaceKeys(iface: TypeScriptInterface, prefix = ""): string[] {
+function flattenInterfaceKeys(
+  iface: TypeScriptInterface,
+  prefix = "",
+): string[] {
   const keys: string[] = [];
 
   for (const [key, prop] of Object.entries(iface.properties)) {
     // Remove quotes from key for parameter names
-    const cleanKey = key.replace(/"/g, "");
+    const cleanKey = key.replaceAll('"', "");
     const fullKey = prefix ? `${prefix}.${cleanKey}` : cleanKey;
 
     if (prop.nested) {