@stryke/string-format 0.16.0 → 0.17.0

package/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 # Changelog for Stryke - String Format
 
+## [0.17.0](https://github.com/storm-software/stryke/releases/tag/string-format%400.17.0) (03/08/2026)
+
+### Features
+
+- **string-format:** Added the conjuction option to `list` helper ([058de0bc](https://github.com/storm-software/stryke/commit/058de0bc))
+
+### Updated Dependencies
+
+- Updated **helpers** to **v0.10.0**
+- Updated **types** to **v0.10.49**
+- Updated **path** to **v0.26.16**
+
 ## [0.16.0](https://github.com/storm-software/stryke/releases/tag/string-format%400.16.0) (03/06/2026)
 
 ### Features

package/dist/index.d.cts

@@ -10,7 +10,7 @@ import { escapeHtml, escapeRegExp } from "./escape.cjs";
 import { FormatSpecialCasesOptions, formatSpecialCases } from "./format-special-cases.cjs";
 import { CASE_SPLIT_PATTERN, GetWordsOptions, RELAXED_SPLIT_PATTERN, getWords } from "./get-words.cjs";
 import { isKebabCase, kebabCase } from "./kebab-case.cjs";
-import { list } from "./list.cjs";
+import { ListOptions, list } from "./list.cjs";
 import { lowerCaseFirst } from "./lower-case-first.cjs";
 import { normalizeEmail } from "./normalize-email.cjs";
 import { toOrdinal } from "./ordinals.cjs";
@@ -29,4 +29,4 @@ import { TitleCaseOptions, titleCase } from "./title-case.cjs";
 import { unescape } from "./unescape.cjs";
 import { upperCaseFirst } from "./upper-case-first.cjs";
 import { getIndefiniteArticle, isVowel } from "./vowels.cjs";
-export { ACRONYMS, ACRONYM_DESCRIPTION, ACRONYM_DISPLAY, ACRONYM_LIST, ARTICLES, CASE_SPLIT_PATTERN, CONJUNCTIONS, FormatSpecialCasesOptions, GetWordsOptions, Options, PREPOSITIONS, PrettyPathOptions, RELAXED_SPLIT_PATTERN, SPECIAL_CASES, SnakeCaseOptions, TitleCaseOptions, camelCase, combine, constantCase, deburr, decamelize, escapeHtml, escapeRegExp, formatSpecialCases, getIndefiniteArticle, getPackageName, getPackageVersion, getWords, hasPackageVersion, isCamelCase, isConstantCase, isKebabCase, isPascalCase, isPeriodSplit, isSnakeCase, isStartCase, isVowel, kebabCase, list, lowerCaseFirst, normalizeEmail, pad, pascalCase, periodSplit, prettyBytes, prettyPath, removePackageVersion, snakeCase, startCase, stripIndents, titleCase, toLocaleString, toOrdinal, unescape, upperCaseFirst };
+export { ACRONYMS, ACRONYM_DESCRIPTION, ACRONYM_DISPLAY, ACRONYM_LIST, ARTICLES, CASE_SPLIT_PATTERN, CONJUNCTIONS, FormatSpecialCasesOptions, GetWordsOptions, ListOptions, Options, PREPOSITIONS, PrettyPathOptions, RELAXED_SPLIT_PATTERN, SPECIAL_CASES, SnakeCaseOptions, TitleCaseOptions, camelCase, combine, constantCase, deburr, decamelize, escapeHtml, escapeRegExp, formatSpecialCases, getIndefiniteArticle, getPackageName, getPackageVersion, getWords, hasPackageVersion, isCamelCase, isConstantCase, isKebabCase, isPascalCase, isPeriodSplit, isSnakeCase, isStartCase, isVowel, kebabCase, list, lowerCaseFirst, normalizeEmail, pad, pascalCase, periodSplit, prettyBytes, prettyPath, removePackageVersion, snakeCase, startCase, stripIndents, titleCase, toLocaleString, toOrdinal, unescape, upperCaseFirst };

package/dist/index.d.mts

@@ -10,7 +10,7 @@ import { escapeHtml, escapeRegExp } from "./escape.mjs";
 import { FormatSpecialCasesOptions, formatSpecialCases } from "./format-special-cases.mjs";
 import { CASE_SPLIT_PATTERN, GetWordsOptions, RELAXED_SPLIT_PATTERN, getWords } from "./get-words.mjs";
 import { isKebabCase, kebabCase } from "./kebab-case.mjs";
-import { list } from "./list.mjs";
+import { ListOptions, list } from "./list.mjs";
 import { lowerCaseFirst } from "./lower-case-first.mjs";
 import { normalizeEmail } from "./normalize-email.mjs";
 import { toOrdinal } from "./ordinals.mjs";
@@ -29,4 +29,4 @@ import { TitleCaseOptions, titleCase } from "./title-case.mjs";
 import { unescape } from "./unescape.mjs";
 import { upperCaseFirst } from "./upper-case-first.mjs";
 import { getIndefiniteArticle, isVowel } from "./vowels.mjs";
-export { ACRONYMS, ACRONYM_DESCRIPTION, ACRONYM_DISPLAY, ACRONYM_LIST, ARTICLES, CASE_SPLIT_PATTERN, CONJUNCTIONS, FormatSpecialCasesOptions, GetWordsOptions, Options, PREPOSITIONS, PrettyPathOptions, RELAXED_SPLIT_PATTERN, SPECIAL_CASES, SnakeCaseOptions, TitleCaseOptions, camelCase, combine, constantCase, deburr, decamelize, escapeHtml, escapeRegExp, formatSpecialCases, getIndefiniteArticle, getPackageName, getPackageVersion, getWords, hasPackageVersion, isCamelCase, isConstantCase, isKebabCase, isPascalCase, isPeriodSplit, isSnakeCase, isStartCase, isVowel, kebabCase, list, lowerCaseFirst, normalizeEmail, pad, pascalCase, periodSplit, prettyBytes, prettyPath, removePackageVersion, snakeCase, startCase, stripIndents, titleCase, toLocaleString, toOrdinal, unescape, upperCaseFirst };
+export { ACRONYMS, ACRONYM_DESCRIPTION, ACRONYM_DISPLAY, ACRONYM_LIST, ARTICLES, CASE_SPLIT_PATTERN, CONJUNCTIONS, FormatSpecialCasesOptions, GetWordsOptions, ListOptions, Options, PREPOSITIONS, PrettyPathOptions, RELAXED_SPLIT_PATTERN, SPECIAL_CASES, SnakeCaseOptions, TitleCaseOptions, camelCase, combine, constantCase, deburr, decamelize, escapeHtml, escapeRegExp, formatSpecialCases, getIndefiniteArticle, getPackageName, getPackageVersion, getWords, hasPackageVersion, isCamelCase, isConstantCase, isKebabCase, isPascalCase, isPeriodSplit, isSnakeCase, isStartCase, isVowel, kebabCase, list, lowerCaseFirst, normalizeEmail, pad, pascalCase, periodSplit, prettyBytes, prettyPath, removePackageVersion, snakeCase, startCase, stripIndents, titleCase, toLocaleString, toOrdinal, unescape, upperCaseFirst };

package/dist/list.cjs

@@ -12,13 +12,14 @@
 * @param strings - The array of strings or a single string to convert into a list.
 * @returns The converted list string.
 */
-function list(strings) {
+function list(strings, options = {}) {
+	const { conjunction = "and" } = options;
 	if (typeof strings === "string") return strings;
 	if (strings.length === 0) return "";
 	if (strings.length === 1) return strings[0];
-	if (strings.length === 2) return `${strings[0]} and ${strings[1]}`;
+	if (strings.length === 2) return `${strings[0]} ${conjunction} ${strings[1]}`;
 	const last = strings.pop();
-	return `${strings.join(", ")}, and ${last}`;
+	return `${strings.join(", ")}, ${conjunction} ${last}`;
 }
 
 //#endregion

package/dist/list.d.cts

@@ -1,4 +1,12 @@
 //#region src/list.d.ts
+interface ListOptions {
+  /**
+   * The conjunction to use when joining the last two items in the list.
+   *
+   * @defaultValue "and"
+   */
+  conjunction?: string;
+}
 /**
  * Convert an array of strings into a human-readable list string.
  *
@@ -11,7 +19,7 @@
  * @param strings - The array of strings or a single string to convert into a list.
  * @returns The converted list string.
  */
-declare function list(strings: string | string[]): string;
+declare function list(strings: string | string[], options?: ListOptions): string;
 //#endregion
-export { list };
+export { ListOptions, list };
 //# sourceMappingURL=list.d.cts.map

package/dist/list.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"list.d.cts","names":[],"sources":["../src/list.ts"],"sourcesContent":[],"mappings":";;AA8BA;;;;;;;;;;;iBAAgB,IAAA"}
+{"version":3,"file":"list.d.cts","names":[],"sources":["../src/list.ts"],"sourcesContent":[],"mappings":";UAkBiB,WAAA;EAAA;AAqBjB;;;;;;;;;;;;;;;;;;iBAAgB,IAAA,uCAEL"}

package/dist/list.d.mts

@@ -1,4 +1,12 @@
 //#region src/list.d.ts
+interface ListOptions {
+  /**
+   * The conjunction to use when joining the last two items in the list.
+   *
+   * @defaultValue "and"
+   */
+  conjunction?: string;
+}
 /**
  * Convert an array of strings into a human-readable list string.
  *
@@ -11,7 +19,7 @@
  * @param strings - The array of strings or a single string to convert into a list.
  * @returns The converted list string.
  */
-declare function list(strings: string | string[]): string;
+declare function list(strings: string | string[], options?: ListOptions): string;
 //#endregion
-export { list };
+export { ListOptions, list };
 //# sourceMappingURL=list.d.mts.map

package/dist/list.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"list.d.mts","names":[],"sources":["../src/list.ts"],"sourcesContent":[],"mappings":";;AA8BA;;;;;;;;;;;iBAAgB,IAAA"}
+{"version":3,"file":"list.d.mts","names":[],"sources":["../src/list.ts"],"sourcesContent":[],"mappings":";UAkBiB,WAAA;EAAA;AAqBjB;;;;;;;;;;;;;;;;;;iBAAgB,IAAA,uCAEL"}

package/dist/list.mjs

@@ -11,13 +11,14 @@
 * @param strings - The array of strings or a single string to convert into a list.
 * @returns The converted list string.
 */
-function list(strings) {
+function list(strings, options = {}) {
+	const { conjunction = "and" } = options;
 	if (typeof strings === "string") return strings;
 	if (strings.length === 0) return "";
 	if (strings.length === 1) return strings[0];
-	if (strings.length === 2) return `${strings[0]} and ${strings[1]}`;
+	if (strings.length === 2) return `${strings[0]} ${conjunction} ${strings[1]}`;
 	const last = strings.pop();
-	return `${strings.join(", ")}, and ${last}`;
+	return `${strings.join(", ")}, ${conjunction} ${last}`;
 }
 
 //#endregion

package/dist/list.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"list.mjs","names":[],"sources":["../src/list.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                       ⚡ Storm Software - Stryke\n\n This code was released as part of the Stryke project. Stryke\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/stryke.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/stryke\n Documentation:            https://docs.stormsoftware.com/projects/stryke\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\n/**\n * Convert an array of strings into a human-readable list string.\n *\n * @example\n * list([\"apple\", \"banana\", \"cherry\"]) // \"apple, banana, and cherry\"\n * list([\"apple\", \"banana\"]) // \"apple and banana\"\n * list([\"apple\"]) // \"apple\"\n * list(\"apple\") // \"apple\"\n *\n * @param strings - The array of strings or a single string to convert into a list.\n * @returns The converted list string.\n */\nexport function list(strings: string | string[]): string {\n  if (typeof strings === \"string\") {\n    return strings;\n  }\n\n  if (strings.length === 0) {\n    return \"\";\n  }\n\n  if (strings.length === 1) {\n    return strings[0]!;\n  }\n\n  if (strings.length === 2) {\n    return `${strings[0]} and ${strings[1]}`;\n  }\n\n  const last = strings.pop();\n\n  return `${strings.join(\", \")}, and ${last}`;\n}\n"],"mappings":";;;;;;;;;;;;;AA8BA,SAAgB,KAAK,SAAoC;AACvD,KAAI,OAAO,YAAY,SACrB,QAAO;AAGT,KAAI,QAAQ,WAAW,EACrB,QAAO;AAGT,KAAI,QAAQ,WAAW,EACrB,QAAO,QAAQ;AAGjB,KAAI,QAAQ,WAAW,EACrB,QAAO,GAAG,QAAQ,GAAG,OAAO,QAAQ;CAGtC,MAAM,OAAO,QAAQ,KAAK;AAE1B,QAAO,GAAG,QAAQ,KAAK,KAAK,CAAC,QAAQ"}
+{"version":3,"file":"list.mjs","names":[],"sources":["../src/list.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                       ⚡ Storm Software - Stryke\n\n This code was released as part of the Stryke project. Stryke\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/stryke.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/stryke\n Documentation:            https://docs.stormsoftware.com/projects/stryke\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nexport interface ListOptions {\n  /**\n   * The conjunction to use when joining the last two items in the list.\n   *\n   * @defaultValue \"and\"\n   */\n  conjunction?: string;\n}\n\n/**\n * Convert an array of strings into a human-readable list string.\n *\n * @example\n * list([\"apple\", \"banana\", \"cherry\"]) // \"apple, banana, and cherry\"\n * list([\"apple\", \"banana\"]) // \"apple and banana\"\n * list([\"apple\"]) // \"apple\"\n * list(\"apple\") // \"apple\"\n *\n * @param strings - The array of strings or a single string to convert into a list.\n * @returns The converted list string.\n */\nexport function list(\n  strings: string | string[],\n  options: ListOptions = {}\n): string {\n  const { conjunction = \"and\" } = options;\n\n  if (typeof strings === \"string\") {\n    return strings;\n  }\n\n  if (strings.length === 0) {\n    return \"\";\n  }\n\n  if (strings.length === 1) {\n    return strings[0]!;\n  }\n\n  if (strings.length === 2) {\n    return `${strings[0]} ${conjunction} ${strings[1]}`;\n  }\n\n  const last = strings.pop();\n\n  return `${strings.join(\", \")}, ${conjunction} ${last}`;\n}\n"],"mappings":";;;;;;;;;;;;;AAuCA,SAAgB,KACd,SACA,UAAuB,EAAE,EACjB;CACR,MAAM,EAAE,cAAc,UAAU;AAEhC,KAAI,OAAO,YAAY,SACrB,QAAO;AAGT,KAAI,QAAQ,WAAW,EACrB,QAAO;AAGT,KAAI,QAAQ,WAAW,EACrB,QAAO,QAAQ;AAGjB,KAAI,QAAQ,WAAW,EACrB,QAAO,GAAG,QAAQ,GAAG,GAAG,YAAY,GAAG,QAAQ;CAGjD,MAAM,OAAO,QAAQ,KAAK;AAE1B,QAAO,GAAG,QAAQ,KAAK,KAAK,CAAC,IAAI,YAAY,GAAG"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stryke/string-format",
-  "version": "0.16.0",
+  "version": "0.17.0",
   "type": "module",
   "description": "A package containing utility functions to transform strings into various formats.",
   "repository": {
@@ -134,8 +134,8 @@
     "./*": "./*"
   },
   "types": "./dist/index.d.cts",
-  "dependencies": { "@stryke/path": "^0.26.15" },
+  "dependencies": { "@stryke/path": "^0.26.16" },
   "devDependencies": { "tsdown": "^0.17.2" },
   "publishConfig": { "access": "public" },
-  "gitHead": "6e83233262e8614cd725c601173e20c877d4c60d"
+  "gitHead": "ddf54318bd81f6321233db8cfef8b991eb161413"
 }