elrh-cosca 0.3.2 → 0.3.3

package/README.md

@@ -1,5 +1,5 @@
 # COSCA
-Library of file-writting functions that help building CLI scripts for making changes in target projects - like adding default configuration files or new sections in `package.json`.
+Library of file-writing functions that help building CLI scripts for making changes in target projects - like adding default configuration files or new sections in `package.json`.
 
 The first experimental "customers" are my [Nuxt Spec](https://github.com/AloisSeckar/nuxt-spec) and [Nuxt Ignis](https://github.com/AloisSeckar/nuxt-ignis) projects.
 
@@ -27,12 +27,12 @@ Path to `templateFile` must be prefixed with the package name to allow proper re
 
 Path to `targetFile` is relative to `process.cwd()` which allows consumers to run `npx your-script` in their project roots during development.  Several checks are in place to prevent accidental and malicious paths being passed in. Path traversal outside of CWD or providing absolute paths is disallowed. If the target directory does not exist, it will be automatically created.
 
-By default the function asks for confirmation before attempting to create the file and if the file with the same name as `targetFile` is detected. Setting the last optional parameter `force` to `true` will suppress manual confirmation prompts. Passsing a custom `prompt` allows tailoring your own question to the user.
+By default the function asks for confirmation before attempting to create the file and if the file with the same name as `targetFile` is detected. Setting the last optional parameter `force` to `true` will suppress manual confirmation prompts. Passing a custom `prompt` allows tailoring your own question to the user.
 
 #### `createFileFromWebTemplate`
 
 ```ts
-async function createFileWebFromTemplate(
+async function createFileFromWebTemplate(
   url: string, targetFile: string, force: boolean = false, prompt: string = ''
 ): Promise<void>
 ```
@@ -43,7 +43,7 @@ Contents of `url` must be accessible via `node:https.get` function and will be f
 
 Path to `targetFile` is relative to `process.cwd()` which allows consumers to run `npx your-script` in their project roots during development.  Several checks are in place to prevent accidental and malicious paths being passed in. Path traversal outside of CWD or providing absolute paths is disallowed. If the target directory does not exist, it will be automatically created.
 
-By default the function asks for confirmation before attempting to create the file and if the file with the same name as `targetFile` is detected. Setting the last optional parameter `force` to `true` will suppress manual confirmation prompts. Passsing a custom `prompt` allows tailoring your own question to the user.
+By default the function asks for confirmation before attempting to create the file and if the file with the same name as `targetFile` is detected. Setting the last optional parameter `force` to `true` will suppress manual confirmation prompts. Passing a custom `prompt` allows tailoring your own question to the user.
 
 #### `updateConfigFile`
 
@@ -75,7 +75,7 @@ TypeError: 'set' on proxy: trap returned falsish for property '<YOUR_PROPERTY>'
 If possible, you need to alter your logic, e.g. by creating a new object via the spread operator.
 
 
-By default the function asks for confirmation before attempting to alter the `targetFile`. Setting the last optional parameter `force` to `true` will suppress manual confirmation prompts. Passsing a custom `prompt` allows tailoring your own question to the user.
+By default the function asks for confirmation before attempting to alter the `targetFile`. Setting the last optional parameter `force` to `true` will suppress manual confirmation prompts. Passing a custom `prompt` allows tailoring your own question to the user.
 
 #### `updateJsonFile`
 
@@ -99,7 +99,7 @@ Path to `targetFile` is relative to `process.cwd()`. Several checks are in place
 
 Currently it only allows adding new values under top-level keys. If the `jsonKey` exists, new values are merged into existing ones. Otherwise, new key is added. The function tracks if any real change was made and notifies the user if not.
 
-By default the function asks for confirmation before attempting to alter the `targetFile`. Setting the last optional parameter `force` to `true` will suppress manual confirmation prompts. Passsing a custom `prompt` allows tailoring your own question to the user.
+By default the function asks for confirmation before attempting to alter the `targetFile`. Setting the last optional parameter `force` to `true` will suppress manual confirmation prompts. Passing a custom `prompt` allows tailoring your own question to the user.
 
 #### `updateTextFile`
 
@@ -113,7 +113,7 @@ Takes a path to a plain text file and injects `rowsToAdd` at the end of the file
 
 Path to `targetFile` is relative to `process.cwd()`. Several checks are in place to prevent accidental and malicious paths being passed in. Path traversal outside of CWD or providing absolute paths is disallowed. 
 
-By default the function asks for confirmation before attempting to alter the `targetFile`. Setting the last optional parameter `force` to `true` will suppress manual confirmation prompts. Passsing a custom `prompt` allows tailoring your own question to the user.
+By default the function asks for confirmation before attempting to alter the `targetFile`. Setting the last optional parameter `force` to `true` will suppress manual confirmation prompts. Passing a custom `prompt` allows tailoring your own question to the user.
 
 #### `removeFromJsonFile`
 
@@ -129,7 +129,7 @@ Path to `targetFile` is relative to `process.cwd()`. Several checks are in place
 
 Given `jsonKey` might point to a nested key using dot notation, e.g. `a.b.c`. If the key is not present, the function does nothing.
 
-By default the function asks for confirmation before attempting to alter the `targetFile`. Setting the last optional parameter `force` to `true` will suppress manual confirmation prompts. Passsing a custom `prompt` allows tailoring your own question to the user.
+By default the function asks for confirmation before attempting to alter the `targetFile`. Setting the last optional parameter `force` to `true` will suppress manual confirmation prompts. Passing a custom `prompt` allows tailoring your own question to the user.
 
 #### `deletePath`
 
@@ -143,7 +143,7 @@ Deletes given `targetPath` from FS. Path is resolved relatively to `process.cwd(
 
 If the `targetPath` does not exist, the function does nothing.
 
-By default the function asks for confirmation before attempting to delete the `targetPath`. Setting the last optional parameter `force` to `true` will suppress manual confirmation prompts. Passsing a custom `prompt` allows tailoring your own question to the user.
+By default the function asks for confirmation before attempting to delete the `targetPath`. Setting the last optional parameter `force` to `true` will suppress manual confirmation prompts. Passing a custom `prompt` allows tailoring your own question to the user.
 
 ### List of content checkers
 

package/dist/elrh-cosca.mjs

@@ -4,7 +4,7 @@ import Da from "node:readline";
 import Ma from "node:https";
 import "fs";
 function _e(a) {
-  if (console.warn(a), !a)
+  if (!a)
     return { valid: !1, error: "Path cannot be empty" };
   if (/^[A-Za-z]:/.test(a) || a.startsWith("/"))
     return { valid: !1, error: `Path must be relative to CWD: '${a}'` };

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

@@ -1,10 +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} 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 file is updated.
- * @throws Will throw an error if the path is invalid, the file does not exist or cannot be parsed as JSON.
+ * @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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "elrh-cosca",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "type": "module",
   "files": [
     "dist"
@@ -18,10 +18,10 @@
   "module": "./dist/elrh-cosca.mjs",
   "types": "./dist/types/index.d.ts",
   "devDependencies": {
-    "@types/node": "^24.3.0",
+    "@types/node": "^24.6.0",
     "magicast": "^0.3.5",
-    "typescript": "^5.9.2",
-    "vite": "^7.1.3",
+    "typescript": "^5.9.3",
+    "vite": "^7.1.8",
     "vite-plugin-dts": "^4.5.4",
     "vitest": "^3.2.4"
   },