elrh-cosca 0.2.7 → 0.3.0

package/dist/types/_private/check-path.d.ts

@@ -0,0 +1,4 @@
+export declare function checkPath(path: string): {
+    valid: boolean;
+    error?: string;
+};

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

@@ -0,0 +1,10 @@
+/**
+ * Deletes given path from FS.
+ *
+ * @param {string} targetPath - The path to the JSON file to update (relative to CWD).
+ * @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 file does not exist or cannot be parsed as JSON.
+ */
+export declare function deletePath(targetPath: string, force?: boolean, prompt?: string): Promise<void>;

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

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

@@ -6,9 +6,9 @@
  * - Uses `defu(newConfig, existingConfig)` so `newConfig` takes precedence.
  * - Applies the merged result back onto the AST to preserve TS/ESM structure.
  *
- * @param {string} pathToFile - Path to file, relative to project root (process.cwd()).
+ * @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 if no config export is found or it cannot be processed.
  */
-export declare function updateConfigFile(pathToFile: string, newConfig: Record<string | number | symbol, any>, force?: boolean, prompt?: string): Promise<void>;
+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,12 +1,13 @@
+import { JsonValue } from '../types/json.js';
 /**
  * Updates a JSON file by modifying a specific key with new values.
  *
- * @param {string} pathToFile - The path to the JSON file to update (relative to CWD).
+ * @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 {Record<string | number | symbol, any>} newValues - The new values to set for the specified key.
+ * @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 file does not exist or cannot be parsed as JSON.
  */
-export declare function updateJsonFile(pathToFile: string, jsonKey: string, newValues: Record<string | number | symbol, any>, force?: boolean, prompt?: string): Promise<void>;
+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 +1,11 @@
 /**
  * Updates a text file by adding new rows.
  *
- * @param {string} pathToFile - The path to the text file to update (relative to CWD).
+ * @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 file does not exist.
  */
-export declare function updateTextFile(pathToFile: string, rowsToAdd: string[], force?: boolean, prompt?: string): Promise<void>;
+export declare function updateTextFile(targetFile: string, rowsToAdd: string[], force?: boolean, prompt?: string): Promise<void>;

package/dist/types/main.d.ts

@@ -1,5 +1,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 { updateConfigFile } from './functions/update-config-file';
 import { updateJsonFile } from './functions/update-json-file';
 import { updateTextFile } from './functions/update-text-file';
@@ -9,4 +11,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 { createFileFromTemplate, createFileFromWebTemplate, updateConfigFile, updateJsonFile, updateTextFile, promptUser, showError, showMessage, getEnvValue, parseQualifiedPath, resolvePackagePath, };
+export { createFileFromTemplate, createFileFromWebTemplate, deletePath, removeFromJsonFile, updateConfigFile, updateJsonFile, updateTextFile, promptUser, showError, showMessage, getEnvValue, parseQualifiedPath, resolvePackagePath, };

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "elrh-cosca",
-  "version": "0.2.7",
+  "version": "0.3.0",
   "type": "module",
   "files": [
     "dist"

package/test/cosca-test.js

@@ -4,7 +4,7 @@
 
 import {
   createFileFromTemplate, createFileFromWebTemplate, promptUser, showError, showMessage,
-  updateConfigFile, getEnvValue, updateJsonFile, updateTextFile
+  updateConfigFile, getEnvValue, updateJsonFile, updateTextFile, deletePath, removeFromJsonFile
 } from '../dist/elrh-cosca.mjs'
 
 async function main() {
@@ -37,9 +37,16 @@ async function main() {
 
   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) => {