@stryke/string-format 0.4.11 → 0.5.0

package/dist/title-case.cjs

@@ -3,11 +3,18 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.LOWER_CASE_WHEN_NOT_FIRST = exports.FORMAT_MAPPING = void 0;
 exports.titleCase = titleCase;
 var _acronyms = require("./acronyms.cjs");
 var _upperCaseFirst = require("./upper-case-first.cjs");
-function titleCase(e) {
-  if (!e) return e;
-  const s = t => t.toLowerCase().split(/[\s\-_]+/).filter(Boolean).map(r => _acronyms.ACRONYMS.includes(r.toUpperCase()) ? r.toUpperCase() : `${(0, _upperCaseFirst.upperCaseFirst)(r.toLowerCase())}`).join(" ");
-  return e.split(/\s+-\s+/).map(t => s(t)).join(" - ");
+const FORMAT_MAPPING = exports.FORMAT_MAPPING = _acronyms.ACRONYMS.reduce((s, e) => (s[e.toLowerCase()] = e, s), {
+    cspell: "CSpell",
+    eslint: "ESLint",
+    nx: "Nx"
+  }),
+  LOWER_CASE_WHEN_NOT_FIRST = exports.LOWER_CASE_WHEN_NOT_FIRST = ["a", "an", "the", "is", "are", "of", "and", "to", "in", "for", "on", "with", "as", "at", "by"];
+function titleCase(s, e = {}) {
+  if (!s) return s;
+  const n = r => r.toLowerCase().split(/[\s\-_]+/).filter(Boolean).map((t, i) => !e.skipLowerCaseWhenNotFirst && LOWER_CASE_WHEN_NOT_FIRST.includes(t.toLowerCase()) && i > 0 ? t.toLowerCase() : !e.skipFormatMapping && Object.keys(FORMAT_MAPPING).includes(t.toLowerCase()) ? FORMAT_MAPPING[t.toLowerCase()] : e.mapping && Object.keys(e.mapping).includes(t.toLowerCase()) ? e.mapping[t.toLowerCase()] : `${(0, _upperCaseFirst.upperCaseFirst)(t.toLowerCase())}`).join(" ");
+  return s.split(/\s+-\s+/).map(r => n(r)).join(" - ");
 }

package/dist/title-case.d.ts

@@ -1,3 +1,33 @@
+export declare const FORMAT_MAPPING: Record<string, string>;
+export declare const LOWER_CASE_WHEN_NOT_FIRST: string[];
+export interface TitleCaseOptions {
+    /**
+     * If true, skip the format mapping. This will skip the conversion of known acronyms to their upper case form.
+     *
+     * @remarks
+     * The current list of word format mappings is stored in {@link FORMAT_MAPPING}.
+     *
+     * @defaultValue false
+     */
+    skipFormatMapping?: boolean;
+    /**
+     * If true, lower case words that are not the first word in the title.
+     *
+     * @remarks
+     * The current list of words that are lower cased when not first are stored in {@link LOWER_CASE_WHEN_NOT_FIRST}.
+     *
+     *
+     * @defaultValue false
+     */
+    skipLowerCaseWhenNotFirst?: boolean;
+    /**
+     * A custom mapping of words to their formatted versions.
+     *
+     * @remarks
+     * This allows you to provide your own mappings for specific words that should be formatted in a certain way.
+     */
+    mapping?: Record<string, string>;
+}
 /**
  * Convert the input string to title case.
  *
@@ -7,4 +37,4 @@
  * @param input - The input string.
  * @returns The title cased string.
  */
-export declare function titleCase<T extends string | undefined>(input?: T): T;
+export declare function titleCase<T extends string | undefined>(input?: T, options?: TitleCaseOptions): T;

package/dist/title-case.mjs

@@ -1 +1 @@
-import{ACRONYMS as o}from"./acronyms";import{upperCaseFirst as n}from"./upper-case-first";export function titleCase(e){if(!e)return e;const s=t=>t.toLowerCase().split(/[\s\-_]+/).filter(Boolean).map(r=>o.includes(r.toUpperCase())?r.toUpperCase():`${n(r.toLowerCase())}`).join(" ");return e.split(/\s+-\s+/).map(t=>s(t)).join(" - ")}
+import{ACRONYMS as a}from"./acronyms";import{upperCaseFirst as o}from"./upper-case-first";export const FORMAT_MAPPING=a.reduce((s,e)=>(s[e.toLowerCase()]=e,s),{cspell:"CSpell",eslint:"ESLint",nx:"Nx"}),LOWER_CASE_WHEN_NOT_FIRST=["a","an","the","is","are","of","and","to","in","for","on","with","as","at","by"];export function titleCase(s,e={}){if(!s)return s;const n=r=>r.toLowerCase().split(/[\s\-_]+/).filter(Boolean).map((t,i)=>!e.skipLowerCaseWhenNotFirst&&LOWER_CASE_WHEN_NOT_FIRST.includes(t.toLowerCase())&&i>0?t.toLowerCase():!e.skipFormatMapping&&Object.keys(FORMAT_MAPPING).includes(t.toLowerCase())?FORMAT_MAPPING[t.toLowerCase()]:e.mapping&&Object.keys(e.mapping).includes(t.toLowerCase())?e.mapping[t.toLowerCase()]:`${o(t.toLowerCase())}`).join(" ");return s.split(/\s+-\s+/).map(r=>n(r)).join(" - ")}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stryke/string-format",
-  "version": "0.4.11",
+  "version": "0.5.0",
   "type": "module",
   "description": "A package containing utility functions to transform strings into various formats.",
   "repository": {
@@ -10,7 +10,7 @@
   },
   "private": false,
   "publishConfig": { "access": "public" },
-  "dependencies": { "@stryke/helpers": "^0.6.1", "@stryke/types": "^0.8.4" },
+  "dependencies": { "@stryke/helpers": "^0.6.2", "@stryke/types": "^0.8.5" },
   "devDependencies": {},
   "sideEffects": false,
   "files": ["dist/**/*"],