elrh-cosca 0.3.5 → 0.4.0

package/dist/types/index.d.ts

@@ -1,2 +1,2 @@
-export * from './main'
+export * from './src/main.js'
 export {}

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

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

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

@@ -0,0 +1,6 @@
+/**
+ * Checks what package manager/runtime was used to execute the current command.
+ *
+ * @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

@@ -0,0 +1,11 @@
+import { HasJsonKeyOptions } from '../types/functions.js';
+/**
+ * Checks if a JSON file contains specified key.
+ *
+ * @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(opts: HasJsonKeyOptions): boolean;

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

@@ -0,0 +1,12 @@
+import { HasTextOptions } from '../types/functions.js';
+/**
+ * Checks if a text file contains specified text.
+ *
+ * @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(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

@@ -0,0 +1,10 @@
+import { PathExistsOptions } from '../types/functions.js';
+/**
+ * Checks if the specified path exists on FS. The search is limited 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.
+ */
+export declare function pathExists(opts: PathExistsOptions): boolean;

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

@@ -0,0 +1,13 @@
+import { CreateFileFromTemplateOptions } from '../types/functions.js';
+/**
+ * Creates a new file as a copy of a template file from an installed package.
+ *
+ * @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(opts: CreateFileFromTemplateOptions): Promise<void>;

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

@@ -0,0 +1,13 @@
+import { CreateFileFromWebTemplateOptions } from '../types/functions.js';
+/**
+ * Creates a new file as a copy of a template file downloaded from the web.
+ *
+ * @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(opts: CreateFileFromWebTemplateOptions): Promise<void>;

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

@@ -0,0 +1,12 @@
+import { DeletePathOptions } from '../types/functions.js';
+/**
+ * Deletes a file or a directory (recursively) from FS.
+ *
+ * @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(opts: DeletePathOptions): Promise<void>;

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

@@ -0,0 +1,13 @@
+import { RemoveFromJsonFileOptions } from '../types/functions.js';
+/**
+ * Updates a JSON file by deleting a specified key.
+ *
+ * @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(opts: RemoveFromJsonFileOptions): Promise<void>;

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

@@ -0,0 +1,13 @@
+import { RemoveFromTextFileOptions } from '../types/functions.js';
+/**
+ * Removes lines from a text file that include the given search text.
+ *
+ * @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(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

@@ -0,0 +1,20 @@
+import { UpdateConfigFileOptions } from '../types/functions.js';
+/**
+ * Updates the config object exported from a JS/TS config file.
+ *
+ * The function:
+ * - Reads and edits the file as code (no execution).
+ * - 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 {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(opts: UpdateConfigFileOptions): Promise<void>;

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

@@ -0,0 +1,15 @@
+import { UpdateJsonFileOptions } from '../types/functions.js';
+/**
+ * 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 {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(opts: UpdateJsonFileOptions): Promise<void>;

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

@@ -0,0 +1,15 @@
+import { UpdateTextFileOptions } from '../types/functions.js';
+/**
+ * Updates a text file by adding new rows.
+ *
+ * @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(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

@@ -0,0 +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 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

@@ -0,0 +1,11 @@
+import { PromptUserOptions } from '../types/functions.js';
+/**
+ * Prompts the user with a yes/no question (` (y/N): ` is appended) and returns their response.
+ *
+ * @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(opts: PromptUserOptions): Promise<boolean>;

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

@@ -0,0 +1,9 @@
+import { ShowErrorOptions } from '../types/functions.js';
+/**
+ * Prints error message into stderr with specified number of newlines after it.
+ *
+ * @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(opts: ShowErrorOptions): void;

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

@@ -0,0 +1,9 @@
+import { ShowMessageOptions } from '../types/functions.js';
+/**
+ * Prints message into stdout with specified number of newlines after it.
+ *
+ * @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(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

@@ -0,0 +1,10 @@
+import { GetEnvValueOptions } from '../types/functions.js';
+/**
+ * Retrieves the value of an environment variable from a .env file.
+ *
+ * @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(opts: GetEnvValueOptions): string | undefined;

package/dist/types/{utils → 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

@@ -0,0 +1,12 @@
+import { ResolvePackagePathOptions } from '../types/functions.js';
+/**
+ * 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 {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(opts: ResolvePackagePathOptions): string;

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

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

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

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

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

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

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

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

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

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

package/dist/types/test/cosca-test-setup.d.ts

@@ -0,0 +1 @@
+export default function (): Promise<() => void>;

package/dist/types/test/cosca-test-utils.d.ts

@@ -0,0 +1,45 @@
+import * as promptModule from '../src/terminal/prompt-user';
+/**
+ * Reads a (text) file into the string array.
+ * @param dir path to directory
+ * @param file name of the (text) file (must exist in `dir`)
+ * @returns array of read lines
+ */
+export declare function readNormalizedFile(dir: string, file: string): string;
+/**
+ * Mocks console logging methods in order to spy on the passed arguments.
+ * @param logLevel which console log method should be mocked
+ * @returns mocked console log method
+ */
+export declare function getConsoleSpy(logLevel: 'log' | 'debug' | 'info' | 'warn' | 'error'): import('vitest').MockInstance<((...data: any[]) => void) | ((...data: any[]) => void) | ((...data: any[]) => void) | ((...data: any[]) => void) | ((...data: any[]) => void)> & {
+    (...args: any[]): void;
+    new (...args: any[]): void;
+} & {};
+/**
+ * Mocks user input(s) for the `readline.question` method.
+ * @param input array of 1+ expected values from the user
+ * @returns mocked terminal input
+ */
+export declare function setPromptSpy(inputs: string[]): void;
+/**
+ * Mocks logging into stdout to spy on the passed arguments.
+ * @returns mocked stdout log method
+ */
+export declare function getStdoutSpy(): import('vitest').Mock<{
+    (buffer: Uint8Array | string, cb?: (err?: Error | null) => void): boolean;
+    (str: Uint8Array | string, encoding?: BufferEncoding, cb?: (err?: Error | null) => void): boolean;
+}>;
+/**
+ * Mocks logging into stderr to spy on the passed arguments.
+ * @returns mocked stderr log method
+ */
+export declare function getStderrSpy(): import('vitest').Mock<{
+    (buffer: Uint8Array | string, cb?: (err?: Error | null) => void): boolean;
+    (str: Uint8Array | string, encoding?: BufferEncoding, cb?: (err?: Error | null) => void): boolean;
+}>;
+/**
+ * Mocks call of the promptUser function to capture the displayed question.
+ * @param expectedResult how should the prompt being resolved (default: false)
+ * @returns mocked promptUser function
+ */
+export declare function getPromptUserSpy(expectedResult?: boolean): import('vitest').Mock<typeof promptModule.promptUser>;

package/dist/types/test/fixtures/config-file-default.d.ts

@@ -0,0 +1,10 @@
+declare const _default: {
+    stringKey: string;
+    numberKey: number;
+    boolKey: boolean;
+    arrayKey: string[];
+    objectKey: {
+        nestedKey: string;
+    };
+};
+export default _default;

package/dist/types/test/fixtures/config-file-named.d.ts

@@ -0,0 +1,9 @@
+export declare const config: {
+    stringKey: string;
+    numberKey: number;
+    boolKey: boolean;
+    arrayKey: string[];
+    objectKey: {
+        nestedKey: string;
+    };
+};

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

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

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

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

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

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

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

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

package/dist/types/test/functions-remove-from-text-file.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-config-file.test.d.ts

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

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

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

package/dist/types/test/functions-update-text-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-check-path.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;

package/dist/types/test/snapshots/updated-config-file-default-1.d.ts

@@ -0,0 +1,13 @@
+declare const _default: {
+    stringKey: string;
+    numberKey: number;
+    boolKey: boolean;
+    arrayKey: string[];
+    objectKey: {
+        nestedKey: string;
+    };
+    testKey1: string;
+    testKey2: number;
+    testKey3: boolean;
+};
+export default _default;

package/dist/types/test/snapshots/updated-config-file-default-2.d.ts

@@ -0,0 +1,14 @@
+declare const _default: {
+    stringKey: string;
+    numberKey: number;
+    boolKey: boolean;
+    arrayKey: string[];
+    objectKey: {
+        nestedKey: string;
+    };
+    testKey1: string;
+    testKey2: number;
+    testKey3: boolean;
+    testKey4: string;
+};
+export default _default;

package/dist/types/test/snapshots/updated-config-file-default-3.d.ts

@@ -0,0 +1,16 @@
+declare const _default: {
+    stringKey: string;
+    numberKey: number;
+    boolKey: boolean;
+    arrayKey: string[];
+    objectKey: {
+        nestedKey: string;
+    };
+    testKey1: string;
+    testKey2: number;
+    testKey3: boolean;
+    testKey4: {
+        nestedKey: string;
+    };
+};
+export default _default;