@gesslar/toolkit 2.0.0 → 2.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gesslar/toolkit",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "A collection of utilities for Node.js and browser environments.",
   "main": "./src/index.js",
   "type": "module",

package/src/lib/FS.js

@@ -153,9 +153,8 @@ export default class FS {
     const to = path2.split(sep).filter(Boolean)
 
     // If they're the same, just return path1
-    if(to.length === from.length && from.every((f, i) => to[i] === f)) {
+    if(to.length === from.length && from.every((f, i) => to[i] === f))
       return path1
-    }
 
     const overlapIndex = from.findLastIndex(curr => curr === to.at(0))
 

package/src/lib/Util.js

@@ -1,7 +1,10 @@
 import {createHash} from "node:crypto"
 import {EventEmitter} from "node:events"
-import Sass from "./Sass.js"
 import {Util as BrowserUtil} from "../browser/index.js"
+import Sass from "./Sass.js"
+import process from "node:process"
+import JSON5 from "json5"
+import Valid from "./Valid.js"
 
 /**
  * Utility class providing common helper functions for string manipulation,
@@ -152,4 +155,45 @@ export default class Util extends BrowserUtil {
       )
     }
   }
+
+  /**
+   * Retrieves an environment variable and parses it as JSON5.
+   *
+   * This method fetches the value of the specified environment variable and
+   * attempts to parse it using JSON5. If the variable doesn't exist or is
+   * empty, the default value is returned. If parsing fails, an error is
+   * thrown.
+   *
+   * Example:
+   *   // export MY_CONFIG='{"debug": true, timeout: 5000}'
+   *   Util.getEnv("MY_CONFIG", {debug: false})
+   *   → {debug: true, timeout: 5000}
+   *
+   * Edge cases:
+   *   - If the environment variable doesn't exist, returns the default value
+   *   - If the value is an empty string, returns the default value
+   *   - If JSON5 parsing fails, throws a Sass error with context
+   *
+   * @param {string} ev - Name of the environment variable to retrieve
+   * @param {unknown} [def=undefined] - Default value if variable doesn't exist or is empty
+   * @returns {unknown} Parsed JSON5 value or default
+   * @throws {Sass} If JSON5 parsing fails
+   */
+  static getEnv(ev, def=undefined) {
+    Valid.type(ev, "String")
+
+    const value = process.env[ev]
+
+    if(!value)
+      return def
+
+    try {
+      return JSON5.parse(value)
+    } catch(error) {
+      throw Sass.new(
+        `Failed to parse environment variable '${ev}' as JSON5`,
+        error
+      )
+    }
+  }
 }

package/src/types/lib/FS.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FS.d.ts","sourceRoot":"","sources":["../../lib/FS.js"],"names":[],"mappings":"AAwBA;;GAEG;AACH;IACE,kCAAwB;IACxB,uCAAkC;IAClC,mBAAsB;IAEtB;;;;;;OAMG;IACH,4BAHW,MAAM,GACJ,MAAM,CAIlB;IAED;;;;;;OAMG;IACH,2BAHW,MAAM,GACJ,MAAM,CAUlB;IAED;;;;;;OAMG;IACH,2BAHW,MAAM,GACJ,MAAM,CAQlB;IAED;;;;;;;;OAQG;IACH,sBALW,MAAM,GAAC,KAAK,CAAC,MAAM,CAAC,GAClB,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAmCtC;IAED;;;;;;;;;;OAUG;IACH,oCAJW,UAAU,GAAC,eAAe,MAC1B,UAAU,GAAC,eAAe,GACxB,MAAM,CAYlB;IAED;;;;;;;;OAQG;IACH,oCALW,MAAM,SACN,MAAM,QACN,MAAM,GACJ,MAAM,CA2BlB;IAED;;;;;;;;OAQG;IACH,6BAJW,MAAM,UACN,MAAM,GACJ,MAAM,CAgClB;CACF;yBAzMa,OAAO,iBAAiB,EAAE,OAAO;8BACjC,OAAO,sBAAsB,EAAE,OAAO"}
+{"version":3,"file":"FS.d.ts","sourceRoot":"","sources":["../../lib/FS.js"],"names":[],"mappings":"AAwBA;;GAEG;AACH;IACE,kCAAwB;IACxB,uCAAkC;IAClC,mBAAsB;IAEtB;;;;;;OAMG;IACH,4BAHW,MAAM,GACJ,MAAM,CAIlB;IAED;;;;;;OAMG;IACH,2BAHW,MAAM,GACJ,MAAM,CAUlB;IAED;;;;;;OAMG;IACH,2BAHW,MAAM,GACJ,MAAM,CAQlB;IAED;;;;;;;;OAQG;IACH,sBALW,MAAM,GAAC,KAAK,CAAC,MAAM,CAAC,GAClB,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAmCtC;IAED;;;;;;;;;;OAUG;IACH,oCAJW,UAAU,GAAC,eAAe,MAC1B,UAAU,GAAC,eAAe,GACxB,MAAM,CAYlB;IAED;;;;;;;;OAQG;IACH,oCALW,MAAM,SACN,MAAM,QACN,MAAM,GACJ,MAAM,CA0BlB;IAED;;;;;;;;OAQG;IACH,6BAJW,MAAM,UACN,MAAM,GACJ,MAAM,CAgClB;CACF;yBAxMa,OAAO,iBAAiB,EAAE,OAAO;8BACjC,OAAO,sBAAsB,EAAE,OAAO"}

package/src/types/lib/Util.d.ts

@@ -71,6 +71,30 @@ export default class Util extends BrowserUtil {
      * @returns {Promise<void>} Resolves when all listeners have completed, but no grapes.
      */
     static asyncEmitQuack(emitter: object, event: string, ...args: unknown[]): Promise<void>;
+    /**
+     * Retrieves an environment variable and parses it as JSON5.
+     *
+     * This method fetches the value of the specified environment variable and
+     * attempts to parse it using JSON5. If the variable doesn't exist or is
+     * empty, the default value is returned. If parsing fails, an error is
+     * thrown.
+     *
+     * Example:
+     *   // export MY_CONFIG='{"debug": true, timeout: 5000}'
+     *   Util.getEnv("MY_CONFIG", {debug: false})
+     *   → {debug: true, timeout: 5000}
+     *
+     * Edge cases:
+     *   - If the environment variable doesn't exist, returns the default value
+     *   - If the value is an empty string, returns the default value
+     *   - If JSON5 parsing fails, throws a Sass error with context
+     *
+     * @param {string} ev - Name of the environment variable to retrieve
+     * @param {unknown} [def=undefined] - Default value if variable doesn't exist or is empty
+     * @returns {unknown} Parsed JSON5 value or default
+     * @throws {Sass} If JSON5 parsing fails
+     */
+    static getEnv(ev: string, def?: unknown): unknown;
 }
 import { Util as BrowserUtil } from "../browser/index.js";
 //# sourceMappingURL=Util.d.ts.map

package/src/types/lib/Util.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Util.d.ts","sourceRoot":"","sources":["../../lib/Util.js"],"names":[],"mappings":"AAKA;;;GAGG;AACH;IACE;;;;;OAKG;IACH,iBAHW,MAAM,GACJ,MAAM,CAIlB;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,mCAHW,MAAM,GACJ,KAAK,CAAC,MAAM,CAAC,CAazB;IAED;;;;;;;;OAQG;IACH,+CALW,MAAM,SACN,MAAM,WACH,OAAO,EAAA,GACR,OAAO,CAAC,IAAI,CAAC,CAmBzB;IAED;;;;;;;;;;;;OAYG;IACH,0BALW,YAAY,SACZ,MAAM,WACH,OAAO,EAAA,GACR,OAAO,CAAC,IAAI,CAAC,CAqBzB;IAED;;;;;;;;;;OAUG;IACH,+BALW,MAAM,SACN,MAAM,WACH,OAAO,EAAA,GACR,OAAO,CAAC,IAAI,CAAC,CAyBzB;CACF;oCAvJiC,qBAAqB"}
+{"version":3,"file":"Util.d.ts","sourceRoot":"","sources":["../../lib/Util.js"],"names":[],"mappings":"AAQA;;;GAGG;AACH;IACE;;;;;OAKG;IACH,iBAHW,MAAM,GACJ,MAAM,CAIlB;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,mCAHW,MAAM,GACJ,KAAK,CAAC,MAAM,CAAC,CAazB;IAED;;;;;;;;OAQG;IACH,+CALW,MAAM,SACN,MAAM,WACH,OAAO,EAAA,GACR,OAAO,CAAC,IAAI,CAAC,CAmBzB;IAED;;;;;;;;;;;;OAYG;IACH,0BALW,YAAY,SACZ,MAAM,WACH,OAAO,EAAA,GACR,OAAO,CAAC,IAAI,CAAC,CAqBzB;IAED;;;;;;;;;;OAUG;IACH,+BALW,MAAM,SACN,MAAM,WACH,OAAO,EAAA,GACR,OAAO,CAAC,IAAI,CAAC,CAyBzB;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,kBALW,MAAM,QACN,OAAO,GACL,OAAO,CAmBnB;CACF;oCApMiC,qBAAqB"}