elrh-cosca 0.3.6 → 0.4.0

package/dist/types/src/_private/fetch-file.d.ts

@@ -1 +1 @@
-export declare function fetchFile(url: string): Promise<string>;
+export declare function fetchFile(url: string, redirectsLeft?: number): Promise<string>;

package/dist/types/src/checks/get-package-manager.d.ts

@@ -1,6 +1,6 @@
 /**
- * Checks what package manager was used to execute the current command.
+ * Checks what package manager/runtime was used to execute the current command.
  *
- * @returns {string} The name of the package manager used ('npm', 'yarn', 'pnpm', 'deno' or 'bun').
+ * @returns {'npm' | 'yarn' | 'pnpm' | 'deno' | 'bun'} The name of the package manager used (falls back to 'npm' if detection failed).
  */
 export declare function getPackageManager(): 'npm' | 'yarn' | 'pnpm' | 'deno' | 'bun';

package/dist/types/src/checks/has-json-key.d.ts

@@ -1,9 +1,11 @@
+import { HasJsonKeyOptions } from '../types/functions.js';
 /**
  * Checks if a JSON file contains specified key.
  *
- * @param {string} targetFile - The path to the JSON file to be checked (relative to CWD).
- * @param {string} jsonKey - The key in the JSON file to be checked for existence (may use dot notation for nested keys).
+ * @param {HasJsonKeyOptions} opts - Options for this operation.
+ * @param {string} opts.targetFile - The path to the JSON file to be checked (relative to CWD).
+ * @param {string} opts.jsonKey - The key in the JSON file to be checked for existence (may use dot notation for nested keys).
  * @returns {boolean} True if the key exists in target file, false otherwise.
  * @throws Will throw an error if the path is invalid, file does not exist or cannot be parsed as JSON.
  */
-export declare function hasJsonKey(targetFile: string, jsonKey: string): boolean;
+export declare function hasJsonKey(opts: HasJsonKeyOptions): boolean;

package/dist/types/src/checks/has-text.d.ts

@@ -1,10 +1,12 @@
+import { HasTextOptions } from '../types/functions.js';
 /**
  * Checks if a text file contains specified text.
  *
- * @param {string} targetFile - The path to the text file to be checked (relative to CWD).
- * @param {string | RegExp} pattern - The text or regular expression pattern to search for.
- * @param {boolean} exact - If true, requires exact line match (default: false for partial matching).
+ * @param {HasTextOptions} opts - Options for this operation.
+ * @param {string} opts.targetFile - The path to the text file to be checked (relative to CWD).
+ * @param {string | RegExp} opts.pattern - The text or regular expression pattern to search for (lines and text pattern are trimmed before matching).
+ * @param {boolean} [opts.exact] - If true, a text pattern must match a whole line; ignored for RegExp patterns (default: false).
  * @returns {boolean} True if the pattern is found in target file, false otherwise.
  * @throws Will throw an error if the path is invalid or the file does not exist.
  */
-export declare function hasText(targetFile: string, pattern: string | RegExp, exact?: boolean): boolean;
+export declare function hasText(opts: HasTextOptions): boolean;

package/dist/types/src/checks/has-yaml-key.d.ts

@@ -0,0 +1,11 @@
+import { HasYamlKeyOptions } from '../types/functions.js';
+/**
+ * Checks if a YAML file contains specified key.
+ *
+ * @param {HasYamlKeyOptions} opts - Options for this operation.
+ * @param {string} opts.targetFile - The path to the YAML file to be checked (relative to CWD).
+ * @param {string} opts.yamlKey - The key in the YAML file to be checked for existence (may use dot notation for nested keys).
+ * @returns {Promise<boolean>} A promise resolving to true if the key exists in target file, false otherwise.
+ * @throws Will throw an error if the path is invalid, file does not exist or cannot be parsed as YAML.
+ */
+export declare function hasYamlKey(opts: HasYamlKeyOptions): Promise<boolean>;

package/dist/types/src/checks/path-exists.d.ts

@@ -1,8 +1,10 @@
+import { PathExistsOptions } from '../types/functions.js';
 /**
- * Checks if the specified path exists on FS.
+ * Checks if the specified path exists on FS. The search is limited to CWD.
  *
- * @param {string} targetPath - The path on FS to be checked (relative to CWD).
+ * @param {PathExistsOptions} opts - Options for this operation.
+ * @param {string} opts.targetPath - The path to the file or directory to be checked (relative to CWD).
  * @returns {boolean} True if the path exists, false otherwise.
- * @throws Will throw an error if the path is invalid (can't traverse past CWD).
+ * @throws Will throw an error if the path is invalid.
  */
-export declare function pathExists(targetPath: string): boolean;
+export declare function pathExists(opts: PathExistsOptions): boolean;

package/dist/types/src/functions/create-file-from-template.d.ts

@@ -1,11 +1,13 @@
+import { CreateFileFromTemplateOptions } from '../types/functions.js';
 /**
- * Creates a new copy of given file from a local template.
+ * Creates a new file as a copy of a template file from an installed package.
  *
- * @param {string} templateFile - The path to the template file (prefixed with package name).
- * @param {string} targetFile - The path to the target file to create (relative to CWD). Can overwrite existing files if confirmed.
- * @param {boolean} force - Whether to force creation without prompting.
- * @param {string} prompt - Custom prompt message displayed in terminal.
- * @returns {Promise<void>} An empty promise that resolves when the file is created.
- * @throws Will throw an error if the path is invalid, the template file cannot be found or the target file failed to be created.
+ * @param {CreateFileFromTemplateOptions} opts - Options for this operation.
+ * @param {string} opts.templateFile - The path to the template file in `package:relative/path/to/file` format (relative to the package root).
+ * @param {string} opts.targetFile - The path to the file to create (relative to CWD). Existing file is overwritten after confirmation.
+ * @param {boolean} [opts.force] - If true, skips all confirmation prompts (default: false).
+ * @param {string} [opts.prompt] - Custom text of the initial confirmation question (default: built-in question).
+ * @returns {Promise<void>} A promise that resolves when the operation is finished or skipped.
+ * @throws Will throw an error if the path is invalid, the template path cannot be parsed, the package or the template file cannot be found or the target file failed to be created.
  */
-export declare function createFileFromTemplate(templateFile: string, targetFile: string, force?: boolean, prompt?: string): Promise<void>;
+export declare function createFileFromTemplate(opts: CreateFileFromTemplateOptions): Promise<void>;

package/dist/types/src/functions/create-file-from-web-template.d.ts

@@ -1,11 +1,13 @@
+import { CreateFileFromWebTemplateOptions } from '../types/functions.js';
 /**
- * Creates a new copy of given file from a web template.
+ * Creates a new file as a copy of a template file downloaded from the web.
  *
- * @param {string} url - The URL to the template file (must be accessible via `node:https.get` and return raw text data).
- * @param {string} targetFile - The path to the target file to create (relative to CWD). Can overwrite existing files if confirmed.
- * @param {boolean} force - Whether to force creation without prompting.
- * @param {string} prompt - Custom prompt message displayed in terminal.
- * @returns {Promise<void>} An empty promise that resolves when the file is created.
- * @throws Will throw an error if the path is invalid, the remote template cannot be fetched or the target file failed to be created.
+ * @param {CreateFileFromWebTemplateOptions} opts - Options for this operation.
+ * @param {string} opts.url - The URL of the template file (must be accessible via `node:https.get` and return raw text data; HTTPS redirects are followed).
+ * @param {string} opts.targetFile - The path to the file to create (relative to CWD). Existing file is overwritten after confirmation.
+ * @param {boolean} [opts.force] - If true, skips all confirmation prompts (default: false).
+ * @param {string} [opts.prompt] - Custom text of the initial confirmation question (default: built-in question).
+ * @returns {Promise<void>} A promise that resolves when the operation is finished or skipped.
+ * @throws Will throw an error if the path is invalid, the template file cannot be fetched or the target file failed to be created.
  */
-export declare function createFileFromWebTemplate(url: string, targetFile: string, force?: boolean, prompt?: string): Promise<void>;
+export declare function createFileFromWebTemplate(opts: CreateFileFromWebTemplateOptions): Promise<void>;

package/dist/types/src/functions/delete-path.d.ts

@@ -1,10 +1,12 @@
+import { DeletePathOptions } from '../types/functions.js';
 /**
- * Deletes given path from FS.
+ * Deletes a file or a directory (recursively) from FS.
  *
- * @param {string} targetPath - The path to delete (relative to CWD).
- * @param {boolean} force - Whether to force the deletion without prompting.
- * @param {string} prompt - Custom prompt message displayed in terminal.
- * @returns {Promise<void>} An empty promise that resolves when the path is deleted.
- * @throws Will throw an error if the path is invalid.
+ * @param {DeletePathOptions} opts - Options for this operation.
+ * @param {string} opts.targetPath - The path to the file or directory to delete (relative to CWD).
+ * @param {boolean} [opts.force] - If true, skips all confirmation prompts (default: false).
+ * @param {string} [opts.prompt] - Custom text of the initial confirmation question (default: built-in question).
+ * @returns {Promise<void>} A promise that resolves when the operation is finished or skipped.
+ * @throws Will throw an error if the path is invalid or the path failed to be deleted.
  */
-export declare function deletePath(targetPath: string, force?: boolean, prompt?: string): Promise<void>;
+export declare function deletePath(opts: DeletePathOptions): Promise<void>;

package/dist/types/src/functions/remove-from-json-file.d.ts

@@ -1,11 +1,13 @@
+import { RemoveFromJsonFileOptions } from '../types/functions.js';
 /**
  * Updates a JSON file by deleting a specified key.
  *
- * @param {string} targetFile - The path to the JSON file to update (relative to CWD).
- * @param {string} jsonKey - The key in the JSON file to be deleted (may use dot notation for nested keys).
- * @param {boolean} force - Whether to force the update without prompting.
- * @param {string} prompt - Custom prompt message displayed in terminal.
- * @returns {Promise<void>} An empty promise that resolves when the file is updated.
+ * @param {RemoveFromJsonFileOptions} opts - Options for this operation.
+ * @param {string} opts.targetFile - The path to the JSON file to update (relative to CWD).
+ * @param {string} opts.jsonKey - The key in the JSON file to be deleted (may use dot notation for nested keys).
+ * @param {boolean} [opts.force] - If true, skips all confirmation prompts (default: false).
+ * @param {string} [opts.prompt] - Custom text of the initial confirmation question (default: built-in question).
+ * @returns {Promise<void>} A promise that resolves when the operation is finished or skipped.
  * @throws Will throw an error if the path is invalid, the file does not exist or cannot be parsed as JSON.
  */
-export declare function removeFromJsonFile(targetFile: string, jsonKey: string, force?: boolean, prompt?: string): Promise<void>;
+export declare function removeFromJsonFile(opts: RemoveFromJsonFileOptions): Promise<void>;

package/dist/types/src/functions/remove-from-text-file.d.ts

@@ -1,11 +1,13 @@
+import { RemoveFromTextFileOptions } from '../types/functions.js';
 /**
  * Removes lines from a text file that include the given search text.
  *
- * @param {string} targetFile - The path to the text file to update (relative to CWD).
- * @param {string} searchText - The text to search for; any line that includes this text will be removed.
- * @param {boolean} force - Whether to force the update without prompting.
- * @param {string} prompt - Custom prompt message displayed in terminal.
- * @returns {Promise<void>} An empty promise that resolves when the file is updated.
+ * @param {RemoveFromTextFileOptions} opts - Options for this operation.
+ * @param {string} opts.targetFile - The path to the text file to update (relative to CWD).
+ * @param {string} opts.searchText - The text to search for; any line that includes this text will be removed.
+ * @param {boolean} [opts.force] - If true, skips all confirmation prompts (default: false).
+ * @param {string} [opts.prompt] - Custom text of the initial confirmation question (default: built-in question).
+ * @returns {Promise<void>} A promise that resolves when the operation is finished or skipped.
  * @throws Will throw an error if the path is invalid or the file does not exist.
  */
-export declare function removeFromTextFile(targetFile: string, searchText: string, force?: boolean, prompt?: string): Promise<void>;
+export declare function removeFromTextFile(opts: RemoveFromTextFileOptions): Promise<void>;

package/dist/types/src/functions/remove-from-yaml-file.d.ts

@@ -0,0 +1,13 @@
+import { RemoveFromYamlFileOptions } from '../types/functions.js';
+/**
+ * Updates a YAML file by deleting a specified key. Comments and formatting of untouched parts are preserved.
+ *
+ * @param {RemoveFromYamlFileOptions} opts - Options for this operation.
+ * @param {string} opts.targetFile - The path to the YAML file to update (relative to CWD).
+ * @param {string} opts.yamlKey - The key in the YAML file to be deleted (may use dot notation for nested keys).
+ * @param {boolean} [opts.force] - If true, skips all confirmation prompts (default: false).
+ * @param {string} [opts.prompt] - Custom text of the initial confirmation question (default: built-in question).
+ * @returns {Promise<void>} A promise that resolves when the operation is finished or skipped.
+ * @throws Will throw an error if the path is invalid, the file does not exist or cannot be parsed as YAML.
+ */
+export declare function removeFromYamlFile(opts: RemoveFromYamlFileOptions): Promise<void>;

package/dist/types/src/functions/update-config-file.d.ts

@@ -1,14 +1,20 @@
+import { UpdateConfigFileOptions } from '../types/functions.js';
 /**
- * Update the single object-literal config found in a file.
+ * Updates the config object exported from a JS/TS config file.
  *
  * The function:
  * - Reads and edits the file as code (no execution).
- * - Uses `defu(newConfig, existingConfig)` so `newConfig` takes precedence.
+ * - Uses the default export or a single named export; the config may be a plain object or the first argument of a function call (e.g. `defineConfig({...})`).
+ * - Deep-merges `newConfig` into the existing config, so `newConfig` takes precedence; arrays are merged as a unique union.
  * - Applies the merged result back onto the AST to preserve TS/ESM structure.
  *
- * @param {string} targetFile - Path to file, relative to project root (process.cwd()).
- * @param {object} newConfig - Config to merge in (takes precedence).
- * @returns {Promise<void>} An empty promise that resolves when the file is updated.
- * @throws Will throw an error the path is invalid, the file doesn't exist or no config export is found or it cannot be processed.
+ * @param {UpdateConfigFileOptions} opts - Options for this operation.
+ * @param {string} opts.targetFile - The path to the config file to update (relative to CWD).
+ * @param {Record<string | number | symbol, any>} opts.newConfig - The config to merge in (takes precedence).
+ * @param {boolean} [opts.createMissing] - If true, the file is created (with `export default {}`) when it does not exist, after confirmation unless `force` is set (default: false).
+ * @param {boolean} [opts.force] - If true, skips all confirmation prompts (default: false).
+ * @param {string} [opts.prompt] - Custom text of the initial confirmation question (default: built-in question).
+ * @returns {Promise<void>} A promise that resolves when the operation is finished or skipped.
+ * @throws Will throw an error if the path is invalid, the file does not exist (and `createMissing` is not set), uses CommonJS `module.exports` or no suitable config export is found or it cannot be processed.
  */
-export declare function updateConfigFile(targetFile: string, newConfig: Record<string | number | symbol, any>, force?: boolean, prompt?: string): Promise<void>;
+export declare function updateConfigFile(opts: UpdateConfigFileOptions): Promise<void>;

package/dist/types/src/functions/update-json-file.d.ts

@@ -1,13 +1,15 @@
-import { JsonValue } from '../types/json.js';
+import { UpdateJsonFileOptions } from '../types/functions.js';
 /**
- * Updates a JSON file by modifying a specific key with new values.
+ * Updates a JSON file by setting a key with new value(s). The key can be nested and can alter between primitives to objects and arrays as needed.
  *
- * @param {string} targetFile - The path to the JSON file to update (relative to CWD).
- * @param {string} jsonKey - The key in the JSON file to update (can be new or existing).
- * @param {JsonPrimitive} patch - The new values to set for the specified key.
- * @param {boolean} force - Whether to force the update without prompting.
- * @param {string} prompt - Custom prompt message displayed in terminal.
- * @returns {Promise<void>} An empty promise that resolves when the file is updated.
- * @throws Will throw an error if the path is invalid, the file does not exist or cannot be parsed as JSON.
+ * @param {UpdateJsonFileOptions} opts - Options for this operation.
+ * @param {string} opts.targetFile - The path to the JSON file to update (relative to CWD).
+ * @param {string} opts.jsonKey - The key in the JSON file to update (can be new or existing; may use dot notation for nested keys - missing or non-object intermediate levels are replaced with objects).
+ * @param {DataValue} opts.patch - The value for the specified key. Objects are shallow-merged into the existing value (a non-object existing value is replaced), other values (primitives, arrays, null) replace it.
+ * @param {boolean} [opts.createMissing] - If true, the file is created when it does not exist, after confirmation unless `force` is set (default: false).
+ * @param {boolean} [opts.force] - If true, skips all confirmation prompts (default: false).
+ * @param {string} [opts.prompt] - Custom text of the initial confirmation question (default: built-in question).
+ * @returns {Promise<void>} A promise that resolves when the operation is finished or skipped.
+ * @throws Will throw an error if the path or the key is invalid, the file does not exist (and `createMissing` is not set) or cannot be parsed as JSON.
  */
-export declare function updateJsonFile(targetFile: string, jsonKey: string, patch: JsonValue, force?: boolean, prompt?: string): Promise<void>;
+export declare function updateJsonFile(opts: UpdateJsonFileOptions): Promise<void>;

package/dist/types/src/functions/update-text-file.d.ts

@@ -1,11 +1,15 @@
+import { UpdateTextFileOptions } from '../types/functions.js';
 /**
  * Updates a text file by adding new rows.
  *
- * @param {string} targetFile - The path to the text file to update (relative to CWD).
- * @param {string[]} rowsToAdd - New rows to be added at the end of the file.
- * @param {boolean} force - Whether to force the update without prompting.
- * @param {string} prompt - Custom prompt message displayed in terminal.
- * @returns {Promise<void>} An empty promise that resolves when the file is updated.
- * @throws Will throw an error if the path is invalid or the file does not exist.
+ * @param {UpdateTextFileOptions} opts - Options for this operation.
+ * @param {string} opts.targetFile - The path to the text file to update (relative to CWD).
+ * @param {string[]} opts.rowsToAdd - New rows to be added at the end of the file.
+ * @param {boolean} [opts.allowDuplicates] - If true, rows are added even if identical lines already exist in the file (default: false).
+ * @param {boolean} [opts.createMissing] - If true, the file is created when it does not exist, after confirmation unless `force` is set (default: false).
+ * @param {boolean} [opts.force] - If true, skips all confirmation prompts (default: false).
+ * @param {string} [opts.prompt] - Custom text of the initial confirmation question (default: built-in question).
+ * @returns {Promise<void>} A promise that resolves when the operation is finished or skipped.
+ * @throws Will throw an error if the path is invalid or the file does not exist (and `createMissing` is not set).
  */
-export declare function updateTextFile(targetFile: string, rowsToAdd: string[], force?: boolean, prompt?: string): Promise<void>;
+export declare function updateTextFile(opts: UpdateTextFileOptions): Promise<void>;

package/dist/types/src/functions/update-yaml-file.d.ts

@@ -0,0 +1,15 @@
+import { UpdateYamlFileOptions } from '../types/functions.js';
+/**
+ * Updates a YAML file by setting a key with new value(s). The key can be nested and can alter between primitives to objects and arrays as needed. Comments and formatting of untouched parts are preserved.
+ *
+ * @param {UpdateYamlFileOptions} opts - Options for this operation.
+ * @param {string} opts.targetFile - The path to the YAML file to update (relative to CWD).
+ * @param {string} opts.yamlKey - The key in the YAML file to update (can be new or existing; may use dot notation for nested keys - missing or non-map intermediate levels are replaced with maps).
+ * @param {DataValue} opts.patch - The value for the specified key. Objects are shallow-merged into the existing value (a non-map existing value is replaced), other values (primitives, arrays, null) replace it.
+ * @param {boolean} [opts.createMissing] - If true, the file is created when it does not exist, after confirmation unless `force` is set (default: false).
+ * @param {boolean} [opts.force] - If true, skips all confirmation prompts (default: false).
+ * @param {string} [opts.prompt] - Custom text of the initial confirmation question (default: built-in question).
+ * @returns {Promise<void>} A promise that resolves when the operation is finished or skipped.
+ * @throws Will throw an error if the path or the key is invalid, the file does not exist (and `createMissing` is not set), cannot be parsed as YAML or its root is not a map.
+ */
+export declare function updateYamlFile(opts: UpdateYamlFileOptions): Promise<void>;

package/dist/types/src/main.d.ts

@@ -1,19 +1,23 @@
 import { getPackageManager } from './checks/get-package-manager';
 import { hasJsonKey } from './checks/has-json-key';
 import { hasText } from './checks/has-text';
+import { hasYamlKey } from './checks/has-yaml-key';
 import { pathExists } from './checks/path-exists';
 import { createFileFromTemplate } from './functions/create-file-from-template';
 import { createFileFromWebTemplate } from './functions/create-file-from-web-template';
 import { deletePath } from './functions/delete-path';
 import { removeFromJsonFile } from './functions/remove-from-json-file';
 import { removeFromTextFile } from './functions/remove-from-text-file';
+import { removeFromYamlFile } from './functions/remove-from-yaml-file';
 import { updateConfigFile } from './functions/update-config-file';
 import { updateJsonFile } from './functions/update-json-file';
 import { updateTextFile } from './functions/update-text-file';
+import { updateYamlFile } from './functions/update-yaml-file';
 import { promptUser } from './terminal/prompt-user';
 import { showError } from './terminal/show-error';
 import { showMessage } from './terminal/show-message';
 import { getEnvValue } from './utils/get-env-value';
 import { parseQualifiedPath } from './utils/parse-qualified-path';
 import { resolvePackagePath } from './utils/resolve-package-path';
-export { getPackageManager, hasJsonKey, hasText, pathExists, createFileFromTemplate, createFileFromWebTemplate, deletePath, removeFromJsonFile, removeFromTextFile, updateConfigFile, updateJsonFile, updateTextFile, promptUser, showError, showMessage, getEnvValue, parseQualifiedPath, resolvePackagePath, };
+export type { HasJsonKeyOptions, HasTextOptions, HasYamlKeyOptions, PathExistsOptions, CreateFileFromTemplateOptions, CreateFileFromWebTemplateOptions, DeletePathOptions, RemoveFromJsonFileOptions, RemoveFromTextFileOptions, RemoveFromYamlFileOptions, UpdateConfigFileOptions, UpdateJsonFileOptions, UpdateTextFileOptions, UpdateYamlFileOptions, PromptUserOptions, ShowErrorOptions, ShowMessageOptions, GetEnvValueOptions, ParseQualifiedPathOptions, ResolvePackagePathOptions, } from './types/functions';
+export { getPackageManager, hasJsonKey, hasText, hasYamlKey, pathExists, createFileFromTemplate, createFileFromWebTemplate, deletePath, removeFromJsonFile, removeFromTextFile, removeFromYamlFile, updateConfigFile, updateJsonFile, updateTextFile, updateYamlFile, promptUser, showError, showMessage, getEnvValue, parseQualifiedPath, resolvePackagePath, };

package/dist/types/src/terminal/prompt-user.d.ts

@@ -1,11 +1,11 @@
+import { PromptUserOptions } from '../types/functions.js';
 /**
- * Prompts the user with a question and returns their response.
+ * Prompts the user with a yes/no question (` (y/N): ` is appended) and returns their response.
  *
- * @param {string} question - Question to ask the user
- * @param {{ input?: NodeJS.ReadableStream; output?: NodeJS.WritableStream }} options - Optional setting of custom input/output stream
- * @returns {Promise<boolean>} - true if the user answered yes (`y`, `Y`, `yes`, `YES`), false otherwise
+ * @param {PromptUserOptions} opts - Options for this operation.
+ * @param {string} opts.question - The question to ask the user.
+ * @param {NodeJS.ReadableStream} [opts.input] - Custom input stream (default: process.stdin).
+ * @param {NodeJS.WritableStream} [opts.output] - Custom output stream (default: process.stdout).
+ * @returns {Promise<boolean>} True if the user answered yes (`y` or `yes`, case-insensitive), false otherwise.
  */
-export declare function promptUser(question: string, options?: {
-    input?: NodeJS.ReadableStream;
-    output?: NodeJS.WritableStream;
-}): Promise<boolean>;
+export declare function promptUser(opts: PromptUserOptions): Promise<boolean>;

package/dist/types/src/terminal/show-error.d.ts

@@ -1,7 +1,9 @@
+import { ShowErrorOptions } from '../types/functions.js';
 /**
  * Prints error message into stderr with specified number of newlines after it.
  *
- * @param {string} message - The error message text to display.
- * @param {number} linesAfter - The number of newlines to print after the message (default is 1).
+ * @param {ShowErrorOptions} opts - Options for this operation.
+ * @param {string} opts.message - The error message text to display.
+ * @param {number} [opts.linesAfter] - The number of newlines to print after the message (default: 1).
  */
-export declare function showError(message: string, linesAfter?: number): void;
+export declare function showError(opts: ShowErrorOptions): void;

package/dist/types/src/terminal/show-message.d.ts

@@ -1,7 +1,9 @@
+import { ShowMessageOptions } from '../types/functions.js';
 /**
  * Prints message into stdout with specified number of newlines after it.
  *
- * @param {string} message - The message text to display.
- * @param {number} linesAfter - The number of newlines to print after the message (default is 1).
+ * @param {ShowMessageOptions} opts - Options for this operation.
+ * @param {string} opts.message - The message text to display.
+ * @param {number} [opts.linesAfter] - The number of newlines to print after the message (default: 1).
  */
-export declare function showMessage(message: string, linesAfter?: number): void;
+export declare function showMessage(opts: ShowMessageOptions): void;

package/dist/types/src/types/data.d.ts

@@ -0,0 +1,6 @@
+export type DataPrimitive = string | number | boolean | null;
+export type DataObject = {
+    [key: string]: DataValue;
+};
+export type DataArray = DataValue[];
+export type DataValue = DataPrimitive | DataObject | DataArray;

package/dist/types/src/types/functions.d.ts

@@ -0,0 +1,99 @@
+import { DataValue } from './data.js';
+interface FileOperationOptions {
+    /** Skip confirmation prompts. Defaults to false. */
+    force?: boolean;
+    /** Custom confirmation question. Defaults to the operation's built-in question. */
+    prompt?: string;
+}
+export interface HasJsonKeyOptions {
+    targetFile: string;
+    jsonKey: string;
+}
+export interface HasYamlKeyOptions {
+    targetFile: string;
+    yamlKey: string;
+}
+export interface HasTextOptions {
+    targetFile: string;
+    pattern: string | RegExp;
+    /** Require a full-line string match. Defaults to false. */
+    exact?: boolean;
+}
+export interface PathExistsOptions {
+    targetPath: string;
+}
+export interface CreateFileFromTemplateOptions extends FileOperationOptions {
+    templateFile: string;
+    targetFile: string;
+}
+export interface CreateFileFromWebTemplateOptions extends FileOperationOptions {
+    url: string;
+    targetFile: string;
+}
+export interface DeletePathOptions extends FileOperationOptions {
+    targetPath: string;
+}
+export interface RemoveFromJsonFileOptions extends FileOperationOptions {
+    targetFile: string;
+    jsonKey: string;
+}
+export interface RemoveFromTextFileOptions extends FileOperationOptions {
+    targetFile: string;
+    searchText: string;
+}
+export interface RemoveFromYamlFileOptions extends FileOperationOptions {
+    targetFile: string;
+    yamlKey: string;
+}
+export interface UpdateConfigFileOptions extends FileOperationOptions {
+    targetFile: string;
+    newConfig: Record<string | number | symbol, any>;
+    createMissing?: boolean;
+}
+export interface UpdateJsonFileOptions extends FileOperationOptions {
+    targetFile: string;
+    jsonKey: string;
+    patch: DataValue;
+    createMissing?: boolean;
+}
+export interface UpdateYamlFileOptions extends FileOperationOptions {
+    targetFile: string;
+    yamlKey: string;
+    patch: DataValue;
+    createMissing?: boolean;
+}
+export interface UpdateTextFileOptions extends FileOperationOptions {
+    targetFile: string;
+    rowsToAdd: string[];
+    allowDuplicates?: boolean;
+    createMissing?: boolean;
+}
+export interface PromptUserOptions {
+    question: string;
+    /** Defaults to process.stdin. */
+    input?: NodeJS.ReadableStream;
+    /** Defaults to process.stdout. */
+    output?: NodeJS.WritableStream;
+}
+export interface ShowErrorOptions {
+    message: string;
+    /** Number of trailing newlines. Defaults to 1. */
+    linesAfter?: number;
+}
+export interface ShowMessageOptions {
+    message: string;
+    /** Number of trailing newlines. Defaults to 1. */
+    linesAfter?: number;
+}
+export interface GetEnvValueOptions {
+    key: string;
+    /** Defaults to .env in the current working directory at call time. */
+    envFilePath?: string;
+}
+export interface ParseQualifiedPathOptions {
+    path: string;
+}
+export interface ResolvePackagePathOptions {
+    packageName: string;
+}
+export {};

package/dist/types/src/utils/get-env-value.d.ts

@@ -1,8 +1,10 @@
+import { GetEnvValueOptions } from '../types/functions.js';
 /**
  * Retrieves the value of an environment variable from a .env file.
  *
- * @param {string} key - The name of the environment variable to retrieve.
- * @param {string} envFilePath - The path to the .env file (default is the .env file in the project root).
- * @returns {string | undefined} - The value of the environment variable, or undefined if not found.
+ * @param {GetEnvValueOptions} opts - Options for this operation.
+ * @param {string} opts.key - The name of the environment variable to retrieve.
+ * @param {string} [opts.envFilePath] - The path to the .env file (default: `.env` in CWD).
+ * @returns {string | undefined} The value of the environment variable (without surrounding quotes), or undefined if the file or the variable is not found.
  */
-export declare function getEnvValue(key: string, envFilePath?: string): string | undefined;
+export declare function getEnvValue(opts: GetEnvValueOptions): string | undefined;

package/dist/types/src/utils/parse-qualified-path.d.ts

@@ -1,12 +1,14 @@
+import { ParseQualifiedPathOptions } from '../types/functions.js';
 /**
  * Expects path to file in `"package:relative/path/to/file"` format and splits it into `{ pkg, file }`.
  * The package name can be scoped (e.g. `@scope/package`).
  *
- * @param {string} path - The qualified path string to parse.
+ * @param {ParseQualifiedPathOptions} opts - Options for this operation.
+ * @param {string} opts.path - The qualified path string to parse.
  * @returns {{ pkg: string; file: string }} An object containing the package name and the relative file path.
  * @throws Will throw an error if the input format is invalid.
  */
-export declare function parseQualifiedPath(path: string): {
+export declare function parseQualifiedPath(opts: ParseQualifiedPathOptions): {
     pkg: string;
     file: string;
 };

package/dist/types/src/utils/resolve-package-path.d.ts

@@ -1,10 +1,12 @@
+import { ResolvePackagePathOptions } from '../types/functions.js';
 /**
- * Resolve a package's installed root directory *from the target app*.
- * Package name can be scoped (e.g. `@scope/package`).
- * Works with npm/yarn/pnpm, hoisting or not.
+ * Resolves a package's root directory *from the target app* (CWD).
+ * Returns CWD itself if its `package.json` has the same name, otherwise looks into `node_modules` in CWD.
+ * The package name can be scoped (e.g. `@scope/package`).
  *
- * @param {string} packageName - The name of the package to resolve.
+ * @param {ResolvePackagePathOptions} opts - Options for this operation.
+ * @param {string} opts.packageName - The name of the package to resolve.
  * @returns {string} The absolute path to the package's root directory.
  * @throws Will throw an error if the package cannot be found or accessed.
  */
-export declare function resolvePackagePath(packageName: string): string;
+export declare function resolvePackagePath(opts: ResolvePackagePathOptions): string;

package/dist/types/test/checks-has-yaml-key.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/test/functions-remove-from-yaml-file.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/test/functions-update-yaml-file.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/test/private-deep-merge-object.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/test/private-fetch-file.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/test/snapshots/created-config-file.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    testKey1: string;
+    testKey2: {
+        nestedKey: boolean;
+    };
+};
+export default _default;