elrh-cosca 0.3.4 → 0.3.6

package/dist/types/index.d.ts

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

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

@@ -0,0 +1,10 @@
+/**
+ * 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/src/functions/remove-from-text-file.d.ts

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

package/dist/types/{main.d.ts → src/main.d.ts}

@@ -6,6 +6,7 @@ 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 { updateConfigFile } from './functions/update-config-file';
 import { updateJsonFile } from './functions/update-json-file';
 import { updateTextFile } from './functions/update-text-file';
@@ -15,4 +16,4 @@ 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, };
+export { getPackageManager, hasJsonKey, hasText, pathExists, createFileFromTemplate, createFileFromWebTemplate, deletePath, removeFromJsonFile, removeFromTextFile, updateConfigFile, updateJsonFile, updateTextFile, promptUser, showError, showMessage, getEnvValue, parseQualifiedPath, resolvePackagePath, };

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-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-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/private-check-path.test.d.ts

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

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;

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,6 +1,6 @@
 {
   "name": "elrh-cosca",
-  "version": "0.3.4",
+  "version": "0.3.6",
   "type": "module",
   "files": [
     "dist"
@@ -18,12 +18,12 @@
   "module": "./dist/elrh-cosca.mjs",
   "types": "./dist/types/index.d.ts",
   "devDependencies": {
-    "@types/node": "^24.6.0",
-    "magicast": "^0.3.5",
+    "@types/node": "^25.9.0",
+    "magicast": "^0.5.3",
     "typescript": "^5.9.3",
-    "vite": "^7.1.8",
-    "vite-plugin-dts": "^4.5.4",
-    "vitest": "^3.2.4"
+    "vite": "^8.0.0",
+    "vite-plugin-dts": "^5.0.0",
+    "vitest": "^4.1.0"
   },
   "scripts": {
     "dev": "vite",

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('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)
+})

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

@@ -1,9 +0,0 @@
-/**
- * Checks if a text file contains specified row.
- *
- * @param {string} targetFile - The path to the text file to be checked (relative to CWD).
- * @param {string} row - The text row to be checked for existence.
- * @returns {boolean} True if the row exists in target file, false otherwise. Row must be matched completely, but surrounding whitespaces are ignored.
- * @throws Will throw an error if the path is invalid or the file does not exist.
- */
-export declare function hasText(targetFile: string, row: string): boolean;