stringzy 2.0.1 → 2.2.0

package/README.md

@@ -1,12 +1,25 @@
-# stringzy
+
+<div align="center">
+  
+  
+  ![Stringzy banner](./assets/stringzy-banner2.jpg)
+
 
 ![NPM Version](https://img.shields.io/npm/v/stringzy)
 ![Downloads](https://img.shields.io/npm/dt/stringzy)
 ![License](https://img.shields.io/npm/l/stringzy)
 ![Bundle Size](https://img.shields.io/bundlephobia/min/stringzy)
+[![Open Source Love svg1](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badges/)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
 
 **A lightweight, zero-dependency NPM Package for elegant string manipulations. It provides a comprehensive range of text utilities for JavaScript and Node.js applications including transformations, validations, analysis, and formatting.**
 
+[Checkout our Contributors!](#contri)
+
+
+</div>
+
+
 ## ✨ Features
 
 - 💪 **Powerful** - Transform, validate, analyze, and format strings with minimal code
@@ -54,6 +67,9 @@ const count = stringzy.analyze.wordCount('Hello world'); // 2
 - [toSlug](#toslug) - Converts a string to a URL-friendly slug
 - [capitalizeWords](#capitalizewords) - Capitalizes the first letter of each word
 - [removeSpecialChars](#removespecialchars) - Removes special characters from a string
+- [removeWords](#removewords) - Removes specified words from a string
+- [removeDuplicates](#removeduplicates) - Removes specified words from a string
+- [initials](#initials) - Extracts initials from a text string
 - [camelCase](#camelcase) - Converts the given string to Camel Case
 - [pascaslCase](#pascalcase) - Converts the given string to Pascal Case
 - [snakeCase](#snakecase) - Converts the given string to Snake Case   
@@ -64,6 +80,7 @@ const count = stringzy.analyze.wordCount('Hello world'); // 2
 ###  Validations
 - [isURL](#isurl) - Checks if a string is a valid URL
 - [isEmail](#isemail) - Checks if a string is a valid email address
+- [isDate](#isdate) - Checks if a string is a valid date
 - [isEmpty](#isempty) - Checks if a string is empty or contains only whitespace
 
 ###  Analysis
@@ -169,6 +186,77 @@ removeSpecialChars('Phone: (123) 456-7890', '-');
 | text | string | required | The input string to process |
 | replacement | string | '' | String to replace special characters with |
 
+#### <a id="removewords"></a>`removeWords(text, wordsToRemove)`
+
+Removes specified words from a string
+
+```javascript
+import { removeWords } from 'stringzy';
+
+removeWords('Hello world this is a test', ['this', 'is']);
+// Returns: 'Hello world a test'
+
+removeWords('Remove The Quick BROWN fox', ['the', 'brown']);
+// Returns: 'Remove Quick fox' 
+
+removeWords('JavaScript is awesome and JavaScript rocks', ['JavaScript']);
+// Returns: 'is awesome and rocks'
+```
+
+| Parameter | Type | Default | Description |
+|-----------|------|---------|-------------|
+| text | string | required | The input string to process |
+| wordsToRemove | string[] | required | Array of words to remove from the string |
+
+#### <a id="removeduplicates"></a>`removeDuplicates(text)`
+
+Removes duplicate case-sensitive words from a given text. 
+
+```javascript
+import { removeDuplicates } from 'stringzy';
+
+removeDuplicates('Hello world this is a is a test');
+// Returns: 'Hello world this is a test'
+
+removeDuplicates('Remove me me me me or Me');
+// Returns: 'Remove me or Me'' 
+
+removeDuplicates('JavaScript is not bad and not awesome');
+// Returns: 'JavaScript is not bad and awesome'
+```
+
+| Parameter | Type | Default | Description |
+|-----------|------|---------|-------------|
+| text | string | required | The input string to process |
+
+#### <a id="initials"></a>`initials(text, limit)`
+
+Extracts initials from a text string.
+
+```javascript
+import { initials } from 'stringzy';
+
+initials('John Doe');
+// Returns: 'JD'
+
+initials('Alice Bob Charlie', 2);
+// Returns: 'AB'
+
+initials('Hello World Test Case');
+// Returns: 'HWTC'
+
+initials('single');
+// Returns: 's'
+
+initials('  Multiple   Spaces   Between  ');
+// Returns: 'MSB'
+```
+
+| Parameter | Type | Default | Description |
+|-----------|------|---------|-------------|
+| text | string | required | The input string to extract initials from |
+| limit | number | undefined | Maximum number of initials to return (optional) |
+
 #### <a id="camelcase"></a>`camelCase(text)`
 
 Converts the given string to Camel Case.
@@ -294,6 +382,23 @@ isEmail('invalid-email'); // false
 |-----------|------|---------|-------------|
 | text | string | required | The input string to validate as email |
 
+#### <a id="isdate"></a>`isDate(text)`
+
+Checks if a string is a valid date.
+
+```javascript
+import { isDate } from 'stringzy';
+
+isDate('2023-12-25'); // true
+isDate('12/25/2023'); // true
+isDate('invalid-date'); // false
+isDate('2023-13-45'); // false
+```
+
+| Parameter | Type | Default | Description |
+|-----------|------|---------|-------------|
+| text | string | required | The input string to validate as date |
+
 #### <a id="isempty"></a>`isEmpty(text)`
 
 Checks if a string is empty or contains only whitespace.
@@ -541,6 +646,67 @@ Contributions are welcome! Please feel free to submit a Pull Request.
 4. Push to the branch (`git push origin feature/amazing-feature`)
 5. Open a Pull Request
 
+
+## <a id="contri"></a>`Contributors`
+
+<table>
+    <tbody>
+        <tr>
+        <td align="center">
+                <a href="https://github.com/Samarth2190">
+                    <img src="https://avatars.githubusercontent.com/Samarth2190" width="100px;"
+                        alt="Samarth Ruia" />
+                    <br />
+                    <sub>
+                        <b>Samarth Ruia</b>
+                    </sub>
+                </a>
+            </td>
+        <td align="center">
+                <a href="https://github.com/JohnCervantes">
+                    <img src="https://avatars.githubusercontent.com/JohnCervantes" width="100px;"
+                        alt="John Cervantes" />
+                    <br />
+                    <sub>
+                        <b>John Cervantes</b>
+                    </sub>
+                </a>
+            </td>
+          <td align="center">
+                <a href="https://github.com/thehardiik">
+                    <img src="https://avatars.githubusercontent.com/thehardiik" width="100px;"
+                        alt="Hardik Srivastav" />
+                    <br />
+                    <sub>
+                        <b>Hardik Srivastav</b>
+                    </sub>
+                </a>
+            </td>
+          <td align="center">
+                <a href="https://github.com/ahmedsemih">
+                    <img src="https://avatars.githubusercontent.com/ahmedsemih" width="100px;"
+                        alt="Ahmed Semih Erkan" />
+                    <br />
+                    <sub>
+                        <b>Ahmed Semih Erkan</b>
+                    </sub>
+                </a>
+            </td>
+            <td align="center">
+                <a href="https://github.com/michaelvbend">
+                    <img src="https://avatars.githubusercontent.com/michaelvbend" width="100px;"
+                        alt="Michael van der Bend" />
+                    <br />
+                    <sub>
+                        <b>Michael van der Bend</b>
+                    </sub>
+                </a>
+            </td>
+        </tr>
+    </tbody>
+</table>
+
+
 ## 📝 License
 
 This project is licensed under the MIT License - see the LICENSE file for details.
@@ -550,6 +716,8 @@ This project is licensed under the MIT License - see the LICENSE file for detail
 - Thank you to all contributors and users of this package!
 - Inspired by the need for comprehensive yet simple string manipulation utilities.
 
+If you have contributed to this project and your image is not here, please let us know, and we'll be happy to add it!
+
 ---
 
-Made with ❤️ by Samarth Ruia
+Made with ❤️ by Samarth Ruia

package/changelog.txt

@@ -2,6 +2,26 @@ CHANGELOG
 
 All notable changes to the `stringzy` package will be documented in this file.
 
+=============================================================================
+Version 2.1.0 - 2025-05-31
+-----------------------------------------------------------------------------
+
+ADDED:
+- Added new utility functions:
+  - `removeDuplicates`: Removes duplicate words from a string
+- Added the stringzy banner to the README
+
+=============================================================================
+Version 2.1.0 - 2025-05-31
+-----------------------------------------------------------------------------
+
+ADDED:
+- Added new utility functions:
+  - `removeWords`:
+  - `isDate`: Validates if a string is a valid date
+- Added contributors section in README
+- Added new badges for open source and PRs
+
 =============================================================================
 Version 2.0.1 - 2025-05-23
 -----------------------------------------------------------------------------

package/index.js

@@ -7,7 +7,7 @@
  * 
  * @module stringzy
  * @author Samarth Ruia
- * @version 2.0.0
+ * @version 2.2.0
  */
 
 import * as transformations from './transformations.js';
@@ -27,12 +27,16 @@ export const {
   kebabCase,
   titleCase,
   constantCase,
+  removeWords,
+  initials,
+  removeDuplicates
 } = transformations;
 
 export const {
   isURL,
   isEmail,
-  isEmpty
+  isEmpty,
+  isDate,
 } = validations;
 
 export const {
@@ -64,4 +68,8 @@ export default {
   analyze: analysis,
   format: formatting,
 
-};
+  transform,
+  validate,
+  analyze,
+  format,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stringzy",
-  "version": "2.0.1",
+  "version": "2.2.0",
   "main": "index.js",
   "type": "module",
   "scripts": {

package/transformations.js

@@ -125,4 +125,66 @@ export function constantCase(text) {
     .toUpperCase()
     .replace(/_+/g, '_')
     .replace(/^_+|_+$/g, '');
-}
+}
+
+export function removeWords(str, wordsToRemove) {
+      if (str === null || str === undefined) {
+    throw new Error('Input string cannot be null or undefined');
+  }
+  if (typeof str !== 'string') {
+    throw new Error('First parameter must be a string');
+  }
+  if (wordsToRemove === null || wordsToRemove === undefined) {
+    throw new Error('Words to remove cannot be null or undefined');
+  }
+  if (typeof wordsToRemove !== 'string' && !Array.isArray(wordsToRemove)) {
+    throw new Error('Second parameter must be a string or an array of strings');
+  }
+    if (str === '') {
+    return '';
+  }
+  const wordsArray = Array.isArray(wordsToRemove) ? wordsToRemove : [wordsToRemove];
+  const regex = new RegExp(`\\b(${wordsArray.join('|')})\\b`, 'gi');
+  return str.replace(regex, '').replace(/\s+/g, ' ').trim();
+}
+
+export function initials(text, limit) {
+  if (typeof text !== "string") {
+    throw new Error("Input must be a string");
+  }
+
+  if (limit !== undefined && (typeof limit !== "number" || isNaN(limit))) {
+    throw new Error("Limit must be a valid number");
+  }
+
+  if (limit < 0) {
+    throw new Error("Limit must be a non-negative number");
+  }
+
+  const words = text
+    .trim()
+    .split(/\s+/)
+    .filter((word) => word.length > 0);
+
+  if (words.length === 0) return "";
+
+  const initialsArray = words
+    .map((word) => word.charAt(0))
+    .slice(0, limit ?? words.length);
+
+  return initialsArray.join("");
+}
+
+export function removeDuplicates(text) {
+  if (typeof text !== "string") {
+    throw new Error("Input must be a string");
+  }
+
+  const wordSet = new Set();
+
+  text.split(" ").forEach((word) => {
+    wordSet.add(word);
+  });
+
+  return Array.from(wordSet).join(" ");
+}

package/validations.js

@@ -16,4 +16,65 @@ export function isEmail(str) {
 
 export function isEmpty(str) {
   return str.trim().length === 0;
-}
+}
+
+
+
+export function isDate(input) {
+
+  //console.log("True")
+
+  
+  
+  if (typeof input !== "string") return false;
+
+  const formats = [
+    {
+      // Format: YYYY-MM-DD 
+      regex: /^\d{4}-\d{2}-\d{2}$/,
+      split: (s) => s.split("-").map(Number),
+      order: ["Y", "M", "D"],
+    },
+      {
+      // Format: MM-DD-YYYY 
+      regex: /^\d{2}-\d{2}-\d{4}$/,
+      split: (s) => s.split("-").map(Number),
+      order: ["M", "D", "Y"],
+   },
+    {
+      // Format: DD-MM-YYYY 
+      regex: /^\d{2}-\d{2}-\d{4}$/,
+      split: (s) => s.split("-").map(Number),
+      order: ["D", "M", "Y"],
+    },
+    {
+      // Format: DD/MM/YYYY 
+      regex: /^\d{2}\/\d{2}\/\d{4}$/,
+      split: (s) => s.split("/").map(Number),
+      order: ["D", "M", "Y"],
+    },
+    {
+      // Format: YYYY/MM/DD 
+      regex: /^\d{4}\/\d{2}\/\d{2}$/,
+      split: (s) => s.split("/").map(Number),
+      order: ["Y", "M", "D"],
+    },
+  ];
+
+  for (const format of formats) {
+    if (format.regex.test(input)) {
+      const parts = format.split(input);
+      const dateParts = {};
+      format.order.forEach((key, i) => {
+        dateParts[key] = parts[i];
+      });
+
+      const { Y, M, D } = dateParts;
+      const date = new Date(Y, M - 1, D); // JS months are 0-indexed
+      return date.getFullYear() === Y && date.getMonth() === M -1  && date.getDate() === D;
+    }
+  }
+
+  return false;
+}
+