@stryke/string-format 0.5.2 → 0.6.0

package/dist/camel-case.cjs

@@ -4,8 +4,12 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.camelCase = camelCase;
+exports.isCamelCase = isCamelCase;
 var _lowerCaseFirst = require("./lower-case-first.cjs");
 var _pascalCase = require("./pascal-case.cjs");
+function isCamelCase(e) {
+  return e ? /^[a-z][a-zA-Z0-9]*$/.test(e) : !1;
+}
 function camelCase(e) {
-  return e && (0, _lowerCaseFirst.lowerCaseFirst)((0, _pascalCase.pascalCase)(e));
+  return isCamelCase(e) || e === void 0 ? e : (0, _lowerCaseFirst.lowerCaseFirst)((0, _pascalCase.pascalCase)(e));
 }

package/dist/camel-case.d.ts

@@ -1,8 +1,18 @@
+/**
+ * Check if the input string is in camel case.
+ *
+ * @remarks
+ * Camel case is defined as a lowercase first letter followed by any number of uppercase letters and digits - "thisIsAnExample".
+ *
+ * @param input - The input string to check.
+ * @returns True if the input is in camel case, false otherwise.
+ */
+export declare function isCamelCase(input: string | undefined): boolean;
 /**
  * Convert the input string to camel case.
  *
  * @remarks
- * "thisIsAnExample"
+ * Camel case is defined as a lowercase first letter followed by any number of uppercase letters and digits - "thisIsAnExample".
  *
  * @param input - The input string.
  * @returns The camel-cased string.

package/dist/camel-case.mjs

@@ -1 +1 @@
-import{lowerCaseFirst as r}from"./lower-case-first";import{pascalCase as o}from"./pascal-case";export function camelCase(e){return e&&r(o(e))}
+import{lowerCaseFirst as r}from"./lower-case-first";import{pascalCase as a}from"./pascal-case";export function isCamelCase(e){return e?/^[a-z][a-zA-Z0-9]*$/.test(e):!1}export function camelCase(e){return isCamelCase(e)||e===void 0?e:r(a(e))}

package/dist/constant-case.cjs

@@ -4,7 +4,12 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.constantCase = constantCase;
+exports.isConstantCase = isConstantCase;
+var _getWords = require("./get-words.cjs");
 var _snakeCase = require("./snake-case.cjs");
+function isConstantCase(e) {
+  return e ? /^[A-Z0-9_]+$/.test(e) : !1;
+}
 function constantCase(e) {
-  return (0, _snakeCase.snakeCase)(e)?.toUpperCase();
+  return isConstantCase(e) || e === void 0 ? e : (0, _snakeCase.isSnakeCase)(e) ? e.toUpperCase() : (0, _getWords.getWords)(e).join("_").toUpperCase();
 }

package/dist/constant-case.d.ts

@@ -1,8 +1,18 @@
+/**
+ * Check if the input string is in constant case.
+ *
+ * @remarks
+ * Constant case is defined as all uppercase letters with underscores separating words - "THIS_IS_AN_EXAMPLE".
+ *
+ * @param input - The input string to check.
+ * @returns True if the input is in constant case, false otherwise.
+ */
+export declare function isConstantCase(input: string | undefined): boolean;
 /**
  * Convert the input string to constant case.
  *
  * @remarks
- * "THIS_IS_AN_EXAMPLE"
+ * Constant case is defined as all uppercase letters with underscores separating words - "THIS_IS_AN_EXAMPLE".
  *
  * @param input - The input string.
  * @returns The constant-cased string.

package/dist/constant-case.mjs

@@ -1 +1 @@
-import{snakeCase as n}from"./snake-case";export function constantCase(e){return n(e)?.toUpperCase()}
+import{getWords as s}from"./get-words";import{isSnakeCase as n}from"./snake-case";export function isConstantCase(e){return e?/^[A-Z0-9_]+$/.test(e):!1}export function constantCase(e){return isConstantCase(e)||e===void 0?e:n(e)?e.toUpperCase():s(e).join("_").toUpperCase()}

package/dist/kebab-case.cjs

@@ -3,9 +3,14 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.isKebabCase = isKebabCase;
 exports.kebabCase = kebabCase;
 var _getWords = require("./get-words.cjs");
+function isKebabCase(e) {
+  return e ? /^[a-z]+(?:-[a-z0-9]+)*$/.test(e) : !1;
+}
 function kebabCase(e) {
+  if (isKebabCase(e) || e === void 0) return e;
   const r = e ? (0, _getWords.getWords)(e) : [];
   return r.length === 0 ? "" : r.join("-").toLowerCase();
 }

package/dist/kebab-case.d.ts

@@ -1,8 +1,18 @@
+/**
+ * Check if the input string is in kebab case.
+ *
+ * @remarks
+ * Kebab case is defined as all lowercase letters with hyphens separating words - "this-is-an-example".
+ *
+ * @param input - The input string to check.
+ * @returns True if the input is in kebab case, false otherwise.
+ */
+export declare function isKebabCase(input: string | undefined): boolean;
 /**
  * Convert the input string to kebab case.
  *
  * @remarks
- * "this-is-an-example"
+ * Kebab case is defined as all lowercase letters with hyphens separating words - "this-is-an-example".
  *
  * @param input - The input string.
  * @returns The kebab-cased string.

package/dist/kebab-case.mjs

@@ -1 +1 @@
-import{getWords as t}from"./get-words";export function kebabCase(e){const r=e?t(e):[];return r.length===0?"":r.join("-").toLowerCase()}
+import{getWords as n}from"./get-words";export function isKebabCase(e){return e?/^[a-z]+(?:-[a-z0-9]+)*$/.test(e):!1}export function kebabCase(e){if(isKebabCase(e)||e===void 0)return e;const r=e?n(e):[];return r.length===0?"":r.join("-").toLowerCase()}

package/dist/pascal-case.cjs

@@ -3,7 +3,12 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.isPascalCase = isPascalCase;
 exports.pascalCase = pascalCase;
-function pascalCase(t) {
-  return t && t.split(" ").map(e => e.split("-")).flat().map(e => e.length > 0 ? e.trim().charAt(0).toUpperCase() + e.trim().slice(1) : "").join("");
+var _getWords = require("./get-words.cjs");
+function isPascalCase(e) {
+  return e ? /^[A-Z][a-zA-Z0-9]*$/.test(e) : !1;
+}
+function pascalCase(e) {
+  return isPascalCase(e) || e === void 0 ? e : (0, _getWords.getWords)(e).map(r => r.length > 0 ? r.trim().charAt(0).toUpperCase() + r.trim().slice(1) : "").join("");
 }

package/dist/pascal-case.d.ts

@@ -1,8 +1,18 @@
+/**
+ * Check if the input string is in pascal case.
+ *
+ * @remarks
+ * Pascal case is defined as an uppercase first letter followed by any number of lowercase letters and digits - "ThisIsAnExample".
+ *
+ * @param input - The input string to check.
+ * @returns True if the input is in pascal case, false otherwise.
+ */
+export declare function isPascalCase(input: string | undefined): boolean;
 /**
  * Convert the input string to pascal case.
  *
  *  @remarks
- * "ThisIsAnExample"
+ * Pascal case is defined as an uppercase first letter followed by any number of lowercase letters and digits - "ThisIsAnExample".
  *
  * @param input - The input string.
  * @returns The pascal-cased string.

package/dist/pascal-case.mjs

@@ -1 +1 @@
-export function pascalCase(t){return t&&t.split(" ").map(e=>e.split("-")).flat().map(e=>e.length>0?e.trim().charAt(0).toUpperCase()+e.trim().slice(1):"").join("")}
+import{getWords as n}from"./get-words";export function isPascalCase(e){return e?/^[A-Z][a-zA-Z0-9]*$/.test(e):!1}export function pascalCase(e){return isPascalCase(e)||e===void 0?e:n(e).map(r=>r.length>0?r.trim().charAt(0).toUpperCase()+r.trim().slice(1):"").join("")}

package/dist/snake-case.cjs

@@ -3,14 +3,20 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.isSnakeCase = isSnakeCase;
 exports.snakeCase = snakeCase;
 var _types = require("@stryke/types");
+var _constantCase = require("./constant-case.cjs");
 var _upperCaseFirst = require("./upper-case-first.cjs");
-function snakeCase(t, n) {
-  if (!t) return t;
-  const r = t?.replace(/[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(/[A-Z]\d/i, e => `${e[0]}_${e[1]}`);
+function isSnakeCase(e) {
+  return e ? /^[a-z]+(?:_[a-z0-9]+)*$/.test(e) : !1;
+}
+function snakeCase(e, n) {
+  if (isSnakeCase(e) || e === void 0) return e;
+  if ((0, _constantCase.isConstantCase)(e)) return e.toLowerCase();
+  const s = e?.replace(/[A-Z]+/g, r => (0, _upperCaseFirst.upperCaseFirst)(r) ?? _types.EMPTY_STRING).split(/(?=[A-Z])|[\s._-]/).map(r => r.toLowerCase()) ?? [];
+  if (s.length === 0) return "";
+  if (s.length === 1) return s[0];
+  const t = s.reduce((r, a) => `${r}_${a.toLowerCase()}`);
+  return n?.splitOnNumber === !1 ? t : t.replace(/[A-Z]\d/i, r => `${r[0]}_${r[1]}`);
 }

package/dist/snake-case.d.ts

@@ -1,11 +1,21 @@
 export interface SnakeCaseOptions {
     splitOnNumber: boolean;
 }
+/**
+ * Check if the input string is in snake case.
+ *
+ * @remarks
+ * Snake case is defined as all lowercase letters with underscores separating words - "this_is_an_example"
+ *
+ * @param input - The input string to check.
+ * @returns True if the input is in snake case, false otherwise.
+ */
+export declare function isSnakeCase(input: string | undefined): boolean;
 /**
  * Convert the input string to snake case.
  *
  *  @remarks
- * "this_is_an_example"
+ * Snake case is defined as all lowercase letters with underscores separating words - "this_is_an_example"
  *
  * @param input - The input string.
  * @param options - Options to control the behavior of the function.

package/dist/snake-case.mjs

@@ -1 +1 @@
-import{EMPTY_STRING as a}from"@stryke/types";import{upperCaseFirst as o}from"./upper-case-first";export function snakeCase(t,n){if(!t)return t;const r=t?.replace(/[A-Z]+/g,e=>o(e)??a).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(/[A-Z]\d/i,e=>`${e[0]}_${e[1]}`)}
+import{EMPTY_STRING as o}from"@stryke/types";import{isConstantCase as i}from"./constant-case";import{upperCaseFirst as f}from"./upper-case-first";export function isSnakeCase(e){return e?/^[a-z]+(?:_[a-z0-9]+)*$/.test(e):!1}export function snakeCase(e,n){if(isSnakeCase(e)||e===void 0)return e;if(i(e))return e.toLowerCase();const s=e?.replace(/[A-Z]+/g,r=>f(r)??o).split(/(?=[A-Z])|[\s._-]/).map(r=>r.toLowerCase())??[];if(s.length===0)return"";if(s.length===1)return s[0];const t=s.reduce((r,a)=>`${r}_${a.toLowerCase()}`);return n?.splitOnNumber===!1?t:t.replace(/[A-Z]\d/i,r=>`${r[0]}_${r[1]}`)}

package/dist/start-case.cjs

@@ -3,12 +3,16 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.isStartCase = isStartCase;
 exports.startCase = startCase;
 var _getWords = require("./get-words.cjs");
-function startCase(t) {
-  if (!t) return t;
-  const o = (0, _getWords.getWords)(t.trim());
-  let r = "";
-  for (const e of o) e && e[0] && (r && (r += " "), r += e === e.toUpperCase() ? e : e[0].toUpperCase() + e.slice(1).toLowerCase());
-  return r;
+function isStartCase(e) {
+  return e ? /^[A-Z][a-z]*(?: [A-Z][a-z]*)*$/.test(e) : !1;
+}
+function startCase(e) {
+  if (isStartCase(e) || e === void 0) return e;
+  const s = (0, _getWords.getWords)(e.trim());
+  let t = "";
+  for (const r of s) 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

@@ -1,10 +1,18 @@
 /**
- * Converts the first character of each word in a string to uppercase and the remaining characters to lowercase.
+ * Check if the input string is in snake case.
  *
  * @remarks
- * "This Is An Example"
+ * Start case is the naming convention in which each word is written with an initial capital letter - "This Is An Example".
+ *
+ * @param input - The input string to check.
+ * @returns True if the input is in start case, false otherwise.
+ */
+export declare function isStartCase(input: string | undefined): boolean;
+/**
+ * Converts the first character of each word in a string to uppercase and the remaining characters to lowercase.
  *
- * Start case is the naming convention in which each word is written with an initial capital letter.
+ * @remarks
+ * Start case is the naming convention in which each word is written with an initial capital letter - "This Is An Example".
  *
  * @example
  * ```ts

package/dist/start-case.mjs

@@ -1 +1 @@
-import{getWords as s}from"./get-words";export function startCase(t){if(!t)return t;const o=s(t.trim());let r="";for(const e of o)e&&e[0]&&(r&&(r+=" "),r+=e===e.toUpperCase()?e:e[0].toUpperCase()+e.slice(1).toLowerCase());return r}
+import{getWords as o}from"./get-words";export function isStartCase(e){return e?/^[A-Z][a-z]*(?: [A-Z][a-z]*)*$/.test(e):!1}export function startCase(e){if(isStartCase(e)||e===void 0)return e;const s=o(e.trim());let t="";for(const r of s)r&&r[0]&&(t&&(t+=" "),t+=r===r.toUpperCase()?r:r[0].toUpperCase()+r.slice(1).toLowerCase());return t}

package/dist/title-case.cjs

@@ -4,17 +4,21 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.LOWER_CASE_WHEN_NOT_FIRST = exports.FORMAT_MAPPING = void 0;
+exports.isTitleCase = isTitleCase;
 exports.titleCase = titleCase;
 var _acronyms = require("./acronyms.cjs");
 var _upperCaseFirst = require("./upper-case-first.cjs");
-const FORMAT_MAPPING = exports.FORMAT_MAPPING = _acronyms.ACRONYMS.reduce((s, e) => (s[e.toLowerCase()] = e, s), {
+const FORMAT_MAPPING = exports.FORMAT_MAPPING = _acronyms.ACRONYMS.reduce((e, t) => (e[t.toLowerCase()] = t, e), {
     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(" - ");
+function isTitleCase(e) {
+  return e ? e.split(/[\s\-_]+/).filter(Boolean).every((s, n) => Object.values(FORMAT_MAPPING).includes(s) || n > 0 && LOWER_CASE_WHEN_NOT_FIRST.includes(s.toLowerCase()) && s === s.toLowerCase() ? !0 : /^[A-Z][a-z0-9]*$/.test(s)) : !1;
+}
+function titleCase(e, t = {}) {
+  if (isTitleCase(e) || e === void 0) return e;
+  const s = n => n.toLowerCase().split(/[\s\-_]+/).filter(Boolean).map((r, i) => !t.skipLowerCaseWhenNotFirst && LOWER_CASE_WHEN_NOT_FIRST.includes(r.toLowerCase()) && i > 0 ? r.toLowerCase() : !t.skipFormatMapping && Object.keys(FORMAT_MAPPING).includes(r.toLowerCase()) ? FORMAT_MAPPING[r.toLowerCase()] : t.mapping && Object.keys(t.mapping).includes(r.toLowerCase()) ? t.mapping[r.toLowerCase()] : `${(0, _upperCaseFirst.upperCaseFirst)(r.toLowerCase())}`).join(" ");
+  return e.split(/\s+-\s+/).map(n => s(n)).join(" - ");
 }

package/dist/title-case.d.ts

@@ -28,13 +28,23 @@ export interface TitleCaseOptions {
      */
     mapping?: Record<string, string>;
 }
+/**
+ * Check if the input string is in title case.
+ *
+ * @remarks
+ * Title case is defined as a string where each word is separated by spaces, and starts with an uppercase letter followed by lowercase letters - "This Is An Example".
+ *
+ * @param input - The input string to check.
+ * @returns True if the input is in title case, false otherwise.
+ */
+export declare function isTitleCase(input: string | undefined): boolean;
 /**
  * Convert the input string to title case.
  *
  *  @remarks
- * "This Is An Example"
+ * Title case is defined as a string where each word is separated by spaces, and starts with an uppercase letter followed by lowercase letters - "This Is An Example".
  *
  * @param input - The input string.
  * @returns The title cased string.
  */
-export declare function titleCase<T extends string | undefined>(input?: T, options?: TitleCaseOptions): T;
+export declare function titleCase<T extends string | undefined>(input: T, options?: TitleCaseOptions): T;

package/dist/title-case.mjs

@@ -1 +1 @@
-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(" - ")}
+import{ACRONYMS as o}from"./acronyms";import{upperCaseFirst as a}from"./upper-case-first";export const FORMAT_MAPPING=o.reduce((e,t)=>(e[t.toLowerCase()]=t,e),{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 isTitleCase(e){return e?e.split(/[\s\-_]+/).filter(Boolean).every((s,n)=>Object.values(FORMAT_MAPPING).includes(s)||n>0&&LOWER_CASE_WHEN_NOT_FIRST.includes(s.toLowerCase())&&s===s.toLowerCase()?!0:/^[A-Z][a-z0-9]*$/.test(s)):!1}export function titleCase(e,t={}){if(isTitleCase(e)||e===void 0)return e;const s=n=>n.toLowerCase().split(/[\s\-_]+/).filter(Boolean).map((r,i)=>!t.skipLowerCaseWhenNotFirst&&LOWER_CASE_WHEN_NOT_FIRST.includes(r.toLowerCase())&&i>0?r.toLowerCase():!t.skipFormatMapping&&Object.keys(FORMAT_MAPPING).includes(r.toLowerCase())?FORMAT_MAPPING[r.toLowerCase()]:t.mapping&&Object.keys(t.mapping).includes(r.toLowerCase())?t.mapping[r.toLowerCase()]:`${a(r.toLowerCase())}`).join(" ");return e.split(/\s+-\s+/).map(n=>s(n)).join(" - ")}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stryke/string-format",
-  "version": "0.5.2",
+  "version": "0.6.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.2", "@stryke/types": "^0.8.6" },
+  "dependencies": { "@stryke/helpers": "^0.7.1", "@stryke/types": "^0.8.6" },
   "devDependencies": {},
   "sideEffects": false,
   "files": ["dist/**/*"],
@@ -333,5 +333,5 @@
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
-  "gitHead": "b72d8a5bebd6ce47e458809cab4392bb000ecd81"
+  "gitHead": "57da58e3434302b35f798674d9f18f92ca7f7ac9"
 }