@luxass/utils 1.4.0 → 1.6.0

package/dist/index.cjs

@@ -1,6 +1,6 @@
 const require_guards = require('./guards-DE5pQVvl.cjs');
 const require_number = require('./number-DRbo8lb6.cjs');
-const require_string = require('./string-CkqQ4Tys.cjs');
+const require_string = require('./string-CxNDb3Ui.cjs');
 
 exports.capitalize = require_string.capitalize
 exports.clamp = require_number.clamp

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import { isNotNull, isNotNullish, isNotUndefined, isTruthy } from "./guards.d-DXUlpL_S.cjs";
 import { clamp } from "./number.d-C1FAMQlq.cjs";
-import { capitalize, dedent, toCamelCase, toKebabCase, toPascalCase, toSnakeCase } from "./string.d-DbrXP95T.cjs";
+import { capitalize, dedent, toCamelCase, toKebabCase, toPascalCase, toSnakeCase } from "./string.d-Dm-Z_ZP2.cjs";
 import { Arrayable, Awaitable, ElementOf, InferArguments, Nullable, Nullish } from "./types.d-fcYBBT6c.cjs";
 export { Arrayable, Awaitable, ElementOf, InferArguments, Nullable, Nullish, capitalize, clamp, dedent, isNotNull, isNotNullish, isNotUndefined, isTruthy, toCamelCase, toKebabCase, toPascalCase, toSnakeCase };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { isNotNull$1 as isNotNull, isNotNullish$1 as isNotNullish, isNotUndefined$1 as isNotUndefined, isTruthy$1 as isTruthy } from "./guards.d-n1BzCANy.js";
 import { clamp$1 as clamp } from "./number.d-C2Xuq3Is.js";
-import { capitalize$1 as capitalize, dedent$1 as dedent, toCamelCase$1 as toCamelCase, toKebabCase$1 as toKebabCase, toPascalCase$1 as toPascalCase, toSnakeCase$1 as toSnakeCase } from "./string.d-Dv6EVJz4.js";
+import { capitalize$1 as capitalize, dedent$1 as dedent, toCamelCase$1 as toCamelCase, toKebabCase$1 as toKebabCase, toPascalCase$1 as toPascalCase, toSnakeCase$1 as toSnakeCase } from "./string.d-BSY3kSBV.js";
 import { Arrayable, Awaitable, ElementOf, InferArguments, Nullable, Nullish } from "./types.d-BcKIY6l3.js";
 export { Arrayable, Awaitable, ElementOf, InferArguments, Nullable, Nullish, capitalize, clamp, dedent, isNotNull, isNotNullish, isNotUndefined, isTruthy, toCamelCase, toKebabCase, toPascalCase, toSnakeCase };

package/dist/index.js

@@ -1,5 +1,5 @@
 import { isNotNull, isNotNullish, isNotUndefined, isTruthy } from "./guards-O1HGJraI.js";
 import { clamp } from "./number-Bfr1z0Nr.js";
-import { capitalize, dedent, toCamelCase, toKebabCase, toPascalCase, toSnakeCase } from "./string-C8IOUSBw.js";
+import { capitalize, dedent, toCamelCase, toKebabCase, toPascalCase, toSnakeCase } from "./string-bY1lSRQs.js";
 
 export { capitalize, clamp, dedent, isNotNull, isNotNullish, isNotUndefined, isTruthy, toCamelCase, toKebabCase, toPascalCase, toSnakeCase };

package/dist/{string-CkqQ4Tys.cjs → string-CxNDb3Ui.cjs}

@@ -96,10 +96,18 @@ function toSnakeCase(str) {
 	return str.trim().replace(/-/g, "_").replace(/\s+/g, " ").replace(/([A-Z]+)([A-Z][a-z])/g, "$1_$2").replace(/([a-z0-9])([A-Z])/g, "$1_$2").replace(/\s+/g, "_").replace(/_+/g, "_").toLowerCase();
 }
 function dedent(strings, ...values) {
-	const raw = typeof strings === "string" ? [strings] : strings.raw;
+	return internal_dedent(strings, values, false);
+}
+dedent.raw = dedentRaw;
+function dedentRaw(strings, ...values) {
+	return internal_dedent(strings, values, true);
+}
+/** @internal */
+function internal_dedent(strings, values, raw = false) {
+	const _raw = typeof strings === "string" ? [strings] : raw ? strings.raw : strings;
 	let result = "";
-	for (let i = 0; i < raw.length; i++) {
-		const next = raw[i];
+	for (let i = 0; i < _raw.length; i++) {
+		const next = _raw[i];
 		result += next;
 		if (i < values.length) result += values[i];
 	}
@@ -114,6 +122,22 @@ function dedent(strings, ...values) {
 	const lastNonWhitespaceLine = whitespaceLines.lastIndexOf(false);
 	return lines.slice(firstNonWhitespaceLine >= 0 ? firstNonWhitespaceLine : 0, lastNonWhitespaceLine >= 0 ? lastNonWhitespaceLine + 1 : lines.length).map((line) => line.slice(commonIndent)).join("\n");
 }
+/**
+* Ensures a string is a valid JavaScript identifier by prefixing with an underscore if necessary
+* @param {string} str - The string to sanitize
+* @returns {string} A valid JavaScript identifier
+* @example
+* ```ts
+* sanitizeIdentifier("validName") // "validName"
+* sanitizeIdentifier("123invalid") // "_123invalid"
+* sanitizeIdentifier("$valid") // "$valid"
+* sanitizeIdentifier("_valid") // "_valid"
+* ```
+*/
+function sanitizeIdentifier(str) {
+	const cleaned = str.replace(/[^\w$]/g, "");
+	return /^[A-Z_$]/i.test(cleaned) ? cleaned : `_${cleaned}`;
+}
 
 //#endregion
 Object.defineProperty(exports, 'capitalize', {
@@ -128,6 +152,18 @@ Object.defineProperty(exports, 'dedent', {
     return dedent;
   }
 });
+Object.defineProperty(exports, 'dedentRaw', {
+  enumerable: true,
+  get: function () {
+    return dedentRaw;
+  }
+});
+Object.defineProperty(exports, 'sanitizeIdentifier', {
+  enumerable: true,
+  get: function () {
+    return sanitizeIdentifier;
+  }
+});
 Object.defineProperty(exports, 'toCamelCase', {
   enumerable: true,
   get: function () {

package/dist/{string-C8IOUSBw.js → string-bY1lSRQs.js}

@@ -94,10 +94,18 @@ function toSnakeCase(str) {
 	return str.trim().replace(/-/g, "_").replace(/\s+/g, " ").replace(/([A-Z]+)([A-Z][a-z])/g, "$1_$2").replace(/([a-z0-9])([A-Z])/g, "$1_$2").replace(/\s+/g, "_").replace(/_+/g, "_").toLowerCase();
 }
 function dedent(strings, ...values) {
-	const raw = typeof strings === "string" ? [strings] : strings.raw;
+	return internal_dedent(strings, values, false);
+}
+dedent.raw = dedentRaw;
+function dedentRaw(strings, ...values) {
+	return internal_dedent(strings, values, true);
+}
+/** @internal */
+function internal_dedent(strings, values, raw = false) {
+	const _raw = typeof strings === "string" ? [strings] : raw ? strings.raw : strings;
 	let result = "";
-	for (let i = 0; i < raw.length; i++) {
-		const next = raw[i];
+	for (let i = 0; i < _raw.length; i++) {
+		const next = _raw[i];
 		result += next;
 		if (i < values.length) result += values[i];
 	}
@@ -112,6 +120,22 @@ function dedent(strings, ...values) {
 	const lastNonWhitespaceLine = whitespaceLines.lastIndexOf(false);
 	return lines.slice(firstNonWhitespaceLine >= 0 ? firstNonWhitespaceLine : 0, lastNonWhitespaceLine >= 0 ? lastNonWhitespaceLine + 1 : lines.length).map((line) => line.slice(commonIndent)).join("\n");
 }
+/**
+* Ensures a string is a valid JavaScript identifier by prefixing with an underscore if necessary
+* @param {string} str - The string to sanitize
+* @returns {string} A valid JavaScript identifier
+* @example
+* ```ts
+* sanitizeIdentifier("validName") // "validName"
+* sanitizeIdentifier("123invalid") // "_123invalid"
+* sanitizeIdentifier("$valid") // "$valid"
+* sanitizeIdentifier("_valid") // "_valid"
+* ```
+*/
+function sanitizeIdentifier(str) {
+	const cleaned = str.replace(/[^\w$]/g, "");
+	return /^[A-Z_$]/i.test(cleaned) ? cleaned : `_${cleaned}`;
+}
 
 //#endregion
-export { capitalize, dedent, toCamelCase, toKebabCase, toPascalCase, toSnakeCase };
+export { capitalize, dedent, dedentRaw, sanitizeIdentifier, toCamelCase, toKebabCase, toPascalCase, toSnakeCase };

package/dist/string.cjs

@@ -1,7 +1,9 @@
-const require_string = require('./string-CkqQ4Tys.cjs');
+const require_string = require('./string-CxNDb3Ui.cjs');
 
 exports.capitalize = require_string.capitalize
 exports.dedent = require_string.dedent
+exports.dedentRaw = require_string.dedentRaw
+exports.sanitizeIdentifier = require_string.sanitizeIdentifier
 exports.toCamelCase = require_string.toCamelCase
 exports.toKebabCase = require_string.toKebabCase
 exports.toPascalCase = require_string.toPascalCase

package/dist/{string.d-Dv6EVJz4.d.ts → string.d-BSY3kSBV.d.ts}

@@ -76,15 +76,44 @@ declare function toSnakeCase(str: string): string;
 * @param {TemplateStringsArray | string} literals - The string to dedent
 * @returns {string} The dedented string
 * @example ```ts
-dedent`
-This is a test.
-This is another line.
-`
-// "This is a test.\nThis is another line."
-```
+* dedent`
+*   This is a test.
+*   This is another line.
+* `
+* // "This is a test.\nThis is another line."
+* ```
 */
 declare function dedent(literals: string): string;
 declare function dedent(strings: TemplateStringsArray, ...values: unknown[]): string;
+declare namespace dedent {
+  var raw: typeof dedentRaw;
+} /**
+  * Removes leading and trailing whitespace from each line of a string
+  * @param {TemplateStringsArray | string} literals - The string to dedent
+  * @returns {string} The dedented string
+  * @example ```ts
+  * dedent`
+  *   This is a test.
+  *   This is another line.
+  * `
+  * // "This is a test.\nThis is another line."
+  * ```
+  */
+
+declare function dedentRaw(literals: string): string;
+declare function dedentRaw(strings: TemplateStringsArray, ...values: unknown[]): string; /**
+                                                                                         * Ensures a string is a valid JavaScript identifier by prefixing with an underscore if necessary
+                                                                                         * @param {string} str - The string to sanitize
+                                                                                         * @returns {string} A valid JavaScript identifier
+                                                                                         * @example
+                                                                                         * ```ts
+                                                                                         * sanitizeIdentifier("validName") // "validName"
+                                                                                         * sanitizeIdentifier("123invalid") // "_123invalid"
+                                                                                         * sanitizeIdentifier("$valid") // "$valid"
+                                                                                         * sanitizeIdentifier("_valid") // "_valid"
+                                                                                         * ```
+                                                                                         */
 
+declare function sanitizeIdentifier(str: string): string;
 //#endregion
-export { capitalize as capitalize$1, dedent as dedent$1, toCamelCase as toCamelCase$1, toKebabCase as toKebabCase$1, toPascalCase as toPascalCase$1, toSnakeCase as toSnakeCase$1 };
+export { capitalize as capitalize$1, dedent as dedent$1, dedentRaw as dedentRaw$1, sanitizeIdentifier as sanitizeIdentifier$1, toCamelCase as toCamelCase$1, toKebabCase as toKebabCase$1, toPascalCase as toPascalCase$1, toSnakeCase as toSnakeCase$1 };

package/dist/{string.d-DbrXP95T.d.cts → string.d-Dm-Z_ZP2.d.cts}

@@ -76,15 +76,44 @@ declare function toSnakeCase(str: string): string;
 * @param {TemplateStringsArray | string} literals - The string to dedent
 * @returns {string} The dedented string
 * @example ```ts
-dedent`
-This is a test.
-This is another line.
-`
-// "This is a test.\nThis is another line."
-```
+* dedent`
+*   This is a test.
+*   This is another line.
+* `
+* // "This is a test.\nThis is another line."
+* ```
 */
 declare function dedent(literals: string): string;
 declare function dedent(strings: TemplateStringsArray, ...values: unknown[]): string;
+declare namespace dedent {
+  var raw: typeof dedentRaw;
+} /**
+  * Removes leading and trailing whitespace from each line of a string
+  * @param {TemplateStringsArray | string} literals - The string to dedent
+  * @returns {string} The dedented string
+  * @example ```ts
+  * dedent`
+  *   This is a test.
+  *   This is another line.
+  * `
+  * // "This is a test.\nThis is another line."
+  * ```
+  */
+
+declare function dedentRaw(literals: string): string;
+declare function dedentRaw(strings: TemplateStringsArray, ...values: unknown[]): string; /**
+                                                                                         * Ensures a string is a valid JavaScript identifier by prefixing with an underscore if necessary
+                                                                                         * @param {string} str - The string to sanitize
+                                                                                         * @returns {string} A valid JavaScript identifier
+                                                                                         * @example
+                                                                                         * ```ts
+                                                                                         * sanitizeIdentifier("validName") // "validName"
+                                                                                         * sanitizeIdentifier("123invalid") // "_123invalid"
+                                                                                         * sanitizeIdentifier("$valid") // "$valid"
+                                                                                         * sanitizeIdentifier("_valid") // "_valid"
+                                                                                         * ```
+                                                                                         */
 
+declare function sanitizeIdentifier(str: string): string;
 //#endregion
-export { capitalize, dedent, toCamelCase, toKebabCase, toPascalCase, toSnakeCase };
+export { capitalize, dedent, dedentRaw, sanitizeIdentifier, toCamelCase, toKebabCase, toPascalCase, toSnakeCase };

package/dist/string.d.cts

@@ -1,2 +1,2 @@
-import { capitalize, dedent, toCamelCase, toKebabCase, toPascalCase, toSnakeCase } from "./string.d-DbrXP95T.cjs";
-export { capitalize, dedent, toCamelCase, toKebabCase, toPascalCase, toSnakeCase };
+import { capitalize, dedent, dedentRaw, sanitizeIdentifier, toCamelCase, toKebabCase, toPascalCase, toSnakeCase } from "./string.d-Dm-Z_ZP2.cjs";
+export { capitalize, dedent, dedentRaw, sanitizeIdentifier, toCamelCase, toKebabCase, toPascalCase, toSnakeCase };

package/dist/string.d.ts

@@ -1,2 +1,2 @@
-import { capitalize$1 as capitalize, dedent$1 as dedent, toCamelCase$1 as toCamelCase, toKebabCase$1 as toKebabCase, toPascalCase$1 as toPascalCase, toSnakeCase$1 as toSnakeCase } from "./string.d-Dv6EVJz4.js";
-export { capitalize, dedent, toCamelCase, toKebabCase, toPascalCase, toSnakeCase };
+import { capitalize$1 as capitalize, dedent$1 as dedent, dedentRaw$1 as dedentRaw, sanitizeIdentifier$1 as sanitizeIdentifier, toCamelCase$1 as toCamelCase, toKebabCase$1 as toKebabCase, toPascalCase$1 as toPascalCase, toSnakeCase$1 as toSnakeCase } from "./string.d-BSY3kSBV.js";
+export { capitalize, dedent, dedentRaw, sanitizeIdentifier, toCamelCase, toKebabCase, toPascalCase, toSnakeCase };

package/dist/string.js

@@ -1,3 +1,3 @@
-import { capitalize, dedent, toCamelCase, toKebabCase, toPascalCase, toSnakeCase } from "./string-C8IOUSBw.js";
+import { capitalize, dedent, dedentRaw, sanitizeIdentifier, toCamelCase, toKebabCase, toPascalCase, toSnakeCase } from "./string-bY1lSRQs.js";
 
-export { capitalize, dedent, toCamelCase, toKebabCase, toPascalCase, toSnakeCase };
+export { capitalize, dedent, dedentRaw, sanitizeIdentifier, toCamelCase, toKebabCase, toPascalCase, toSnakeCase };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@luxass/utils",
-  "version": "1.4.0",
+  "version": "1.6.0",
   "description": "A collection of utilities for JavaScript/TypeScript",
   "type": "module",
   "author": {
@@ -76,6 +76,7 @@
   "devDependencies": {
     "@luxass/eslint-config": "^4.18.1",
     "@types/node": "^22.15.2",
+    "@vitest/coverage-v8": "3.1.2",
     "eslint": "^9.25.1",
     "eslint-plugin-format": "^1.0.1",
     "publint": "^0.3.12",