complete-common 2.7.0 → 2.8.0

package/dist/functions/string.d.cts

@@ -28,6 +28,8 @@ export declare function hasDiacritic(string: string): boolean;
 export declare function hasEmoji(string: string): boolean;
 /** From: https://stackoverflow.com/questions/1731190/check-if-a-string-has-white-space */
 export declare function hasWhitespace(string: string): boolean;
+/** Helper function to determine if a string only contains ASCII characters. */
+export declare function isASCII(str: string): boolean;
 /**
  * From:
  * https://stackoverflow.com/questions/8334606/check-if-first-letter-of-word-is-a-capital-letter

package/dist/functions/string.d.mts

@@ -28,6 +28,8 @@ export declare function hasDiacritic(string: string): boolean;
 export declare function hasEmoji(string: string): boolean;
 /** From: https://stackoverflow.com/questions/1731190/check-if-a-string-has-white-space */
 export declare function hasWhitespace(string: string): boolean;
+/** Helper function to determine if a string only contains ASCII characters. */
+export declare function isASCII(str: string): boolean;
 /**
  * From:
  * https://stackoverflow.com/questions/8334606/check-if-first-letter-of-word-is-a-capital-letter

package/dist/functions/string.d.ts

@@ -28,6 +28,8 @@ export declare function hasDiacritic(string: string): boolean;
 export declare function hasEmoji(string: string): boolean;
 /** From: https://stackoverflow.com/questions/1731190/check-if-a-string-has-white-space */
 export declare function hasWhitespace(string: string): boolean;
+/** Helper function to determine if a string only contains ASCII characters. */
+export declare function isASCII(str: string): boolean;
 /**
  * From:
  * https://stackoverflow.com/questions/8334606/check-if-first-letter-of-word-is-a-capital-letter

package/dist/functions/string.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../../src/functions/string.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAmBH,kEAAkE;AAClE,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAU5D;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAO3D;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAqBlE;AAED,6EAA6E;AAC7E,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAOpD;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEhD;AAED,0FAA0F;AAC1F,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAErD;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEhE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEnD;AAED,+FAA+F;AAC/F,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEnD;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAGhE;AAED,+FAA+F;AAC/F,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEnD;AAED,wEAAwE;AACxE,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAO3D;AAED,yEAAyE;AACzE,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAG5D;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAiBtD;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,aAAa,EAAE,MAAM,GACtD;IACE,uDAAuD;IACvD,YAAY,EAAE,MAAM,CAAC;IAErB,wDAAwD;IACxD,YAAY,EAAE,MAAM,CAAC;IAErB,uDAAuD;IACvD,YAAY,EAAE,MAAM,CAAC;CACtB,GACD,SAAS,CAwBZ;AAGD;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,GACb,MAAM,CAuBR;AAED,gGAAgG;AAChG,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAIzE;AAED;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAEnE;AAED,yEAAyE;AACzE,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAEvD;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CACxB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,UAAQ,GACd,MAAM,CAWR;AAED,gGAAgG;AAChG,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAOjE;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAMxE"}
+{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../../src/functions/string.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAyBH,kEAAkE;AAClE,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAU5D;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAO3D;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAqBlE;AAED,6EAA6E;AAC7E,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAOpD;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEhD;AAED,0FAA0F;AAC1F,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAErD;AAED,+EAA+E;AAC/E,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAE5C;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEhE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEnD;AAED,+FAA+F;AAC/F,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEnD;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAGhE;AAED,+FAA+F;AAC/F,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEnD;AAED,wEAAwE;AACxE,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAO3D;AAED,yEAAyE;AACzE,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAG5D;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAiBtD;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,aAAa,EAAE,MAAM,GACtD;IACE,uDAAuD;IACvD,YAAY,EAAE,MAAM,CAAC;IAErB,wDAAwD;IACxD,YAAY,EAAE,MAAM,CAAC;IAErB,uDAAuD;IACvD,YAAY,EAAE,MAAM,CAAC;CACtB,GACD,SAAS,CAwBZ;AAGD;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,GACb,MAAM,CAuBR;AAED,gGAAgG;AAChG,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAIzE;AAED;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAEnE;AAED,yEAAyE;AACzE,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAEvD;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CACxB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,UAAQ,GACd,MAAM,CAWR;AAED,gGAAgG;AAChG,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAOjE;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAMxE"}

package/dist/index.cjs

@@ -399,8 +399,9 @@ function repeat(num, func) {
 function todo(...args) {
 }
 
+const ASCII_REGEX = /^[\u0000-\u007F]*$/;
 const DIACRITIC_REGEX = /\p{Diacritic}/u;
-const EMOJI_REGEX = /(\p{Extended_Pictographic}|\p{Emoji_Component})/u;
+const EMOJI_REGEX = /(\p{Extended_Pictographic}|[#*0-9]\uFE0F?\u20E3)/u;
 const FIRST_LETTER_CAPITALIZED_REGEX = /^\p{Lu}/u;
 const KEBAB_CASE_REGEX = /^[\da-z]+(?:-[\da-z]+)*$/;
 const SEMANTIC_VERSION_REGEX = /^v*(?<major>\d+)\.(?<minor>\d+)\.(?<patch>\d+)/;
@@ -445,6 +446,9 @@ function hasEmoji(string) {
 function hasWhitespace(string) {
   return WHITESPACE_REGEX.test(string);
 }
+function isASCII(str) {
+  return ASCII_REGEX.test(str);
+}
 function isFirstLetterCapitalized(string) {
   return FIRST_LETTER_CAPITALIZED_REGEX.test(string);
 }
@@ -614,6 +618,7 @@ exports.iRange = iRange;
 exports.includes = includes;
 exports.includesAny = includesAny;
 exports.interfaceSatisfiesEnum = interfaceSatisfiesEnum;
+exports.isASCII = isASCII;
 exports.isArray = isArray;
 exports.isArrayBoolean = isArrayBoolean;
 exports.isArrayNumber = isArrayNumber;

package/dist/index.mjs

@@ -397,8 +397,9 @@ function repeat(num, func) {
 function todo(...args) {
 }
 
+const ASCII_REGEX = /^[\u0000-\u007F]*$/;
 const DIACRITIC_REGEX = /\p{Diacritic}/u;
-const EMOJI_REGEX = /(\p{Extended_Pictographic}|\p{Emoji_Component})/u;
+const EMOJI_REGEX = /(\p{Extended_Pictographic}|[#*0-9]\uFE0F?\u20E3)/u;
 const FIRST_LETTER_CAPITALIZED_REGEX = /^\p{Lu}/u;
 const KEBAB_CASE_REGEX = /^[\da-z]+(?:-[\da-z]+)*$/;
 const SEMANTIC_VERSION_REGEX = /^v*(?<major>\d+)\.(?<minor>\d+)\.(?<patch>\d+)/;
@@ -443,6 +444,9 @@ function hasEmoji(string) {
 function hasWhitespace(string) {
   return WHITESPACE_REGEX.test(string);
 }
+function isASCII(str) {
+  return ASCII_REGEX.test(str);
+}
 function isFirstLetterCapitalized(string) {
   return FIRST_LETTER_CAPITALIZED_REGEX.test(string);
 }
@@ -566,4 +570,4 @@ function* tupleKeys(tuple) {
 
 const ReadonlyMap = Map;
 
-export { HOUR_IN_MILLISECONDS, MINUTE_IN_MILLISECONDS, ReadonlyMap, ReadonlySet, SECOND_IN_MILLISECONDS, addSetsToSet, arrayCopyTwoDimensional, arrayEquals, arrayRemove, arrayRemoveAllInPlace, arrayRemoveInPlace, assertArray, assertArrayBoolean, assertArrayNumber, assertArrayString, assertBoolean, assertDefined, assertEnumValue, assertIs, assertNotNull, assertNumber, assertObject, assertString, capitalizeFirstLetter, clamp, combineSets, copySet, eRange, emptyArray, escapeHTMLCharacters, filterMap, getElapsedSeconds, getEnumEntries, getEnumKeys, getEnumValues, getNumConsecutiveDiacritics, getRandomArrayElement, getRandomArrayIndex, getRandomInt, hasDiacritic, hasEmoji, hasWhitespace, iRange, includes, includesAny, interfaceSatisfiesEnum, isArray, isArrayBoolean, isArrayNumber, isArrayString, isEnumValue, isFirstLetterCapitalized, isKebabCase, isKeyOf, isLowerCase, isObject, isSemanticVersion, isUpperCase, kebabCaseToCamelCase, kebabCaseToPascalCase, mapFilter, mapFind, newArray, noop, normalizeString, objectFilter, objectKeysToSet, objectToMap, objectToReverseMap, objectValuesToSet, parseFloatSafe, parseIntSafe, parseSemanticVersion, removeLinesBetweenMarkers, removeLinesMatching, removeNonPrintableCharacters, removeWhitespace, repeat, setAdd, setHas, sortCaseInsensitive, sumArray, todo, trimPrefix, trimSuffix, truncateString, tupleEntries, tupleKeys };
+export { HOUR_IN_MILLISECONDS, MINUTE_IN_MILLISECONDS, ReadonlyMap, ReadonlySet, SECOND_IN_MILLISECONDS, addSetsToSet, arrayCopyTwoDimensional, arrayEquals, arrayRemove, arrayRemoveAllInPlace, arrayRemoveInPlace, assertArray, assertArrayBoolean, assertArrayNumber, assertArrayString, assertBoolean, assertDefined, assertEnumValue, assertIs, assertNotNull, assertNumber, assertObject, assertString, capitalizeFirstLetter, clamp, combineSets, copySet, eRange, emptyArray, escapeHTMLCharacters, filterMap, getElapsedSeconds, getEnumEntries, getEnumKeys, getEnumValues, getNumConsecutiveDiacritics, getRandomArrayElement, getRandomArrayIndex, getRandomInt, hasDiacritic, hasEmoji, hasWhitespace, iRange, includes, includesAny, interfaceSatisfiesEnum, isASCII, isArray, isArrayBoolean, isArrayNumber, isArrayString, isEnumValue, isFirstLetterCapitalized, isKebabCase, isKeyOf, isLowerCase, isObject, isSemanticVersion, isUpperCase, kebabCaseToCamelCase, kebabCaseToPascalCase, mapFilter, mapFind, newArray, noop, normalizeString, objectFilter, objectKeysToSet, objectToMap, objectToReverseMap, objectValuesToSet, parseFloatSafe, parseIntSafe, parseSemanticVersion, removeLinesBetweenMarkers, removeLinesMatching, removeNonPrintableCharacters, removeWhitespace, repeat, setAdd, setHas, sortCaseInsensitive, sumArray, todo, trimPrefix, trimSuffix, truncateString, tupleEntries, tupleKeys };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "complete-common",
-  "version": "2.7.0",
+  "version": "2.8.0",
   "description": "Helper functions for TypeScript projects.",
   "homepage": "https://complete-ts.github.io/",
   "bugs": {
@@ -31,8 +31,8 @@
     "test": "tsx --test"
   },
   "devDependencies": {
-    "@types/node": "24.7.1",
-    "complete-node": "12.2.0",
+    "@types/node": "24.7.2",
+    "complete-node": "12.2.1",
     "eslint-plugin-sort-exports": "0.9.1",
     "typescript": "5.9.3",
     "typescript-eslint": "8.46.0",

package/src/functions/string.test.ts

@@ -9,14 +9,27 @@ import {
 } from "./string.js";
 
 describe("hasEmoji", () => {
-  test("should return true for string with emoji", () => {
+  test("should return true for string with normal emoji", () => {
     equal(hasEmoji("Hello 😃 World"), true);
-    equal(hasEmoji("This is a 🌟 test"), true);
+  });
+
+  test("should return true for string with keycap emoji", () => {
+    equal(hasEmoji("This is a keycap emoji: #️⃣"), true);
   });
 
   test("should return false for string without emoji", () => {
     equal(hasEmoji("Hello World"), false);
-    equal(hasEmoji("No emoji here!"), false);
+    equal(
+      hasEmoji(`
+# Some Markdown Title
+
+This page is for people who like [cake](https://en.wikipedia.org/wiki/Cake).
+
+- Run \`npm run cake\` to get cake.
+- Run \`npm run pie\` to get pie.
+      `),
+      false,
+    );
   });
 
   test("should handle empty string", () => {
@@ -123,9 +136,11 @@ describe("trimPrefix", () => {
 });
 
 describe("trimSuffix", () => {
-  equal(trimSuffix("foo", ""), "foo");
-  equal(trimSuffix("foo", "o"), "fo");
-  equal(trimSuffix("foo", "oo"), "f");
-  equal(trimSuffix("foo", "foo"), "");
-  equal(trimSuffix("foo", "1foo"), "foo");
+  test(() => {
+    equal(trimSuffix("foo", ""), "foo");
+    equal(trimSuffix("foo", "o"), "fo");
+    equal(trimSuffix("foo", "oo"), "f");
+    equal(trimSuffix("foo", "foo"), "");
+    equal(trimSuffix("foo", "1foo"), "foo");
+  });
 });

package/src/functions/string.ts

@@ -9,10 +9,16 @@ import { parseIntSafe } from "./utils.js";
 // When regular expressions are located at the root instead of inside the function, the functions
 // are tested to perform 11% faster.
 
+// eslint-disable-next-line no-control-regex
+const ASCII_REGEX = /^[\u0000-\u007F]*$/;
+
 const DIACRITIC_REGEX = /\p{Diacritic}/u;
 
-/** This is what the Zod validator library uses. */
-const EMOJI_REGEX = /(\p{Extended_Pictographic}|\p{Emoji_Component})/u;
+/**
+ * - We can't use `/\p{Emoji}/u` because it has a false positive on "#" characters.
+ * - We can't use `/\p{Extended_Pictographic}/u` because it has a false negative on keycap emojis.
+ */
+const EMOJI_REGEX = /(\p{Extended_Pictographic}|[#*0-9]\uFE0F?\u20E3)/u;
 
 const FIRST_LETTER_CAPITALIZED_REGEX = /^\p{Lu}/u;
 const KEBAB_CASE_REGEX = /^[\da-z]+(?:-[\da-z]+)*$/;
@@ -101,6 +107,11 @@ export function hasWhitespace(string: string): boolean {
   return WHITESPACE_REGEX.test(string);
 }
 
+/** Helper function to determine if a string only contains ASCII characters. */
+export function isASCII(str: string): boolean {
+  return ASCII_REGEX.test(str);
+}
+
 /**
  * From:
  * https://stackoverflow.com/questions/8334606/check-if-first-letter-of-word-is-a-capital-letter