kubernetes-fluent-client 3.5.5 → 3.6.0

package/src/postProcessing.ts

@@ -6,7 +6,7 @@ import * as path from "path";
 import { GenerateOptions } from "./generate";
 import { GenericKind } from "./types";
 import { CustomResourceDefinition } from "./upstream";
-import { FileSystem, NodeFileSystem } from "./fileSystem";
+import { modifyAndNormalizeClassProperties, normalizeIndentationAndSpacing } from "./normalization";
 
 type CRDResult = {
   name: string;
@@ -14,8 +14,6 @@ type CRDResult = {
   version: string;
 };
 
-type CodeLines = string[];
-
 type ClassContextResult = { line: string; insideClass: boolean; braceBalance: number };
 
 const genericKindProperties = getGenericKindProperties();
@@ -25,23 +23,18 @@ const genericKindProperties = getGenericKindProperties();
  *
  * @param allResults The array of CRD results.
  * @param opts The options for post-processing.
- * @param fileSystem The file system interface for reading and writing files.
  */
-export async function postProcessing(
-  allResults: CRDResult[],
-  opts: GenerateOptions,
-  fileSystem: FileSystem = new NodeFileSystem(),
-) {
+export async function postProcessing(allResults: CRDResult[], opts: GenerateOptions) {
   if (!opts.directory) {
     opts.logFn("⚠️ Error: Directory is not defined.");
     return;
   }
 
-  const files = fileSystem.readdirSync(opts.directory);
+  const files = fs.readdirSync(opts.directory);
   opts.logFn("\n🔧 Post-processing started...");
 
   const fileResultMap = mapFilesToCRD(allResults);
-  await processFiles(files, fileResultMap, opts, fileSystem);
+  await processFiles(files, fileResultMap, opts);
 
   opts.logFn("🔧 Post-processing completed.\n");
 }
@@ -73,13 +66,11 @@ export function mapFilesToCRD(allResults: CRDResult[]): Record<string, CRDResult
  * @param files - The list of file names to process.
  * @param fileResultMap - A map linking file names to their corresponding CRD results.
  * @param opts - Options for the generation process.
- * @param fileSystem - The file system interface for reading and writing files.
  */
 export async function processFiles(
   files: string[],
   fileResultMap: Record<string, CRDResult>,
   opts: GenerateOptions,
-  fileSystem: FileSystem,
 ) {
   for (const file of files) {
     if (!opts.directory) {
@@ -94,7 +85,7 @@ export async function processFiles(
     }
 
     try {
-      processAndModifySingleFile(filePath, fileResult, opts, fileSystem);
+      processAndModifySingleFile(filePath, fileResult, opts);
     } catch (error) {
       logError(error, filePath, opts.logFn);
     }
@@ -110,20 +101,18 @@ export async function processFiles(
  * @param fileResult.crd - The CustomResourceDefinition object.
  * @param fileResult.version - The version of the CRD.
  * @param opts - Options for the generation process.
- * @param fileSystem - The file system interface for reading and writing files.
  */
 export function processAndModifySingleFile(
   filePath: string,
   fileResult: CRDResult,
   opts: GenerateOptions,
-  fileSystem: FileSystem,
 ) {
   opts.logFn(`🔍 Processing file: ${filePath}`);
   const { name, crd, version } = fileResult;
 
   let fileContent;
   try {
-    fileContent = fileSystem.readFile(filePath);
+    fileContent = fs.readFileSync(filePath, "utf8");
   } catch (error) {
     logError(error, filePath, opts.logFn);
     return;
@@ -138,7 +127,7 @@ export function processAndModifySingleFile(
   }
 
   try {
-    fileSystem.writeFile(filePath, modifiedContent);
+    fs.writeFileSync(filePath, modifiedContent);
     opts.logFn(`✅ Successfully processed and wrote file: ${filePath}`);
   } catch (error) {
     logError(error, filePath, opts.logFn);
@@ -166,7 +155,7 @@ export function applyCRDPostProcessing(
     let lines = content.split("\n");
 
     // Wraps with the fluent client if needed
-    if (shouldWrapWithFluentClient(opts)) {
+    if (opts.language === "ts" && !opts.plain) {
       lines = wrapWithFluentClient(lines, name, crd, version, opts.npmPackage);
     }
     const foundInterfaces = collectInterfaceNames(lines);
@@ -183,34 +172,6 @@ export function applyCRDPostProcessing(
   }
 }
 
-/**
- * Reads the content of a file from disk.
- *
- * @param filePath The path to the file.
- * @returns The file contents as a string.
- */
-export function readFile(filePath: string): string {
-  try {
-    return fs.readFileSync(filePath, "utf8");
-  } catch (error) {
-    throw new Error(`Failed to read file at ${filePath}: ${error.message}`);
-  }
-}
-
-/**
- * Writes the modified content back to the file.
- *
- * @param filePath The path to the file.
- * @param content The modified content to write.
- */
-export function writeFile(filePath: string, content: string): void {
-  try {
-    fs.writeFileSync(filePath, content, "utf8");
-  } catch (error) {
-    throw new Error(`Failed to write file at ${filePath}: ${error.message}`);
-  }
-}
-
 /**
  * Retrieves the properties of the `GenericKind` class, excluding dynamic properties like `[key: string]: any`.
  *
@@ -227,7 +188,7 @@ export function getGenericKindProperties(): string[] {
  * @param lines The lines of the file content.
  * @returns A set of found interface names.
  */
-export function collectInterfaceNames(lines: CodeLines): Set<string> {
+export function collectInterfaceNames(lines: string[]): Set<string> {
   // https://regex101.com/r/S6w8pW/1
   const interfacePattern = /export interface (?<interfaceName>\w+)/;
   const foundInterfaces = new Set<string>();
@@ -263,109 +224,6 @@ export function updateBraceBalance(line: string, braceBalance: number): number {
   return braceBalance + (line.includes("{") ? 1 : 0) - (line.includes("}") ? 1 : 0);
 }
 
-/**
- * Generates a regular expression to match a property pattern in TypeScript.
- *
- * @param prop The property name to match.
- * @returns A regular expression to match the property pattern.
- */
-export function getPropertyPattern(prop: string): RegExp {
-  // For prop="kind", the pattern will match "kind ? :" or "kind :"
-  // https://regex101.com/r/mF8kXn/1
-  return new RegExp(`\\b${prop}\\b\\s*\\?\\s*:|\\b${prop}\\b\\s*:`);
-}
-
-/**
- * Applies ESLint and property modifiers to a line of code.
- *
- * @param line - The current line of code.
- * @param genericKindProperties - The list of properties from `GenericKind`.
- * @param foundInterfaces - The set of found interfaces in the file.
- * @returns The modified line.
- */
-export function modifyPropertiesAndAddEslintDirective(
-  line: string,
-  genericKindProperties: string[],
-  foundInterfaces: Set<string>,
-): string {
-  line = addDeclareAndOptionalModifiersToProperties(line, genericKindProperties, foundInterfaces);
-  line = processEslintDisable(line, genericKindProperties);
-  return line;
-}
-
-/**
- * Applies property modifiers to a line of code.
- *
- * @param line The current line of code.
- * @param genericKindProperties The list of properties from `GenericKind`.
- * @param foundInterfaces The set of found interfaces in the file.
- * @returns The modified line.
- */
-export function addDeclareAndOptionalModifiersToProperties(
-  line: string,
-  genericKindProperties: string[],
-  foundInterfaces: Set<string>,
-): string {
-  line = addDeclareToGenericKindProperties(line, genericKindProperties);
-  line = makePropertiesOptional(line, foundInterfaces);
-  line = normalizeLineIndentation(line);
-  return line;
-}
-/**
- * Adds the `declare` keyword to `GenericKind` properties.
- *
- * @param line The current line of code.
- * @param genericKindProperties The list of properties from `GenericKind`.
- * @returns The modified line with the `declare` keyword, if applicable.
- */
-export function addDeclareToGenericKindProperties(
-  line: string,
-  genericKindProperties: string[],
-): string {
-  for (const prop of genericKindProperties) {
-    const propertyPattern = getPropertyPattern(prop);
-    if (propertyPattern.test(line)) {
-      return line.replace(prop, `declare ${prop}`);
-    }
-  }
-  return line;
-}
-
-/**
- * Makes a property optional if its type matches one of the found interfaces and it is not already optional.
- *
- * @param line The current line of code.
- * @param foundInterfaces The set of found interfaces in the file.
- * @returns The modified line with the optional `?` symbol.
- */
-export function makePropertiesOptional(line: string, foundInterfaces: Set<string>): string {
-  // https://regex101.com/r/kX8TCj/1
-  const propertyTypePattern = /:\s*(?<propertyType>\w+)\s*;/;
-  const match = line.match(propertyTypePattern);
-
-  if (match?.groups?.propertyType) {
-    const { propertyType } = match.groups;
-    if (foundInterfaces.has(propertyType) && !line.includes("?")) {
-      return line.replace(":", "?:");
-    }
-  }
-  return line;
-}
-
-/**
- * Adds an ESLint disable comment for `[key: string]: any` if it's not part of `GenericKind`.
- *
- * @param line The current line of code.
- * @param genericKindProperties The list of properties from `GenericKind`.
- * @returns The modified line with the ESLint disable comment.
- */
-export function processEslintDisable(line: string, genericKindProperties: string[]): string {
-  if (line.includes("[key: string]: any") && !genericKindProperties.includes("[key: string]")) {
-    return `  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n${line}`;
-  }
-  return line;
-}
-
 /**
  * Wraps the generated TypeScript file with fluent client elements (`GenericKind` and `RegisterKind`).
  *
@@ -377,7 +235,7 @@ export function processEslintDisable(line: string, genericKindProperties: string
  * @returns The processed TypeScript lines.
  */
 export function wrapWithFluentClient(
-  lines: CodeLines,
+  lines: string[],
   name: string,
   crd: CustomResourceDefinition,
   version: string,
@@ -404,61 +262,6 @@ export function wrapWithFluentClient(
   return lines;
 }
 
-/**
- * Normalizes indentation for TypeScript lines to a consistent format.
- *
- * @param lines The generated TypeScript lines.
- * @returns The lines with normalized indentation.
- */
-export function normalizeIndentation(lines: CodeLines): string[] {
-  return lines.map(line => line.replace(/^ {4}/, "  "));
-}
-
-/**
- * Normalizes the indentation of a single line to use two spaces instead of four.
- *
- * @param line The line of code to normalize.
- * @returns The line with normalized indentation.
- */
-export function normalizeLineIndentation(line: string): string {
-  return line.replace(/^ {4}/, "  ");
-}
-
-/**
- * Normalizes spacing between property names and types in TypeScript lines.
- *
- * @param lines The generated TypeScript lines.
- * @returns The lines with normalized property spacing.
- */
-export function normalizePropertySpacing(lines: CodeLines): string[] {
-  // https://regex101.com/r/XEv3pL/1
-  return lines.map(line => line.replace(/\s*\?\s*:\s*/, "?: "));
-}
-
-/**
- * Removes lines containing `[property: string]: any;` from TypeScript files.
- *
- * @param lines The generated TypeScript lines.
- * @param opts The options for processing.
- * @returns The lines with `[property: string]: any;` removed.
- */
-export function removePropertyStringAny(lines: CodeLines, opts: GenerateOptions): string[] {
-  if (opts.language === "ts" || opts.language === "typescript") {
-    return lines.filter(line => !line.includes("[property: string]: any;"));
-  }
-  return lines;
-}
-
-/**
- * Determines if the content should be wrapped with the fluent client.
- *
- * @param opts The options for generating the content.
- * @returns True if the content should be wrapped with the fluent client, false otherwise.
- */
-export function shouldWrapWithFluentClient(opts: GenerateOptions): boolean {
-  return opts.language === "ts" && !opts.plain;
-}
-
 /**
  * Processes the lines of the TypeScript file, focusing on classes extending `GenericKind`.
  *
@@ -468,7 +271,7 @@ export function shouldWrapWithFluentClient(opts: GenerateOptions): boolean {
  * @returns The processed lines.
  */
 export function processLines(
-  lines: CodeLines,
+  lines: string[],
   genericKindProperties: string[],
   foundInterfaces: Set<string>,
 ): string[] {
@@ -524,37 +327,6 @@ export function processClassContext(
   return { line, insideClass, braceBalance };
 }
 
-/**
- * Processes a single line inside a class extending `GenericKind`.
- *
- * @param line The current line of code.
- * @param genericKindProperties The list of properties from `GenericKind`.
- * @param foundInterfaces The set of found interfaces in the file.
- * @returns The modified line.
- */
-export function modifyAndNormalizeClassProperties(
-  line: string,
-  genericKindProperties: string[],
-  foundInterfaces: Set<string>,
-): string {
-  line = modifyPropertiesAndAddEslintDirective(line, genericKindProperties, foundInterfaces);
-  line = normalizeLineIndentation(line);
-  return line;
-}
-
-/**
- * Normalizes lines after processing, including indentation, spacing, and removing unnecessary lines.
- *
- * @param lines The lines of the file content.
- * @param opts The options for processing.
- * @returns The normalized lines.
- */
-export function normalizeIndentationAndSpacing(lines: CodeLines, opts: GenerateOptions): string[] {
-  let normalizedLines = normalizeIndentation(lines);
-  normalizedLines = normalizePropertySpacing(normalizedLines);
-  return removePropertyStringAny(normalizedLines, opts);
-}
-
 /**
  * Handles logging for errors with stack trace.
  *

package/src/types.ts

@@ -1,10 +1,9 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 
-import { KubernetesObject, V1ObjectMeta } from "@kubernetes/client-node";
-
-export { KubernetesObject, KubernetesListObject } from "@kubernetes/client-node";
-
+import { V1ObjectMeta } from "@kubernetes/client-node";
+import type { KubernetesListObject, KubernetesObject } from "@kubernetes/client-node";
+export type { KubernetesListObject, KubernetesObject };
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type GenericClass = abstract new () => any;
 

package/dist/fileSystem.d.ts

@@ -1,11 +0,0 @@
-export interface FileSystem {
-    readFile(filePath: string): string;
-    writeFile(filePath: string, content: string): void;
-    readdirSync(directory: string): string[];
-}
-export declare class NodeFileSystem implements FileSystem {
-    readFile(filePath: string): string;
-    writeFile(filePath: string, content: string): void;
-    readdirSync(directory: string): string[];
-}
-//# sourceMappingURL=fileSystem.d.ts.map

package/dist/fileSystem.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"fileSystem.d.ts","sourceRoot":"","sources":["../src/fileSystem.ts"],"names":[],"mappings":"AAKA,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC;IACnC,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACnD,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CAC1C;AAGD,qBAAa,cAAe,YAAW,UAAU;IAC/C,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAIlC,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;IAIlD,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE;CAGzC"}

package/dist/fileSystem.js

@@ -1,52 +0,0 @@
-"use strict";
-// SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NodeFileSystem = void 0;
-const fs = __importStar(require("fs"));
-/* eslint class-methods-use-this: "off" */
-class NodeFileSystem {
-    readFile(filePath) {
-        return fs.readFileSync(filePath, "utf8");
-    }
-    writeFile(filePath, content) {
-        fs.writeFileSync(filePath, content, "utf8");
-    }
-    readdirSync(directory) {
-        return fs.readdirSync(directory);
-    }
-}
-exports.NodeFileSystem = NodeFileSystem;

package/src/fileSystem.ts

@@ -1,25 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
-
-import * as fs from "fs";
-
-export interface FileSystem {
-  readFile(filePath: string): string;
-  writeFile(filePath: string, content: string): void;
-  readdirSync(directory: string): string[];
-}
-
-/* eslint class-methods-use-this: "off" */
-export class NodeFileSystem implements FileSystem {
-  readFile(filePath: string): string {
-    return fs.readFileSync(filePath, "utf8");
-  }
-
-  writeFile(filePath: string, content: string): void {
-    fs.writeFileSync(filePath, content, "utf8");
-  }
-
-  readdirSync(directory: string): string[] {
-    return fs.readdirSync(directory);
-  }
-}