@luxass/utils 2.4.1 → 2.5.0

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { isNotNull, isNotNullish, isNotUndefined, isTruthy } from "./guards-x9QZDUSt.js";
 import { clamp } from "./number-DzUC7V5F.js";
 import { getChangedKeys, getOwnProperty, hasOwnProperty, omit } from "./object-BT3S70pM.js";
-import { capitalize, dedent, dedentRaw, formatStr, sanitizeIdentifier, toCamelCase, toKebabCase, toPascalCase, toSnakeCase } from "./string-BjsgnDeW.js";
+import { appendTrailingSlash, capitalize, dedent, dedentRaw, formatStr, prependLeadingSlash, sanitizeIdentifier, toCamelCase, toKebabCase, toPascalCase, toSnakeCase, trimLeadingSlash, trimTrailingSlash } from "./string-DDSo2EBf.js";
 import { ElementOf, InferArguments, MaybeArray, MaybePromise, Nullable, Nullish, Prettify, RemoveIndexSignature } from "./types-DCrM3M9i.js";
 import pRetry from "p-retry";
 
@@ -21,4 +21,4 @@ declare class InvariantError extends Error {
  */
 declare function invariant(predicate: unknown, message: string, ...positionals: unknown[]): asserts predicate;
 //#endregion
-export { ElementOf, InferArguments, InvariantError, MaybeArray, MaybePromise, Nullable, Nullish, Prettify, RemoveIndexSignature, capitalize, clamp, dedent, dedentRaw, formatStr, getChangedKeys, getOwnProperty, hasOwnProperty, invariant, isNotNull, isNotNullish, isNotUndefined, isTruthy, omit, pRetry as promiseRetry, sanitizeIdentifier, toCamelCase, toKebabCase, toPascalCase, toSnakeCase };
+export { ElementOf, InferArguments, InvariantError, MaybeArray, MaybePromise, Nullable, Nullish, Prettify, RemoveIndexSignature, appendTrailingSlash, capitalize, clamp, dedent, dedentRaw, formatStr, getChangedKeys, getOwnProperty, hasOwnProperty, invariant, isNotNull, isNotNullish, isNotUndefined, isTruthy, omit, prependLeadingSlash, pRetry as promiseRetry, sanitizeIdentifier, toCamelCase, toKebabCase, toPascalCase, toSnakeCase, trimLeadingSlash, trimTrailingSlash };

package/dist/index.js

@@ -1,5 +1,5 @@
 import { isNotNull, isNotNullish, isNotUndefined, isTruthy } from "./guards-O1HGJraI.js";
-import { capitalize, dedent, dedentRaw, formatStr, sanitizeIdentifier, toCamelCase, toKebabCase, toPascalCase, toSnakeCase } from "./string-pQApOGKP.js";
+import { appendTrailingSlash, capitalize, dedent, dedentRaw, formatStr, prependLeadingSlash, sanitizeIdentifier, toCamelCase, toKebabCase, toPascalCase, toSnakeCase, trimLeadingSlash, trimTrailingSlash } from "./string-DCBui1sH.js";
 import { clamp } from "./number-BS9T5WGO.js";
 import { getChangedKeys, getOwnProperty, hasOwnProperty, omit } from "./object-CyGLe77G.js";
 
@@ -317,4 +317,4 @@ async function pRetry(input, options) {
 }
 
 //#endregion
-export { InvariantError, capitalize, clamp, dedent, dedentRaw, formatStr, getChangedKeys, getOwnProperty, hasOwnProperty, invariant, isNotNull, isNotNullish, isNotUndefined, isTruthy, omit, pRetry as promiseRetry, sanitizeIdentifier, toCamelCase, toKebabCase, toPascalCase, toSnakeCase };
+export { InvariantError, appendTrailingSlash, capitalize, clamp, dedent, dedentRaw, formatStr, getChangedKeys, getOwnProperty, hasOwnProperty, invariant, isNotNull, isNotNullish, isNotUndefined, isTruthy, omit, prependLeadingSlash, pRetry as promiseRetry, sanitizeIdentifier, toCamelCase, toKebabCase, toPascalCase, toSnakeCase, trimLeadingSlash, trimTrailingSlash };

package/dist/{string-pQApOGKP.js → string-DCBui1sH.js}

@@ -181,6 +181,80 @@ function formatStr(message, ...positionals) {
 	formattedMessage = formattedMessage.replace(/%{2}/g, "%");
 	return formattedMessage;
 }
+/**
+* Removes trailing slashes from a string
+* @param {string} str - The string to remove trailing slashes from
+* @returns {string} The string with trailing slashes removed
+*
+* @example
+* ```ts
+* import { trimTrailingSlash } from "@luxass/utils/string";
+*
+* trimTrailingSlash("path/to/file/") // "path/to/file"
+* trimTrailingSlash("path/to/file///") // "path/to/file"
+* trimTrailingSlash("path/to/file") // "path/to/file"
+* trimTrailingSlash("") // ""
+* ```
+*/
+function trimTrailingSlash(str) {
+	if (!str) return str;
+	return str.replace(/\/+$/, "");
+}
+/**
+* Removes leading slashes from a string
+* @param {string} str - The string to remove leading slashes from
+* @returns {string} The string with leading slashes removed
+*
+* @example
+* ```ts
+* import { trimLeadingSlash } from "@luxass/utils/string";
+*
+* trimLeadingSlash("/path/to/file") // "path/to/file"
+* trimLeadingSlash("///path/to/file") // "path/to/file"
+* trimLeadingSlash("path/to/file") // "path/to/file"
+* trimLeadingSlash("") // ""
+* ```
+*/
+function trimLeadingSlash(str) {
+	if (!str) return str;
+	return str.replace(/^\/+/, "");
+}
+/**
+* Ensures a string ends with a trailing slash
+* @param {string} str - The string to append a trailing slash to
+* @returns {string} The string with a trailing slash appended if not already present
+*
+* @example
+* ```ts
+* import { appendTrailingSlash } from "@luxass/utils/string";
+*
+* appendTrailingSlash("path/to/file") // "path/to/file/"
+* appendTrailingSlash("path/to/file/") // "path/to/file/"
+* appendTrailingSlash("") // ""
+* ```
+*/
+function appendTrailingSlash(str) {
+	if (!str) return str;
+	return str.endsWith("/") ? str : `${str}/`;
+}
+/**
+* Ensures a string starts with a leading slash
+* @param {string} str - The string to prepend a leading slash to
+* @returns {string} The string with a leading slash prepended if not already present
+*
+* @example
+* ```ts
+* import { prependLeadingSlash } from "@luxass/utils/string";
+*
+* prependLeadingSlash("path/to/file") // "/path/to/file"
+* prependLeadingSlash("/path/to/file") // "/path/to/file"
+* prependLeadingSlash("") // ""
+* ```
+*/
+function prependLeadingSlash(str) {
+	if (!str) return str;
+	return str.startsWith("/") ? str : `/${str}`;
+}
 
 //#endregion
-export { capitalize, dedent, dedentRaw, formatStr, sanitizeIdentifier, toCamelCase, toKebabCase, toPascalCase, toSnakeCase };
+export { appendTrailingSlash, capitalize, dedent, dedentRaw, formatStr, prependLeadingSlash, sanitizeIdentifier, toCamelCase, toKebabCase, toPascalCase, toSnakeCase, trimLeadingSlash, trimTrailingSlash };

package/dist/{string-BjsgnDeW.d.ts → string-DDSo2EBf.d.ts}

@@ -128,5 +128,67 @@ declare function sanitizeIdentifier(str: string): string;
  * ```
  */
 declare function formatStr(message: string, ...positionals: unknown[]): string;
+/**
+ * Removes trailing slashes from a string
+ * @param {string} str - The string to remove trailing slashes from
+ * @returns {string} The string with trailing slashes removed
+ *
+ * @example
+ * ```ts
+ * import { trimTrailingSlash } from "@luxass/utils/string";
+ *
+ * trimTrailingSlash("path/to/file/") // "path/to/file"
+ * trimTrailingSlash("path/to/file///") // "path/to/file"
+ * trimTrailingSlash("path/to/file") // "path/to/file"
+ * trimTrailingSlash("") // ""
+ * ```
+ */
+declare function trimTrailingSlash(str: string): string;
+/**
+ * Removes leading slashes from a string
+ * @param {string} str - The string to remove leading slashes from
+ * @returns {string} The string with leading slashes removed
+ *
+ * @example
+ * ```ts
+ * import { trimLeadingSlash } from "@luxass/utils/string";
+ *
+ * trimLeadingSlash("/path/to/file") // "path/to/file"
+ * trimLeadingSlash("///path/to/file") // "path/to/file"
+ * trimLeadingSlash("path/to/file") // "path/to/file"
+ * trimLeadingSlash("") // ""
+ * ```
+ */
+declare function trimLeadingSlash(str: string): string;
+/**
+ * Ensures a string ends with a trailing slash
+ * @param {string} str - The string to append a trailing slash to
+ * @returns {string} The string with a trailing slash appended if not already present
+ *
+ * @example
+ * ```ts
+ * import { appendTrailingSlash } from "@luxass/utils/string";
+ *
+ * appendTrailingSlash("path/to/file") // "path/to/file/"
+ * appendTrailingSlash("path/to/file/") // "path/to/file/"
+ * appendTrailingSlash("") // ""
+ * ```
+ */
+declare function appendTrailingSlash(str: string): string;
+/**
+ * Ensures a string starts with a leading slash
+ * @param {string} str - The string to prepend a leading slash to
+ * @returns {string} The string with a leading slash prepended if not already present
+ *
+ * @example
+ * ```ts
+ * import { prependLeadingSlash } from "@luxass/utils/string";
+ *
+ * prependLeadingSlash("path/to/file") // "/path/to/file"
+ * prependLeadingSlash("/path/to/file") // "/path/to/file"
+ * prependLeadingSlash("") // ""
+ * ```
+ */
+declare function prependLeadingSlash(str: string): string;
 //#endregion
-export { capitalize, dedent, dedentRaw, formatStr, sanitizeIdentifier, toCamelCase, toKebabCase, toPascalCase, toSnakeCase };
+export { appendTrailingSlash, capitalize, dedent, dedentRaw, formatStr, prependLeadingSlash, sanitizeIdentifier, toCamelCase, toKebabCase, toPascalCase, toSnakeCase, trimLeadingSlash, trimTrailingSlash };

package/dist/string.d.ts

@@ -1,2 +1,2 @@
-import { capitalize, dedent, dedentRaw, formatStr, sanitizeIdentifier, toCamelCase, toKebabCase, toPascalCase, toSnakeCase } from "./string-BjsgnDeW.js";
-export { capitalize, dedent, dedentRaw, formatStr, sanitizeIdentifier, toCamelCase, toKebabCase, toPascalCase, toSnakeCase };
+import { appendTrailingSlash, capitalize, dedent, dedentRaw, formatStr, prependLeadingSlash, sanitizeIdentifier, toCamelCase, toKebabCase, toPascalCase, toSnakeCase, trimLeadingSlash, trimTrailingSlash } from "./string-DDSo2EBf.js";
+export { appendTrailingSlash, capitalize, dedent, dedentRaw, formatStr, prependLeadingSlash, sanitizeIdentifier, toCamelCase, toKebabCase, toPascalCase, toSnakeCase, trimLeadingSlash, trimTrailingSlash };

package/dist/string.js

@@ -1,3 +1,3 @@
-import { capitalize, dedent, dedentRaw, formatStr, sanitizeIdentifier, toCamelCase, toKebabCase, toPascalCase, toSnakeCase } from "./string-pQApOGKP.js";
+import { appendTrailingSlash, capitalize, dedent, dedentRaw, formatStr, prependLeadingSlash, sanitizeIdentifier, toCamelCase, toKebabCase, toPascalCase, toSnakeCase, trimLeadingSlash, trimTrailingSlash } from "./string-DCBui1sH.js";
 
-export { capitalize, dedent, dedentRaw, formatStr, sanitizeIdentifier, toCamelCase, toKebabCase, toPascalCase, toSnakeCase };
+export { appendTrailingSlash, capitalize, dedent, dedentRaw, formatStr, prependLeadingSlash, sanitizeIdentifier, toCamelCase, toKebabCase, toPascalCase, toSnakeCase, trimLeadingSlash, trimTrailingSlash };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@luxass/utils",
-  "version": "2.4.1",
+  "version": "2.5.0",
   "description": "A collection of utilities for JavaScript/TypeScript",
   "type": "module",
   "author": {
@@ -40,10 +40,10 @@
     "node": ">=20"
   },
   "devDependencies": {
-    "@luxass/eslint-config": "^5.0.0",
+    "@luxass/eslint-config": "^5.1.0",
     "@types/node": "^22.15.2",
     "@vitest/coverage-v8": "3.2.4",
-    "eslint": "^9.30.0",
+    "eslint": "^9.30.1",
     "eslint-plugin-format": "^1.0.1",
     "p-retry": "^6.2.1",
     "publint": "^0.3.12",