@stryke/string-format 0.1.3

package/dist/snake-case.cjs

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.snakeCase = void 0;
+var _types = require("@stryke/types");
+var _upperCaseFirst = require("./upper-case-first.cjs");
+const snakeCase = (t, n) => {
+  if (!t) return "";
+  const r = t?.replace(/(?<temp1>[A-Z])+/g, e => (0, _upperCaseFirst.upperCaseFirst)(e) ?? _types.EMPTY_STRING).split(/(?=[A-Z])|[\s._-]/).map(e => e.toLowerCase()) ?? [];
+  if (r.length === 0) return "";
+  if (r.length === 1) return r[0];
+  const s = r.reduce((e, i) => `${e}_${i.toLowerCase()}`);
+  return n?.splitOnNumber === !1 ? s : s.replace(/(?<temp1>[A-Za-z]\d)/, e => `${e[0]}_${e[1]}`);
+};
+exports.snakeCase = snakeCase;

package/dist/snake-case.d.ts

@@ -0,0 +1,14 @@
+export interface SnakeCaseOptions {
+    splitOnNumber: boolean;
+}
+/**
+ * Convert the input string to snake case.
+ *
+ *  @remarks
+ * "this_is_an_example"
+ *
+ * @param input - The input string.
+ * @param options - Options to control the behavior of the function.
+ * @returns The snake-cased string.
+ */
+export declare const snakeCase: (input?: string, options?: SnakeCaseOptions) => string;

package/dist/snake-case.mjs

@@ -0,0 +1 @@
+import{EMPTY_STRING as o}from"@stryke/types";import{upperCaseFirst as a}from"./upper-case-first";export const snakeCase=(t,n)=>{if(!t)return"";const r=t?.replace(/(?<temp1>[A-Z])+/g,e=>a(e)??o).split(/(?=[A-Z])|[\s._-]/).map(e=>e.toLowerCase())??[];if(r.length===0)return"";if(r.length===1)return r[0];const s=r.reduce((e,i)=>`${e}_${i.toLowerCase()}`);return n?.splitOnNumber===!1?s:s.replace(/(?<temp1>[A-Za-z]\d)/,e=>`${e[0]}_${e[1]}`)};

package/dist/start-case.cjs

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.startCase = startCase;
+var _getWords = require("./get-words.cjs");
+function startCase(o) {
+  const e = (0, _getWords.getWords)(o.trim());
+  let t = "";
+  for (const r of e) r && r[0] && (t && (t += " "), t += r === r.toUpperCase() ? r : r[0].toUpperCase() + r.slice(1).toLowerCase());
+  return t;
+}

package/dist/start-case.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Converts the first character of each word in a string to uppercase and the remaining characters to lowercase.
+ *
+ * @remarks
+ * "This Is An Example"
+ *
+ * Start case is the naming convention in which each word is written with an initial capital letter.
+ *
+ * @example
+ * ```ts
+ * const result1 = startCase('hello world');  // result will be 'Hello World'
+ * const result2 = startCase('HELLO WORLD');  // result will be 'Hello World'
+ * const result3 = startCase('hello-world');  // result will be 'Hello World'
+ * const result4 = startCase('hello_world');  // result will be 'Hello World'
+ * ```
+ *
+ * @param str - The string to convert.
+ * @returns The converted string.
+ */
+export declare function startCase(str: string): string;

package/dist/start-case.mjs

@@ -0,0 +1 @@
+import{getWords as s}from"./get-words";export function startCase(o){const e=s(o.trim());let t="";for(const r of e)r&&r[0]&&(t&&(t+=" "),t+=r===r.toUpperCase()?r:r[0].toUpperCase()+r.slice(1).toLowerCase());return t}

package/dist/strip-indents.cjs

@@ -0,0 +1,11 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.stripIndents = stripIndents;
+function stripIndents(n, ...r) {
+  return String.raw(n, ...r).split(`
+`).map(t => t.trim()).join(`
+`).trim();
+}

package/dist/strip-indents.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Removes indents, which is useful for printing warning and messages.
+ *
+ * @example
+ * ```ts
+ * stripIndents`
+ *  Options:
+ *  - option1
+ *  - option2
+ * `
+ * ```
+ *
+ * @param strings - Template strings
+ * @param values - Additional values
+ * @returns The stripped string
+ */
+export declare function stripIndents(strings: TemplateStringsArray, ...values: any[]): string;

package/dist/strip-indents.mjs

@@ -0,0 +1,3 @@
+export function stripIndents(n,...r){return String.raw(n,...r).split(`
+`).map(t=>t.trim()).join(`
+`).trim()}

package/dist/title-case.cjs

@@ -0,0 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.titleCase = void 0;
+var _acronyms = require("./acronyms.cjs");
+var _upperCaseFirst = require("./upper-case-first.cjs");
+const titleCase = e => e ? e.split(/(?=[A-Z])|[\s._-]/).map(r => r.trim()).filter(Boolean).map(r => _acronyms.ACRONYMS.includes(r) ? r.toUpperCase() : (0, _upperCaseFirst.upperCaseFirst)(r.toLowerCase())).join(" ") : "";
+exports.titleCase = titleCase;

package/dist/title-case.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Convert the input string to title case.
+ *
+ *  @remarks
+ * "This Is An Example"
+ *
+ * @param input - The input string.
+ * @returns The title cased string.
+ */
+export declare const titleCase: (input?: string) => string | undefined;

package/dist/title-case.mjs

@@ -0,0 +1 @@
+import{ACRONYMS as t}from"./acronyms";import{upperCaseFirst as i}from"./upper-case-first";export const titleCase=e=>e?e.split(/(?=[A-Z])|[\s._-]/).map(r=>r.trim()).filter(Boolean).map(r=>t.includes(r)?r.toUpperCase():i(r.toLowerCase())).join(" "):"";

package/dist/unescape.cjs

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.unescape = unescape;
+const n = {
+  "&": "&",
+  "&lt;": "<",
+  "&gt;": ">",
+  "&quot;": '"',
+  "&#39;": "'"
+};
+function unescape(t) {
+  return t.replace(/&(?:amp|lt|gt|quot|#(?<temp1>0+)?39);/g, e => n[e] || "'");
+}

package/dist/unescape.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Converts the HTML entities `&`, `<`, `>`, `"`, and `'` in `str` to their corresponding characters.
+ * It is the inverse of `escape`.
+ *
+ * @example
+ * ```ts
+ * unescape('This is a &lt;div&gt; element.'); // returns 'This is a <div> element.'
+ * unescape('This is a &quot;quote&quot;'); // returns 'This is a "quote"'
+ * unescape('This is a &#39;quote&#39;'); // returns 'This is a 'quote''
+ * unescape('This is a &amp; symbol'); // returns 'This is a & symbol'
+ * ```
+ *
+ * @param str - The string to unescape.
+ * @returns Returns the unescaped string.
+ */
+export declare function unescape(str: string): string;

package/dist/unescape.mjs

@@ -0,0 +1 @@
+const n={"&amp;":"&","&lt;":"<","&gt;":">","&quot;":'"',"&#39;":"'"};export function unescape(t){return t.replace(/&(?:amp|lt|gt|quot|#(?<temp1>0+)?39);/g,e=>n[e]||"'")}

package/dist/upper-case-first.cjs

@@ -0,0 +1,8 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.upperCaseFirst = void 0;
+const upperCaseFirst = e => e && e.charAt(0).toUpperCase() + e.slice(1);
+exports.upperCaseFirst = upperCaseFirst;

package/dist/upper-case-first.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Upper case the first character of an input string.
+ *
+ *  @remarks
+ * "Thisisanexample"
+ *
+ * @param input - The input string.
+ * @returns The capitalized string.
+ */
+export declare const upperCaseFirst: (input?: string) => string | undefined;

package/dist/upper-case-first.mjs

@@ -0,0 +1 @@
+export const upperCaseFirst=e=>e&&e.charAt(0).toUpperCase()+e.slice(1);

package/package.json

@@ -0,0 +1,337 @@
+{
+  "name": "@stryke/string-format",
+  "version": "0.1.3",
+  "type": "module",
+  "description": "🌩️ A monorepo containing TypeScript utility packages with shared functionality common to many Storm Software applications.",
+  "repository": {
+    "type": "github",
+    "url": "https://github.com/storm-software/stryke.git",
+    "directory": "packages/string-format"
+  },
+  "private": false,
+  "publishConfig": { "access": "public" },
+  "dependencies": { "@stryke/helpers": ">=0.1.0", "@stryke/types": ">=0.1.1" },
+  "devDependencies": {},
+  "sideEffects": false,
+  "files": ["dist/**/*"],
+  "homepage": "https://stormsoftware.com",
+  "bugs": {
+    "url": "https://stormsoftware.com/support",
+    "email": "support@stormsoftware.com"
+  },
+  "license": "Apache-2.0",
+  "keywords": [
+    "stryke",
+    "typescript",
+    "utilities",
+    "storm-stack",
+    "storm-software",
+    "storm",
+    "storm-ops",
+    "cyclone-ui",
+    "sullivanpj",
+    "monorepo"
+  ],
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/storm-software"
+  },
+  "author": {
+    "name": "Storm Software",
+    "email": "contact@stormsoftware.com",
+    "url": "https://stormsoftware.com"
+  },
+  "maintainers": [
+    {
+      "name": "Storm Software",
+      "email": "contact@stormsoftware.com",
+      "url": "https://stormsoftware.com"
+    }
+  ],
+  "contributors": [
+    {
+      "name": "Storm Software",
+      "email": "contact@stormsoftware.com",
+      "url": "https://stormsoftware.com"
+    }
+  ],
+  "exports": {
+    "./upper-case-first": {
+      "import": {
+        "types": "./dist/upper-case-first.d.ts",
+        "default": "./dist/upper-case-first.mjs"
+      },
+      "require": {
+        "types": "./dist/upper-case-first.d.ts",
+        "default": "./dist/upper-case-first.cjs"
+      },
+      "default": {
+        "types": "./dist/upper-case-first.d.ts",
+        "default": "./dist/upper-case-first.mjs"
+      }
+    },
+    "./unescape": {
+      "import": {
+        "types": "./dist/unescape.d.ts",
+        "default": "./dist/unescape.mjs"
+      },
+      "require": {
+        "types": "./dist/unescape.d.ts",
+        "default": "./dist/unescape.cjs"
+      },
+      "default": {
+        "types": "./dist/unescape.d.ts",
+        "default": "./dist/unescape.mjs"
+      }
+    },
+    "./title-case": {
+      "import": {
+        "types": "./dist/title-case.d.ts",
+        "default": "./dist/title-case.mjs"
+      },
+      "require": {
+        "types": "./dist/title-case.d.ts",
+        "default": "./dist/title-case.cjs"
+      },
+      "default": {
+        "types": "./dist/title-case.d.ts",
+        "default": "./dist/title-case.mjs"
+      }
+    },
+    "./strip-indents": {
+      "import": {
+        "types": "./dist/strip-indents.d.ts",
+        "default": "./dist/strip-indents.mjs"
+      },
+      "require": {
+        "types": "./dist/strip-indents.d.ts",
+        "default": "./dist/strip-indents.cjs"
+      },
+      "default": {
+        "types": "./dist/strip-indents.d.ts",
+        "default": "./dist/strip-indents.mjs"
+      }
+    },
+    "./start-case": {
+      "import": {
+        "types": "./dist/start-case.d.ts",
+        "default": "./dist/start-case.mjs"
+      },
+      "require": {
+        "types": "./dist/start-case.d.ts",
+        "default": "./dist/start-case.cjs"
+      },
+      "default": {
+        "types": "./dist/start-case.d.ts",
+        "default": "./dist/start-case.mjs"
+      }
+    },
+    "./snake-case": {
+      "import": {
+        "types": "./dist/snake-case.d.ts",
+        "default": "./dist/snake-case.mjs"
+      },
+      "require": {
+        "types": "./dist/snake-case.d.ts",
+        "default": "./dist/snake-case.cjs"
+      },
+      "default": {
+        "types": "./dist/snake-case.d.ts",
+        "default": "./dist/snake-case.mjs"
+      }
+    },
+    "./pretty-bytes": {
+      "import": {
+        "types": "./dist/pretty-bytes.d.ts",
+        "default": "./dist/pretty-bytes.mjs"
+      },
+      "require": {
+        "types": "./dist/pretty-bytes.d.ts",
+        "default": "./dist/pretty-bytes.cjs"
+      },
+      "default": {
+        "types": "./dist/pretty-bytes.d.ts",
+        "default": "./dist/pretty-bytes.mjs"
+      }
+    },
+    "./period-split": {
+      "import": {
+        "types": "./dist/period-split.d.ts",
+        "default": "./dist/period-split.mjs"
+      },
+      "require": {
+        "types": "./dist/period-split.d.ts",
+        "default": "./dist/period-split.cjs"
+      },
+      "default": {
+        "types": "./dist/period-split.d.ts",
+        "default": "./dist/period-split.mjs"
+      }
+    },
+    "./pascal-case": {
+      "import": {
+        "types": "./dist/pascal-case.d.ts",
+        "default": "./dist/pascal-case.mjs"
+      },
+      "require": {
+        "types": "./dist/pascal-case.d.ts",
+        "default": "./dist/pascal-case.cjs"
+      },
+      "default": {
+        "types": "./dist/pascal-case.d.ts",
+        "default": "./dist/pascal-case.mjs"
+      }
+    },
+    "./pad": {
+      "import": { "types": "./dist/pad.d.ts", "default": "./dist/pad.mjs" },
+      "require": { "types": "./dist/pad.d.ts", "default": "./dist/pad.cjs" },
+      "default": { "types": "./dist/pad.d.ts", "default": "./dist/pad.mjs" }
+    },
+    "./normalize-email": {
+      "import": {
+        "types": "./dist/normalize-email.d.ts",
+        "default": "./dist/normalize-email.mjs"
+      },
+      "require": {
+        "types": "./dist/normalize-email.d.ts",
+        "default": "./dist/normalize-email.cjs"
+      },
+      "default": {
+        "types": "./dist/normalize-email.d.ts",
+        "default": "./dist/normalize-email.mjs"
+      }
+    },
+    "./lower-case-first": {
+      "import": {
+        "types": "./dist/lower-case-first.d.ts",
+        "default": "./dist/lower-case-first.mjs"
+      },
+      "require": {
+        "types": "./dist/lower-case-first.d.ts",
+        "default": "./dist/lower-case-first.cjs"
+      },
+      "default": {
+        "types": "./dist/lower-case-first.d.ts",
+        "default": "./dist/lower-case-first.mjs"
+      }
+    },
+    "./kebab-case": {
+      "import": {
+        "types": "./dist/kebab-case.d.ts",
+        "default": "./dist/kebab-case.mjs"
+      },
+      "require": {
+        "types": "./dist/kebab-case.d.ts",
+        "default": "./dist/kebab-case.cjs"
+      },
+      "default": {
+        "types": "./dist/kebab-case.d.ts",
+        "default": "./dist/kebab-case.mjs"
+      }
+    },
+    "./index": {
+      "import": { "types": "./dist/index.d.ts", "default": "./dist/index.mjs" },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.cjs"
+      },
+      "default": { "types": "./dist/index.d.ts", "default": "./dist/index.mjs" }
+    },
+    "./get-words": {
+      "import": {
+        "types": "./dist/get-words.d.ts",
+        "default": "./dist/get-words.mjs"
+      },
+      "require": {
+        "types": "./dist/get-words.d.ts",
+        "default": "./dist/get-words.cjs"
+      },
+      "default": {
+        "types": "./dist/get-words.d.ts",
+        "default": "./dist/get-words.mjs"
+      }
+    },
+    "./escape": {
+      "import": {
+        "types": "./dist/escape.d.ts",
+        "default": "./dist/escape.mjs"
+      },
+      "require": {
+        "types": "./dist/escape.d.ts",
+        "default": "./dist/escape.cjs"
+      },
+      "default": {
+        "types": "./dist/escape.d.ts",
+        "default": "./dist/escape.mjs"
+      }
+    },
+    "./deburr": {
+      "import": {
+        "types": "./dist/deburr.d.ts",
+        "default": "./dist/deburr.mjs"
+      },
+      "require": {
+        "types": "./dist/deburr.d.ts",
+        "default": "./dist/deburr.cjs"
+      },
+      "default": {
+        "types": "./dist/deburr.d.ts",
+        "default": "./dist/deburr.mjs"
+      }
+    },
+    "./constant-case": {
+      "import": {
+        "types": "./dist/constant-case.d.ts",
+        "default": "./dist/constant-case.mjs"
+      },
+      "require": {
+        "types": "./dist/constant-case.d.ts",
+        "default": "./dist/constant-case.cjs"
+      },
+      "default": {
+        "types": "./dist/constant-case.d.ts",
+        "default": "./dist/constant-case.mjs"
+      }
+    },
+    "./camel-case": {
+      "import": {
+        "types": "./dist/camel-case.d.ts",
+        "default": "./dist/camel-case.mjs"
+      },
+      "require": {
+        "types": "./dist/camel-case.d.ts",
+        "default": "./dist/camel-case.cjs"
+      },
+      "default": {
+        "types": "./dist/camel-case.d.ts",
+        "default": "./dist/camel-case.mjs"
+      }
+    },
+    "./acronyms": {
+      "import": {
+        "types": "./dist/acronyms.d.ts",
+        "default": "./dist/acronyms.mjs"
+      },
+      "require": {
+        "types": "./dist/acronyms.d.ts",
+        "default": "./dist/acronyms.cjs"
+      },
+      "default": {
+        "types": "./dist/acronyms.d.ts",
+        "default": "./dist/acronyms.mjs"
+      }
+    },
+    ".": {
+      "import": { "types": "./dist/index.d.ts", "default": "./dist/index.mjs" },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.cjs"
+      },
+      "default": { "types": "./dist/index.d.ts", "default": "./dist/index.mjs" }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts"
+}