elrh-cosca 0.3.3 → 0.3.4

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`
 
@@ -183,6 +183,14 @@ Checks whether given `row` exists in text file located at `targetFile`. Path is
 
 If the `row` is present, the function returns true, false otherwise. Row must be matched completely, but surrounding whitespaces are ignored.
 
+#### `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
 
 #### `promptUser`

package/dist/elrh-cosca.mjs

@@ -3,6 +3,20 @@ import { existsSync as be, readFileSync as tt, access as Ia, constants as Na, mk
 import Da from "node:readline";
 import Ma from "node:https";
 import "fs";
+function Fl() {
+  if (globalThis?.Deno)
+    return "deno";
+  if (globalThis?.Bun)
+    return "bun";
+  const a = process?.env?.npm_config_user_agent;
+  if (a) {
+    if (a.includes("pnpm")) return "pnpm";
+    if (a.includes("yarn")) return "yarn";
+    if (a.includes("bun")) return "bun";
+    if (a.includes("npm")) return "npm";
+  }
+  return "npm";
+}
 function _e(a) {
   if (!a)
     return { valid: !1, error: "Path cannot be empty" };
@@ -18,13 +32,6 @@ function _e(a) {
   const o = we(process.cwd(), a), u = we(process.cwd());
   return !o.startsWith(u + Ca) && o !== u ? { valid: !1, error: `Path outside of CWD not allowed: '${a}'` } : { valid: !0 };
 }
-function Fl(a) {
-  const l = _e(a);
-  if (!l.valid)
-    throw new Error(l.error);
-  const r = we(process.cwd(), a);
-  return be(r);
-}
 function Bl(a, l) {
   const r = _e(a);
   if (!r.valid)
@@ -62,6 +69,13 @@ function _l(a, l) {
     throw new Error(`No '${a}' found in project root — cannot check its contents.`);
   return tt(i, "utf8").split(/\r?\n/).map((h) => h.trim()).includes(l.trim());
 }
+function jl(a) {
+  const l = _e(a);
+  if (!l.valid)
+    throw new Error(l.error);
+  const r = we(process.cwd(), a);
+  return be(r);
+}
 async function Ve(a, l) {
   const r = Da.createInterface({
     input: l?.input || process.stdin,
@@ -108,7 +122,7 @@ function Ba(a) {
   }
   throw new Error(`Cannot find package "${a}" from ${process.cwd()}. Make sure it's installed or linked in this project.`);
 }
-async function jl(a, l, r = !1, i = "") {
+async function Rl(a, l, r = !1, i = "") {
   if (r || await Ve(
     i || `This will create '${l}' file. Continue?`
   )) {
@@ -144,7 +158,7 @@ async function _a(a) {
     }).on("error", r);
   });
 }
-async function Rl(a, l, r = !1, i = "") {
+async function Ul(a, l, r = !1, i = "") {
   if (r || await Ve(
     i || `This will create '${l}' file. Continue?`
   )) {
@@ -173,7 +187,7 @@ ${x}`);
   } else
     console.log(`Creation of '${l}' skipped.`);
 }
-async function Ul(a, l = !1, r = "") {
+async function $l(a, l = !1, r = "") {
   if (l || await Ve(
     r || `This will delete '${a}'. Continue?`
   )) {
@@ -191,7 +205,7 @@ async function Ul(a, l = !1, r = "") {
   } else
     console.log(`Removing '${a}' skipped.`);
 }
-async function $l(a, l, r = !1, i = "") {
+async function Vl(a, l, r = !1, i = "") {
   if (r || await Ve(
     i || `This will delete '${l}' from '${a}' file. Continue?`
   )) {
@@ -16463,7 +16477,7 @@ function ln(a, l) {
       i && !o ? ln(a[r], l[r]) : o ? a[r] = a[r] ? [.../* @__PURE__ */ new Set([...a[r], ...l[r]])] : l[r] : a[r] = l[r];
     }
 }
-async function Kl(a, l, r = !1, i = "") {
+async function Xl(a, l, r = !1, i = "") {
   if (r || await Ve(
     i || `This will update '${a}' file. Continue?`
   )) {
@@ -16497,7 +16511,7 @@ async function Kl(a, l, r = !1, i = "") {
   } else
     console.log(`Updating '${a}' skipped.`);
 }
-async function Xl(a, l, r, i = !1, o = "") {
+async function Gl(a, l, r, i = !1, o = "") {
   if (i || await Ve(
     o || `This will update '${a}' file. Continue?`
   )) {
@@ -16527,7 +16541,7 @@ ${A}`);
   } else
     console.log(`Updating '${a}' skipped.`);
 }
-async function Gl(a, l, r = !1, i = "") {
+async function Ql(a, l, r = !1, i = "") {
   if (r || await Ve(
     i || `This will update '${a}' file. Continue?`
   )) {
@@ -16547,19 +16561,19 @@ async function Gl(a, l, r = !1, i = "") {
   } else
     console.log(`Updating '${a}' skipped.`);
 }
-function Ql(a, l = 1) {
+function Yl(a, l = 1) {
   process.stderr.write(a);
   for (let r = 0; r < l; r++)
     process.stderr.write(`
 `);
 }
-function Yl(a, l = 1) {
+function Zl(a, l = 1) {
   process.stdout.write(a);
   for (let r = 0; r < l; r++)
     process.stdout.write(`
 `);
 }
-function Zl(a, l = we(process.cwd(), ".env")) {
+function ec(a, l = we(process.cwd(), ".env")) {
   if (!be(l))
     return;
   const r = tt(l, "utf-8");
@@ -16574,20 +16588,21 @@ function Zl(a, l = we(process.cwd(), ".env")) {
   }
 }
 export {
-  jl as createFileFromTemplate,
-  Rl as createFileFromWebTemplate,
-  Ul as deletePath,
-  Fl as fileExists,
-  Zl as getEnvValue,
+  Rl as createFileFromTemplate,
+  Ul as createFileFromWebTemplate,
+  $l as deletePath,
+  ec as getEnvValue,
+  Fl as getPackageManager,
   Bl as hasJsonKey,
   _l as hasText,
   Fa as parseQualifiedPath,
+  jl as pathExists,
   Ve as promptUser,
-  $l as removeFromJsonFile,
+  Vl as removeFromJsonFile,
   Ba as resolvePackagePath,
-  Ql as showError,
-  Yl as showMessage,
-  Kl as updateConfigFile,
-  Xl as updateJsonFile,
-  Gl as updateTextFile
+  Yl as showError,
+  Zl as showMessage,
+  Xl as updateConfigFile,
+  Gl as updateJsonFile,
+  Ql as updateTextFile
 };

package/dist/types/checks/get-package-manager.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Checks what package manager was used to execute the current command.
+ *
+ * @returns {string} The name of the package manager used ('npm', 'yarn', 'pnpm', 'deno' or 'bun').
+ */
+export declare function getPackageManager(): 'npm' | 'yarn' | 'pnpm' | 'deno' | 'bun';

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

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

package/dist/types/main.d.ts

@@ -1,6 +1,7 @@
-import { fileExists } from './checks/file-exists';
+import { getPackageManager } from './checks/get-package-manager';
 import { hasJsonKey } from './checks/has-json-key';
 import { hasText } from './checks/has-text';
+import { pathExists } from './checks/path-exists';
 import { createFileFromTemplate } from './functions/create-file-from-template';
 import { createFileFromWebTemplate } from './functions/create-file-from-web-template';
 import { deletePath } from './functions/delete-path';
@@ -14,4 +15,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 { fileExists, hasJsonKey, hasText, createFileFromTemplate, createFileFromWebTemplate, deletePath, removeFromJsonFile, updateConfigFile, updateJsonFile, updateTextFile, promptUser, showError, showMessage, getEnvValue, parseQualifiedPath, resolvePackagePath, };
+export { getPackageManager, hasJsonKey, hasText, pathExists, 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.3",
+  "version": "0.3.4",
   "type": "module",
   "files": [
     "dist"

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

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