stringzy 1.1.1 → 2.0.0

package/analysis.js

@@ -0,0 +1,21 @@
+
+export function wordCount(str) {
+  if (!str.trim()) return 0;
+  return str.trim().split(/\s+/).length;
+}
+
+
+export function characterCount(str) {
+    
+  return str.length;
+}
+
+export function characterFrequency(str) {
+  const frequency = {};
+  for (const char of str.toLowerCase()) {
+    if (char !== ' ') { // Exclude spaces for cleaner analysis
+      frequency[char] = (frequency[char] || 0) + 1;
+    }
+  }
+  return frequency;
+}

package/changelog.txt

@@ -0,0 +1,74 @@
+CHANGELOG
+
+All notable changes to the `stringzy` package will be documented in this file.
+
+=============================================================================
+Version 2.0.0 - 2025-05-22
+-----------------------------------------------------------------------------
+
+ADDED:
+- Added a dynamic list of APIs in README
+- Divided the package into 4 modules-transformations, validations, formatting and analysis
+- Added many new APIs 
+  - `camelCase`: Converts a string to camel case
+  - `kebabCase`: Converts a string to kebab case
+  - `snakeCase`: Converts a string to snake case
+  - `titleCase`: Converts a string to title case
+  - `constantCase`: Converts a string to constant case
+  - `pascalCase`: Converts a string to pascal case
+  - `isURL`: Validates if a string is a valid URL
+  - `isEmail`: Validates if a string is a valid email address
+  - `isEmpty`: Checks if a string is empty or contains only whitespace
+  - `wordCount`: Counts the number of words in a string
+  - `characterCount`: Counts the number of characters in a string
+  - `characterFrequency`: Calculates the frequency of each character in a string
+  - `capitalize`: Capitalizes the entire string
+  - `formatNumber`: Formats a number with commas as thousands separators
+  - `formatPhone`: Formats a phone number to a standard format
+
+=============================================================================
+
+Version 1.1.2 - 2025-05-15
+-----------------------------------------------------------------------------
+
+ADDED:
+- Improved documentation with comprehensive README
+- Enhanced examples for all utility functions
+
+FIXED:
+- Resolved documentation rendering issues on npm website
+
+=============================================================================
+
+Version 1.1.1 - 2025-05-15
+-----------------------------------------------------------------------------
+
+CHANGED:
+- Updated package metadata
+
+FIXED:
+- Minor bug fixes in string handling edge cases
+
+=============================================================================
+
+Version 1.1.0 - 2025-05-15
+-----------------------------------------------------------------------------
+
+ADDED:
+- Added extensive API documentation
+
+CHANGED:
+- Improved performance for `toSlug` function
+- Enhanced error handling across all utility functions
+
+=============================================================================
+
+Version 1.0.0 - 2025-05-14
+-----------------------------------------------------------------------------
+
+ADDED:
+- Initial release with four core utility functions:
+  - `truncateText`: Truncates text to a specified length with optional suffix
+  - `toSlug`: Converts text to URL-friendly slug format
+  - `capitalizeWords`: Capitalizes the first letter of each word
+  - `removeSpecialChars`: Removes special characters from text with optional replacement

package/formatting.js

@@ -0,0 +1,37 @@
+
+export function capitalize(str) {
+  return str
+    .split(' ')
+    .map(word => word.charAt(0).toUpperCase() + word.slice(1).toLowerCase())
+    .join(' ');
+}
+
+
+export function formatNumber(num, separator = ',') {
+  const numStr = num.toString();
+  return numStr.replace(/\B(?=(\d{3})+(?!\d))/g, separator);
+}
+
+
+export function formatPhone(phone, format = 'us') {
+  const digits = phone.replace(/\D/g, '');
+  
+  if (format === 'us' && digits.length === 10) {
+    return `(${digits.slice(0, 3)}) ${digits.slice(3, 6)}-${digits.slice(6)}`;
+  } else if (format === 'international' && digits.length >= 10) {
+    const countryCode = digits.slice(0, -10);
+    const areaCode = digits.slice(-10, -7);
+    const firstPart = digits.slice(-7, -4);
+    const lastPart = digits.slice(-4);
+    return `+${countryCode} (${areaCode}) ${firstPart}-${lastPart}`;
+  }
+  else if (format === 'indian') {
+    if (digits.length === 10) {
+      return `+91-${digits.slice(0, 5)}-${digits.slice(5)}`;
+    } else if (digits.length === 12 && digits.startsWith('91')) {
+      return `+91-${digits.slice(2, 7)}-${digits.slice(7)}`;
+    }
+  }
+  
+  return phone;
+}

package/index.js

@@ -1,49 +1,67 @@
-export function truncateText(text, maxLength, suffix = '...') {
-    if (typeof text !== 'string') {
-        throw new Error("Input text must be a string.");
-    }
-    if (typeof maxLength !== 'number' || maxLength < 0) {
-        throw new Error("maxLength must be a non-negative number.");
-    }
-    if (typeof suffix !== 'string') {
-        throw new Error("Suffix must be a string.");
-    }
-
-    if (text.length <= maxLength) {
-        return text;
-    }
-
-    const adjustedLength = maxLength - suffix.length;
-    return text.slice(0, adjustedLength > 0 ? adjustedLength : 0) + suffix;
-}
-  
+/**
+ * index.js
+ * Main entry point for the srtingzy package
+ * 
+ * This file serves as the public API for the entire library,
+ * organizing and exporting all functionality in a structured way.
+ * 
+ * @module stringzy
+ * @author Samarth Ruia
+ * @version 2.0.0
+ */
 
-  export function toSlug(text) {
-    if (typeof text !== "string") {
-      throw new Error("Invalid argument. Expected a string.");
-    }
-    return text
-      .toLowerCase()
-      .trim()
-      .replace(/[\s]+/g, "-")
-      .replace(/[^\w-]+/g, "");
-  }
-  
+import * as transformations from './transformations.js';
+import * as validations from './validations.js';
+import * as analysis from './analysis.js';
+import * as formatting from './formatting.js';
+
+
+export const {
+  truncateText,
+  toSlug,
+  capitalizeWords,
+  removeSpecialChars,
+  camelCase,
+  pascalCase,
+  snakeCase,
+  kebabCase,
+  titleCase,
+  constantCase,
+} = transformations;
+
+export const {
+  isURL,
+  isEmail,
+  isEmpty
+} = validations;
 
-  export function capitalizeWords(text) {
-    if (typeof text !== "string") {
-      throw new Error("Invalid argument. Expected a string.");
-    }
-    return text.replace(/\b\w/g, (char) => char.toUpperCase());
-  }
+export const {
+  wordCount,
+  characterCount,
+  characterFrequency
+} = analysis;
+
+export const {
+  capitalize,
+  formatNumber,
+  formatPhone
+} = formatting;
+
+export const transform = transformations;
+export const validate = validations;
+export const analyze = analysis;
+export const format = formatting;
+
+
+export default {
+  ...transformations, 
+  ...validations,
+  ...analysis,
+  ...formatting,
   
-  export function removeSpecialChars(text, replacement = '') {
-    if (typeof text !== "string") {
-        throw new Error("Invalid argument. Expected a string.");
-    }
-    if (typeof replacement !== "string") {
-        throw new Error("Replacement must be a string.");
-    }
-    return text.replace(/[^\w\s]/gi, replacement);
-}
-  
+  transform: transformations,
+  validate: validations,
+  analyze: analysis,
+  format: formatting,
+
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stringzy",
-  "version": "1.1.1",
+  "version": "2.0.0",
   "main": "index.js",
   "type": "module",
   "scripts": {
@@ -14,12 +14,17 @@
     "string",
     "string-manipulation",
     "text-formatting",
-    "cli",
+    "dev-tools",
     "text-utils",
     "stringify",
+    "string-tools",
+    "string-manipulation-library",
+    "utility-library",
+    "ReactJS",
     "stringer",
     "string",
     "text",
+    "best",
     "manipulation",
     "utilities",
     "javascript",

package/transformations.js

@@ -0,0 +1,128 @@
+export function truncateText(text, maxLength, suffix = '...') {
+    if (typeof text !== 'string') {
+        throw new Error("Input text must be a string.");
+    }
+    if (typeof maxLength !== 'number' || maxLength < 0) {
+        throw new Error("maxLength must be a non-negative number.");
+    }
+    if (typeof suffix !== 'string') {
+        throw new Error("Suffix must be a string.");
+    }
+
+    if (text.length <= maxLength) {
+        return text;
+    }
+
+    const adjustedLength = maxLength - suffix.length;
+    return text.slice(0, adjustedLength > 0 ? adjustedLength : 0) + suffix;
+}
+  
+
+  export function toSlug(text) {
+    if (typeof text !== "string") {
+      throw new Error("Invalid argument. Expected a string.");
+    }
+    return text
+      .toLowerCase()
+      .trim()
+      .replace(/[\s]+/g, "-")
+      .replace(/[^\w-]+/g, "");
+  }
+  
+
+  export function capitalizeWords(text) {
+    if (typeof text !== "string") {
+      throw new Error("Invalid argument. Expected a string.");
+    }
+    return text.replace(/\b\w/g, (char) => char.toUpperCase());
+  }
+  
+  export function removeSpecialChars(text, replacement = '') {
+    if (typeof text !== "string") {
+        throw new Error("Invalid argument. Expected a string.");
+    }
+    if (typeof replacement !== "string") {
+        throw new Error("Replacement must be a string.");
+    }
+    return text.replace(/[^\w\s]/gi, replacement);
+}
+  
+
+export function camelCase(text) {
+  if (text == null) return '';
+  
+  return text
+    .trim()
+    .toLowerCase()
+    .replace(/[^\w\s]/g, ' ')
+    .replace(/_/g, ' ')
+    .replace(/\s+/g, ' ')
+    .replace(/\s(.)/g, (_, character) => character.toUpperCase())
+    .replace(/^(.)/, (_, character) => character.toLowerCase());
+}
+
+
+export function pascalCase(text) {
+  if (text == null) return '';
+  
+  return text
+    .trim()
+    .toLowerCase()
+    .replace(/[^\w\s]/g, ' ')
+    .replace(/_/g, ' ')
+    .replace(/\s+/g, ' ')
+    .replace(/(^|\s)(.)/g, (_, prefix, character) => character.toUpperCase())
+    .replace(/\s/g, '');
+}
+
+
+export function snakeCase(text) {
+  if (text == null) return '';
+  
+  return text
+    .trim()
+    .replace(/[\s-]+/g, '_')
+    .replace(/([a-z])([A-Z])/g, '$1_$2')
+    .replace(/[^\w_]/g, '_')
+    .toLowerCase()
+    .replace(/_+/g, '_')
+    .replace(/^_+|_+$/g, '');
+}
+
+
+export function kebabCase(text) {
+  if (text == null) return '';
+  
+  return text
+    .trim()
+    .replace(/[\s_]+/g, '-')
+    .replace(/([a-z])([A-Z])/g, '$1-$2')
+    .replace(/[^\w-]/g, '-')
+    .toLowerCase()
+    .replace(/-+/g, '-')
+    .replace(/^-+|-+$/g, '');
+}
+
+export function titleCase(text) {
+  if (text == null) return '';
+  
+  return text
+    .trim()
+    .toLowerCase()
+    .replace(/([^\w\s]|_)/g, ' ')
+    .replace(/\s+/g, ' ')
+    .replace(/(^|\s)(.)/g, (_, prefix, character) => prefix + character.toUpperCase())
+    .replace(/\s/g, ' ');
+}
+export function constantCase(text) {
+  if (text == null) return '';
+  
+  return text
+    .trim()
+    .replace(/[\s-]+/g, '_')
+    .replace(/([a-z])([A-Z])/g, '$1_$2')
+    .replace(/[^\w_]/g, '_')
+    .toUpperCase()
+    .replace(/_+/g, '_')
+    .replace(/^_+|_+$/g, '');
+}

package/validations.js

@@ -0,0 +1,19 @@
+export function isURL(str) {
+  try {
+    new URL(str);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+
+export function isEmail(str) {
+  const emailRegex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
+  return emailRegex.test(str);
+}
+
+
+export function isEmpty(str) {
+  return str.trim().length === 0;
+}