@amandeepsingh13/modify-str 1.0.0

package/README.md

@@ -0,0 +1,24 @@
+![CI](https://github.com/Amandeep-tech/modify-str/actions/workflows/ci.yml/badge.svg)
+
+# modify-str
+
+A small, lightweight utility to **modify strings using a single, configurable API**.  
+Built with **TypeScript**, shipped with **JavaScript + type definitions**, and designed to be **pure, immutable, and predictable**.
+
+---
+
+## ✨ Features
+
+- Single API for multiple string transformations
+- Immutable & pure (no side effects)
+- Supports chaining via config (last option wins)
+- Written in TypeScript, ships JS + `.d.ts`
+- Unit tested
+- Tree-shakable and lightweight
+
+---
+
+## 📦 Installation
+
+```bash
+npm install modify-str

package/dist/index.d.mts

@@ -0,0 +1,13 @@
+type ModifyOptions = {
+    capitaliseFirstChar?: boolean;
+    toUpperCase?: boolean;
+    toLowerCase?: boolean;
+    snakeCase?: boolean;
+    camelCase?: boolean;
+    trim?: boolean;
+    removeExtraSpaces?: boolean;
+};
+
+declare function modifyStr(input: string, options?: ModifyOptions): string;
+
+export { type ModifyOptions, modifyStr };

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+type ModifyOptions = {
+    capitaliseFirstChar?: boolean;
+    toUpperCase?: boolean;
+    toLowerCase?: boolean;
+    snakeCase?: boolean;
+    camelCase?: boolean;
+    trim?: boolean;
+    removeExtraSpaces?: boolean;
+};
+
+declare function modifyStr(input: string, options?: ModifyOptions): string;
+
+export { type ModifyOptions, modifyStr };

package/dist/index.js

@@ -0,0 +1,85 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  modifyStr: () => modifyStr
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/transformers/camelCase.ts
+var camelCase = (str) => str.toLowerCase().replace(/[_-\s]+(.)?/g, (_, c) => c ? c.toUpperCase() : "");
+
+// src/transformers/snakeCase.ts
+var snakeCase = (str) => str.trim().replace(/([a-z0-9])([A-Z])/g, "$1_$2").replace(/[\s-]+/g, "_").replace(/_+/g, "_").toLowerCase();
+
+// src/modifyStr.ts
+var validKeys = /* @__PURE__ */ new Set([
+  "capitaliseFirstChar",
+  "toUpperCase",
+  "toLowerCase",
+  "snakeCase",
+  "camelCase",
+  "trim",
+  "removeExtraSpaces"
+]);
+function modifyStr(input, options = {}) {
+  if (input === null || input === void 0) {
+    throw new Error("modifyStr: input string cannot be null or undefined");
+  }
+  let result = input;
+  Object.keys(options).forEach((key) => {
+    if (!validKeys.has(key)) {
+      if (process.env.NODE_ENV !== "production") {
+        console.warn(`modifyStr: unknown option "${key}" ignored`);
+      }
+      return;
+    }
+    if (!options[key]) return;
+    switch (key) {
+      case "trim":
+        result = result.trim();
+        break;
+      case "removeExtraSpaces":
+        result = result.replace(/\s+/g, " ");
+        break;
+      case "capitaliseFirstChar":
+        result = result.charAt(0).toUpperCase() + result.slice(1);
+        break;
+      case "toUpperCase":
+        result = result.toUpperCase();
+        break;
+      case "toLowerCase":
+        result = result.toLowerCase();
+        break;
+      case "snakeCase":
+        result = snakeCase(result);
+        break;
+      case "camelCase":
+        result = camelCase(result);
+        break;
+    }
+  });
+  return result;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  modifyStr
+});

package/dist/index.mjs

@@ -0,0 +1,58 @@
+// src/transformers/camelCase.ts
+var camelCase = (str) => str.toLowerCase().replace(/[_-\s]+(.)?/g, (_, c) => c ? c.toUpperCase() : "");
+
+// src/transformers/snakeCase.ts
+var snakeCase = (str) => str.trim().replace(/([a-z0-9])([A-Z])/g, "$1_$2").replace(/[\s-]+/g, "_").replace(/_+/g, "_").toLowerCase();
+
+// src/modifyStr.ts
+var validKeys = /* @__PURE__ */ new Set([
+  "capitaliseFirstChar",
+  "toUpperCase",
+  "toLowerCase",
+  "snakeCase",
+  "camelCase",
+  "trim",
+  "removeExtraSpaces"
+]);
+function modifyStr(input, options = {}) {
+  if (input === null || input === void 0) {
+    throw new Error("modifyStr: input string cannot be null or undefined");
+  }
+  let result = input;
+  Object.keys(options).forEach((key) => {
+    if (!validKeys.has(key)) {
+      if (process.env.NODE_ENV !== "production") {
+        console.warn(`modifyStr: unknown option "${key}" ignored`);
+      }
+      return;
+    }
+    if (!options[key]) return;
+    switch (key) {
+      case "trim":
+        result = result.trim();
+        break;
+      case "removeExtraSpaces":
+        result = result.replace(/\s+/g, " ");
+        break;
+      case "capitaliseFirstChar":
+        result = result.charAt(0).toUpperCase() + result.slice(1);
+        break;
+      case "toUpperCase":
+        result = result.toUpperCase();
+        break;
+      case "toLowerCase":
+        result = result.toLowerCase();
+        break;
+      case "snakeCase":
+        result = snakeCase(result);
+        break;
+      case "camelCase":
+        result = camelCase(result);
+        break;
+    }
+  });
+  return result;
+}
+export {
+  modifyStr
+};

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@amandeepsingh13/modify-str",
+  "version": "1.0.0",
+  "description": "A configurable, immutable string modification utility written in TypeScript",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "files": ["dist"],
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest run",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "string",
+    "utility",
+    "typescript",
+    "npm",
+    "formatter"
+  ],
+  "author": "Amandeep Singh",
+  "license": "MIT"
+}