@alextheman/utility 4.0.0 → 4.1.0

package/dist/index.cjs

@@ -27,8 +27,8 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 //#endregion
 let zod = require("zod");
 zod = __toESM(zod);
-let path = require("path");
-path = __toESM(path);
+let node_path = require("node:path");
+node_path = __toESM(node_path);
 
 //#region src/constants/NAMESPACE_EXPORT_REGEX.ts
 const NAMESPACE_EXPORT_REGEX = "export\\s+\\*\\s+from";
@@ -795,11 +795,35 @@ var appendSemicolon_default = appendSemicolon;
 * Converts a string from camelCase to kebab-case
 *
 * @param string - The string to convert.
+* @param options - Options to apply to the conversion.
 *
 * @returns The string converted to kebab-case.
 */
-function camelToKebab(string) {
-	return string.replace(/([a-z0-9])([A-Z])/g, "$1-$2").replace(/([A-Z])([A-Z][a-z])/g, "$1-$2").toLowerCase();
+function camelToKebab(string, options = { preserveConsecutiveCapitals: true }) {
+	let result = "";
+	let outerIndex = 0;
+	while (outerIndex < string.length) {
+		const character = string[outerIndex];
+		if (/[A-Z]/.test(character)) {
+			let innerIndex = outerIndex + 1;
+			while (innerIndex < string.length && /[A-Z]/.test(string[innerIndex]) && (options.preserveConsecutiveCapitals ? innerIndex + 1 < string.length && /[a-z]/.test(string[innerIndex + 1]) ? false : true : true)) innerIndex++;
+			const sequenceOfCapitals = string.slice(outerIndex, innerIndex);
+			if (options.preserveConsecutiveCapitals) {
+				if (result) result += "-";
+				result += sequenceOfCapitals.toLowerCase();
+			} else {
+				if (result) result += "-";
+				result += sequenceOfCapitals.split("").map((character$1) => {
+					return character$1.toLowerCase();
+				}).join("-");
+			}
+			outerIndex = innerIndex;
+		} else {
+			result += character;
+			outerIndex++;
+		}
+	}
+	return result;
 }
 var camelToKebab_default = camelToKebab;
 
@@ -857,7 +881,7 @@ var kebabToCamel_default = kebabToCamel;
 * @returns The import path normalized.
 */
 function normalizeImportPath(importPath) {
-	const normalizedPath = path.default.posix.normalize(importPath);
+	const normalizedPath = node_path.default.posix.normalize(importPath);
 	if (importPath.startsWith("./") && !normalizedPath.startsWith("./")) return `./${normalizedPath}`;
 	return normalizedPath;
 }

package/dist/index.d.cts

@@ -524,14 +524,19 @@ declare function deepFreeze<ObjectType extends object>(object: ObjectType): Read
 declare function appendSemicolon(stringToAppendTo: string): string;
 //#endregion
 //#region src/functions/stringHelpers/camelToKebab.d.ts
+interface CamelToKebabOptions {
+  /** Whether to leave consecutive capitals alone in the conversion or not (e.g. `validateAPIUser` becomes `validate-a-p-i-user` if `false`, and `validate-api-user` if `true`) */
+  preserveConsecutiveCapitals?: boolean;
+}
 /**
  * Converts a string from camelCase to kebab-case
  *
  * @param string - The string to convert.
+ * @param options - Options to apply to the conversion.
  *
  * @returns The string converted to kebab-case.
  */
-declare function camelToKebab(string: string): string;
+declare function camelToKebab(string: string, options?: CamelToKebabOptions): string;
 //#endregion
 //#region src/functions/stringHelpers/kebabToCamel.d.ts
 interface KebabToCamelOptions {
@@ -742,4 +747,4 @@ interface ParseVersionOptions {
  */
 declare function parseVersion(input: string, options?: ParseVersionOptions): string;
 //#endregion
-export { APIError, ArrayElement, CreateFormDataOptions, CreateFormDataOptionsNullableResolution, CreateFormDataOptionsUndefinedOrNullResolution, DataError, DisallowUndefined, Env, FormDataArrayResolutionStrategy, FormDataNullableResolutionStrategy, HTTPErrorCode, IgnoreCase, IncrementVersionOptions, KebabToCamelOptions, NAMESPACE_EXPORT_REGEX, NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, OptionalOnCondition, ParseVersionOptions, RecordKey, StringListToArrayOptions, VERSION_NUMBER_REGEX, VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, determineVersionType, fillArray, formatDateAndTime, getIndividualVersionNumbers, getRandomNumber, getRecordKeys, httpErrorCodeLookup, incrementVersion, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, kebabToCamel, normaliseImportPath, normaliseIndents, normalizeImportPath, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseVersion, parseVersionType, parseZodSchema, randomiseArray, range, removeDuplicates, stringListToArray, truncate, wait };
+export { APIError, ArrayElement, CamelToKebabOptions, CreateFormDataOptions, CreateFormDataOptionsNullableResolution, CreateFormDataOptionsUndefinedOrNullResolution, DataError, DisallowUndefined, Env, FormDataArrayResolutionStrategy, FormDataNullableResolutionStrategy, HTTPErrorCode, IgnoreCase, IncrementVersionOptions, KebabToCamelOptions, NAMESPACE_EXPORT_REGEX, NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, OptionalOnCondition, ParseVersionOptions, RecordKey, StringListToArrayOptions, VERSION_NUMBER_REGEX, VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, determineVersionType, fillArray, formatDateAndTime, getIndividualVersionNumbers, getRandomNumber, getRecordKeys, httpErrorCodeLookup, incrementVersion, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, kebabToCamel, normaliseImportPath, normaliseIndents, normalizeImportPath, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseVersion, parseVersionType, parseZodSchema, randomiseArray, range, removeDuplicates, stringListToArray, truncate, wait };

package/dist/index.d.ts

@@ -524,14 +524,19 @@ declare function deepFreeze<ObjectType extends object>(object: ObjectType): Read
 declare function appendSemicolon(stringToAppendTo: string): string;
 //#endregion
 //#region src/functions/stringHelpers/camelToKebab.d.ts
+interface CamelToKebabOptions {
+  /** Whether to leave consecutive capitals alone in the conversion or not (e.g. `validateAPIUser` becomes `validate-a-p-i-user` if `false`, and `validate-api-user` if `true`) */
+  preserveConsecutiveCapitals?: boolean;
+}
 /**
  * Converts a string from camelCase to kebab-case
  *
  * @param string - The string to convert.
+ * @param options - Options to apply to the conversion.
  *
  * @returns The string converted to kebab-case.
  */
-declare function camelToKebab(string: string): string;
+declare function camelToKebab(string: string, options?: CamelToKebabOptions): string;
 //#endregion
 //#region src/functions/stringHelpers/kebabToCamel.d.ts
 interface KebabToCamelOptions {
@@ -742,4 +747,4 @@ interface ParseVersionOptions {
  */
 declare function parseVersion(input: string, options?: ParseVersionOptions): string;
 //#endregion
-export { APIError, ArrayElement, CreateFormDataOptions, CreateFormDataOptionsNullableResolution, CreateFormDataOptionsUndefinedOrNullResolution, DataError, DisallowUndefined, type Env, FormDataArrayResolutionStrategy, FormDataNullableResolutionStrategy, HTTPErrorCode, IgnoreCase, type IncrementVersionOptions, KebabToCamelOptions, NAMESPACE_EXPORT_REGEX, NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, OptionalOnCondition, type ParseVersionOptions, RecordKey, StringListToArrayOptions, VERSION_NUMBER_REGEX, type VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, determineVersionType, fillArray, formatDateAndTime, getIndividualVersionNumbers, getRandomNumber, getRecordKeys, httpErrorCodeLookup, incrementVersion, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, kebabToCamel, normaliseImportPath, normaliseIndents, normalizeImportPath, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseVersion, parseVersionType, parseZodSchema, randomiseArray, range, removeDuplicates, stringListToArray, truncate, wait };
+export { APIError, ArrayElement, CamelToKebabOptions, CreateFormDataOptions, CreateFormDataOptionsNullableResolution, CreateFormDataOptionsUndefinedOrNullResolution, DataError, DisallowUndefined, type Env, FormDataArrayResolutionStrategy, FormDataNullableResolutionStrategy, HTTPErrorCode, IgnoreCase, type IncrementVersionOptions, KebabToCamelOptions, NAMESPACE_EXPORT_REGEX, NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, OptionalOnCondition, type ParseVersionOptions, RecordKey, StringListToArrayOptions, VERSION_NUMBER_REGEX, type VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, determineVersionType, fillArray, formatDateAndTime, getIndividualVersionNumbers, getRandomNumber, getRecordKeys, httpErrorCodeLookup, incrementVersion, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, kebabToCamel, normaliseImportPath, normaliseIndents, normalizeImportPath, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseVersion, parseVersionType, parseZodSchema, randomiseArray, range, removeDuplicates, stringListToArray, truncate, wait };

package/dist/index.js

@@ -1,5 +1,5 @@
 import z, { z as z$1 } from "zod";
-import path from "path";
+import path from "node:path";
 
 //#region src/constants/NAMESPACE_EXPORT_REGEX.ts
 const NAMESPACE_EXPORT_REGEX = "export\\s+\\*\\s+from";
@@ -766,11 +766,35 @@ var appendSemicolon_default = appendSemicolon;
 * Converts a string from camelCase to kebab-case
 *
 * @param string - The string to convert.
+* @param options - Options to apply to the conversion.
 *
 * @returns The string converted to kebab-case.
 */
-function camelToKebab(string) {
-	return string.replace(/([a-z0-9])([A-Z])/g, "$1-$2").replace(/([A-Z])([A-Z][a-z])/g, "$1-$2").toLowerCase();
+function camelToKebab(string, options = { preserveConsecutiveCapitals: true }) {
+	let result = "";
+	let outerIndex = 0;
+	while (outerIndex < string.length) {
+		const character = string[outerIndex];
+		if (/[A-Z]/.test(character)) {
+			let innerIndex = outerIndex + 1;
+			while (innerIndex < string.length && /[A-Z]/.test(string[innerIndex]) && (options.preserveConsecutiveCapitals ? innerIndex + 1 < string.length && /[a-z]/.test(string[innerIndex + 1]) ? false : true : true)) innerIndex++;
+			const sequenceOfCapitals = string.slice(outerIndex, innerIndex);
+			if (options.preserveConsecutiveCapitals) {
+				if (result) result += "-";
+				result += sequenceOfCapitals.toLowerCase();
+			} else {
+				if (result) result += "-";
+				result += sequenceOfCapitals.split("").map((character$1) => {
+					return character$1.toLowerCase();
+				}).join("-");
+			}
+			outerIndex = innerIndex;
+		} else {
+			result += character;
+			outerIndex++;
+		}
+	}
+	return result;
 }
 var camelToKebab_default = camelToKebab;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alextheman/utility",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "description": "Helpful utility functions",
   "repository": {
     "type": "git",
@@ -19,9 +19,9 @@
     "zod": "^4.2.1"
   },
   "devDependencies": {
-    "@alextheman/eslint-plugin": "^4.9.0",
+    "@alextheman/eslint-plugin": "^4.10.0",
     "@types/node": "^25.0.3",
-    "alex-c-line": "^1.9.0",
+    "alex-c-line": "^1.10.0",
     "dotenv-cli": "^11.0.0",
     "eslint": "^9.39.2",
     "eslint-plugin-perfectionist": "^5.0.0",