jsDocs

Author: Chrilleweb

src/ui/compare/printAutoFix.ts

@@ -6,6 +6,15 @@ export interface AutoFixResult {
   addedExample: string[];
 }
 
+/**
+ * Prints the result of the auto-fix operation.
+ * @param changed - Whether any changes were made.
+ * @param result - The result of the auto-fix operation.
+ * @param envName - The name of the environment file.
+ * @param exampleName - The name of the example file.
+ * @param json - Whether to output in JSON format.
+ * @returns void
+ */
 export function printAutoFix(
   changed: boolean,
   result: AutoFixResult,

src/ui/shared/printGitignore.ts

@@ -6,6 +6,11 @@ type GitignoreWarningOptions = {
   log?: (msg: string) => void;
 };
 
+/**
+ * Logs a warning about .env not being ignored by Git.
+ * @param options - Options for the gitignore warning.
+ * @returns void
+ */
 export function printGitignoreWarning(options: GitignoreWarningOptions): void {
   const { envFile, reason, log = console.log } = options;