elrh-cosca 0.3.5 → 0.4.0

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

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

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

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

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

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

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

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

package/dist/types/test/snapshots/updated-config-file-named-4.d.ts

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

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

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

package/dist/types/test/terninal-show-error.test.d.ts

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

package/dist/types/test/terninal-show-message.test.d.ts

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

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

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

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

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

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

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

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "elrh-cosca",
-  "version": "0.3.5",
+  "version": "0.4.0",
   "type": "module",
+  "sideEffects": false,
   "files": [
     "dist"
   ],
@@ -17,18 +18,21 @@
   },
   "module": "./dist/elrh-cosca.mjs",
   "types": "./dist/types/index.d.ts",
-  "devDependencies": {
-    "@types/node": "^24.9.0",
-    "magicast": "^0.5.0",
-    "typescript": "^5.9.3",
-    "vite": "^7.1.12",
-    "vite-plugin-dts": "^4.5.4",
-    "vitest": "^4.0.4"
-  },
   "scripts": {
     "dev": "vite",
     "build": "pnpm install && vitest run && tsc && vite build",
     "preview": "vite preview",
-    "test": "vitest run"
+    "prepublishOnly": "pnpm build",
+    "test": "vitest run --coverage"
+  },
+  "devDependencies": {
+    "@types/node": "^26.6.0",
+    "@vitest/coverage-v8": "^5.0.2",
+    "magicast": "^0.5.5",
+    "typescript": "^6.0.0",
+    "vite": "^8.0.0",
+    "vite-plugin-dts": "^5.0.0",
+    "vitest": "^5.0.2",
+    "yaml": "^2.9.1"
   }
-}
+}

package/test/cosca-test.js

@@ -1,55 +1,55 @@
-#!/usr/bin/env node
-
-// manual test script for COSCA functions
-
-import {
-  createFileFromTemplate, createFileFromWebTemplate, promptUser, showError, showMessage,
-  updateConfigFile, getEnvValue, updateJsonFile, updateTextFile, deletePath, removeFromJsonFile
-} from '../dist/elrh-cosca.mjs'
-
-async function main() {
-  console.log('Test showMessage')
-  showMessage('Hello!')
-  console.log('Test showMessage')
-  showError('ERROR!')
-
-  console.log('Test getEnvValue')
-  const a = getEnvValue('A')
-  const b = getEnvValue('B')
-  const c = getEnvValue('C')
-  const d = getEnvValue('D')
-  const e = getEnvValue('E')
-  console.log(a, b, c, d, e)
-
-  console.log('Test promptUser')
-  const input = await promptUser('Is it today?')
-  console.log('User input:', input)
-
-  console.log('\nTest createFileFromTemplate')
-  await createFileFromTemplate('vitest:README.md', 'test/snapshots/test.file1')
-  await createFileFromTemplate('elrh-cosca:test/fixtures/text-file.txt', 'test/snapshots/test.file2')
-  
-  console.log('\nTest createFileFromWebTemplate')
-  await createFileFromWebTemplate('https://raw.githubusercontent.com/AloisSeckar/nuxt-spec/refs/heads/main/config/vitest.config.ts.template', 'test/snapshots/test.file3')
-
-  console.log('\nTest updateConfigFile')
-  await updateConfigFile('test/fixtures/config-file-default.ts', { compatibilityDate: '2025-08-26', extends: ['nuxt-iignis'], cosca: { exists: true, data: ['some', 'other'], raw: 'war' } })
-
-  console.log('\nTest updateJsonFile')
-  await updateJsonFile('test/fixtures/json-file.json', 'scripts', { 'cosca' : 'cosca' })
-  await updateJsonFile('test/fixtures/json-file.json', 'packageManager', 'pnpm' )
-
-  console.log('\nTest removeFromJsonFile')
-  await removeFromJsonFile('test/fixtures/json-file.json', 'cosca')
-
-  console.log('\nTest updateTextFile')
-  await updateTextFile('test/fixtures/text-file.txt', ['# COSCA'])
-
-  console.log('\nTest deletePath')
-  await deletePath('test/snapshots/test.file1')
-}
-
-main().catch((err) => {
-  console.error(err)
-  process.exit(1)
-})
+#!/usr/bin/env node
+
+// manual test script for COSCA functions
+
+import {
+  createFileFromTemplate, createFileFromWebTemplate, promptUser, showError, showMessage,
+  updateConfigFile, getEnvValue, updateJsonFile, updateTextFile, deletePath, removeFromJsonFile
+} from '../dist/elrh-cosca.mjs'
+
+async function main() {
+  console.log('Test showMessage')
+  showMessage({ message: 'Hello!' })
+  console.log('Test showMessage')
+  showError({ message: 'ERROR!' })
+
+  console.log('Test getEnvValue')
+  const a = getEnvValue({ key: 'A' })
+  const b = getEnvValue({ key: 'B' })
+  const c = getEnvValue({ key: 'C' })
+  const d = getEnvValue({ key: 'D' })
+  const e = getEnvValue({ key: 'E' })
+  console.log(a, b, c, d, e)
+
+  console.log('Test promptUser')
+  const input = await promptUser({ question: 'Is it today?' })
+  console.log('User input:', input)
+
+  console.log('\nTest createFileFromTemplate')
+  await createFileFromTemplate({ templateFile: 'vitest:README.md', targetFile: 'test/snapshots/test.file1' })
+  await createFileFromTemplate({ templateFile: 'elrh-cosca:test/fixtures/text-file.txt', targetFile: 'test/snapshots/test.file2' })
+  
+  console.log('\nTest createFileFromWebTemplate')
+  await createFileFromWebTemplate({ url: 'https://raw.githubusercontent.com/AloisSeckar/nuxt-spec/refs/heads/main/config/vitest.config.ts.template', targetFile: 'test/snapshots/test.file3' })
+
+  console.log('\nTest updateConfigFile')
+  await updateConfigFile({ targetFile: 'test/fixtures/config-file-default.ts', newConfig: { compatibilityDate: '2025-08-26', extends: ['nuxt-iignis'], cosca: { exists: true, data: ['some', 'other'], raw: 'war' } } })
+
+  console.log('\nTest updateJsonFile')
+  await updateJsonFile({ targetFile: 'test/fixtures/json-file.json', jsonKey: 'scripts', patch: { 'cosca' : 'cosca' } })
+  await updateJsonFile({ targetFile: 'test/fixtures/json-file.json', jsonKey: 'packageManager', patch: 'pnpm' })
+
+  console.log('\nTest removeFromJsonFile')
+  await removeFromJsonFile({ targetFile: 'test/fixtures/json-file.json', jsonKey: 'cosca' })
+
+  console.log('\nTest updateTextFile')
+  await updateTextFile({ targetFile: 'test/fixtures/text-file.txt', rowsToAdd: ['# COSCA'] })
+
+  console.log('\nTest deletePath')
+  await deletePath({ targetPath: 'test/snapshots/test.file1' })
+}
+
+main().catch((err) => {
+  console.error(err)
+  process.exit(1)
+})

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

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

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

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

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

@@ -1,9 +0,0 @@
-/**
- * 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).
- * @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;

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

@@ -1,10 +0,0 @@
-/**
- * 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).
- * @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;

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

@@ -1,8 +0,0 @@
-/**
- * Checks if the specified path exists on FS.
- *
- * @param {string} targetPath - The path on FS 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).
- */
-export declare function pathExists(targetPath: string): boolean;

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

@@ -1,11 +0,0 @@
-/**
- * Creates a new copy of given file from a local template.
- *
- * @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.
- */
-export declare function createFileFromTemplate(templateFile: string, targetFile: string, force?: boolean, prompt?: string): Promise<void>;

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

@@ -1,11 +0,0 @@
-/**
- * Creates a new copy of given file from a web template.
- *
- * @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.
- */
-export declare function createFileFromWebTemplate(url: string, targetFile: string, force?: boolean, prompt?: string): Promise<void>;

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

@@ -1,10 +0,0 @@
-/**
- * Deletes given path 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.
- */
-export declare function deletePath(targetPath: string, force?: boolean, prompt?: string): Promise<void>;

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

@@ -1,11 +0,0 @@
-/**
- * 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.
- * @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>;

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

@@ -1,14 +0,0 @@
-/**
- * Update the single object-literal config found in a file.
- *
- * The function:
- * - Reads and edits the file as code (no execution).
- * - Uses `defu(newConfig, existingConfig)` so `newConfig` takes precedence.
- * - 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.
- */
-export declare function updateConfigFile(targetFile: string, newConfig: Record<string | number | symbol, any>, force?: boolean, prompt?: string): Promise<void>;

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

@@ -1,13 +0,0 @@
-import { JsonValue } from '../types/json.js';
-/**
- * Updates a JSON file by modifying a specific key with new values.
- *
- * @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.
- */
-export declare function updateJsonFile(targetFile: string, jsonKey: string, patch: JsonValue, force?: boolean, prompt?: string): Promise<void>;

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

@@ -1,11 +0,0 @@
-/**
- * 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.
- */
-export declare function updateTextFile(targetFile: string, rowsToAdd: string[], force?: boolean, prompt?: string): Promise<void>;

package/dist/types/main.d.ts

@@ -1,18 +0,0 @@
-import { getPackageManager } from './checks/get-package-manager';
-import { hasJsonKey } from './checks/has-json-key';
-import { hasText } from './checks/has-text';
-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 { updateConfigFile } from './functions/update-config-file';
-import { updateJsonFile } from './functions/update-json-file';
-import { updateTextFile } from './functions/update-text-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, updateConfigFile, updateJsonFile, updateTextFile, promptUser, showError, showMessage, getEnvValue, parseQualifiedPath, resolvePackagePath, };

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

@@ -1,11 +0,0 @@
-/**
- * Prompts the user with a question 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
- */
-export declare function promptUser(question: string, options?: {
-    input?: NodeJS.ReadableStream;
-    output?: NodeJS.WritableStream;
-}): Promise<boolean>;

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

@@ -1,7 +0,0 @@
-/**
- * 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).
- */
-export declare function showError(message: string, linesAfter?: number): void;

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

@@ -1,7 +0,0 @@
-/**
- * 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).
- */
-export declare function showMessage(message: string, linesAfter?: number): void;

package/dist/types/types/json.d.ts

@@ -1,6 +0,0 @@
-export type JsonPrimitive = string | number | boolean | null;
-export type JsonObject = {
-    [key: string]: JsonValue;
-};
-export type JsonArray = JsonValue[];
-export type JsonValue = JsonPrimitive | JsonObject | JsonArray;

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

@@ -1,8 +0,0 @@
-/**
- * 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.
- */
-export declare function getEnvValue(key: string, envFilePath?: string): string | undefined;

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

@@ -1,10 +0,0 @@
-/**
- * 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.
- *
- * @param {string} 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;