elrh-cosca 0.3.0 → 0.3.2

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

@@ -0,0 +1,8 @@
+/**
+ * Checks if the specified file exists on FS.
+ *
+ * @param {string} targetFile - The path to the text file to be checked (relative to CWD).
+ * @returns {boolean} True if the file exists, false otherwise.
+ * @throws Will throw an error if the path is invalid (can't traverse past CWD).
+ */
+export declare function fileExists(targetFile: string): boolean;

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

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

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

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

@@ -6,6 +6,6 @@
  * @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 template file cannot be found or the target file failed to be 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

@@ -6,6 +6,6 @@
  * @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 remote template cannot be fetched or the target file failed to be 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

@@ -5,6 +5,6 @@
  * @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.
+ * @throws Will throw an error if the path is invalid, 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

@@ -6,6 +6,6 @@
  * @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.
+ * @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

@@ -9,6 +9,6 @@
  * @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.
+ * @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

@@ -8,6 +8,6 @@ import { JsonValue } from '../types/json.js';
  * @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.
+ * @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

@@ -6,6 +6,6 @@
  * @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.
+ * @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,3 +1,6 @@
+import { fileExists } from './checks/file-exists';
+import { hasJsonKey } from './checks/has-json-key';
+import { hasText } from './checks/has-text';
 import { createFileFromTemplate } from './functions/create-file-from-template';
 import { createFileFromWebTemplate } from './functions/create-file-from-web-template';
 import { deletePath } from './functions/delete-path';
@@ -11,4 +14,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, deletePath, removeFromJsonFile, updateConfigFile, updateJsonFile, updateTextFile, promptUser, showError, showMessage, getEnvValue, parseQualifiedPath, resolvePackagePath, };
+export { fileExists, hasJsonKey, hasText, createFileFromTemplate, createFileFromWebTemplate, deletePath, removeFromJsonFile, updateConfigFile, updateJsonFile, updateTextFile, promptUser, showError, showMessage, getEnvValue, parseQualifiedPath, resolvePackagePath, };

package/package.json

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