elrh-cosca 0.3.3 → 0.3.5

package/README.md

@@ -147,17 +147,17 @@ By default the function asks for confirmation before attempting to delete the `t
 
 ### List of content checkers
 
-#### `fileExists`
+#### `pathExists`
 
 ```ts
-function fileExists(
-    targetFile: string
+function pathExists(
+    targetPath: string
 ): boolean
 ```
 
-Checks if the specified `targetFile` exists on FS. Path is resolved relatively 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.
+Checks if the specified `targetPath` exists on FS. Path is resolved relatively 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.
 
-If the file exists , the function returns true, false otherwise.
+If the path exists , the function returns true, false otherwise.
 
 #### `hasJsonKey`
 
@@ -175,13 +175,21 @@ Given `jsonKey` might point to a nested key using dot notation, e.g. `a.b.c`. If
 
 ```ts
 function hasText(
-    targetFile: string, row: string
+    targetFile: string, pattern: string | RegExp, exact: boolean = false
 ): boolean
 ```
 
-Checks whether given `row` exists in text file located at `targetFile`. Path is resolved relatively 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.
+Checks whether given `pattern` exists in text file located at `targetFile`. Path is resolved relatively 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.
 
-If the `row` is present, the function returns true, false otherwise. Row must be matched completely, but surrounding whitespaces are ignored.
+The `pattern` might be a plain string or a regular expression. If it is present, the function returns true, false otherwise. By default partial matches are allowed for string patterns. If you set optional `exact` parameter to true, the string must completely match at least one line in the file. However, surrounding whitespaces are trimmed in both cases.
+
+#### `getPackageManager`
+
+```ts
+function getPackageManager(): 'npm' | 'yarn' | 'pnpm' | 'deno' | 'bun'
+```
+
+Tries to detect the package manager used in the current environment by checking for specific global variables and user agent strings. Fallbacks to `npm` if common checks fail to detect otherwise.
 
 ### List of terminal helpers