vinh-strings-utils 3.1.0

package/README.md

@@ -0,0 +1,77 @@
+# @org/strings
+
+String manipulation utilities for TypeScript applications.
+
+## 📦 Package Information
+
+- **Version**: 0.0.1
+- **Publishable**: ✅ Yes
+- **Tag**: `scope:strings`
+- **Module Boundaries**: Can only import from `scope:shared` packages
+
+## 🚀 Features
+
+This package provides essential string manipulation utilities:
+
+- **capitalize** - Capitalizes the first letter of a string
+- **slugify** - Converts strings to URL-friendly slugs
+
+## 📝 Usage Examples
+
+```typescript
+import { capitalize, slugify } from '@org/strings';
+
+// Capitalize strings
+capitalize('hello world');  // 'Hello world'
+capitalize('typescript');   // 'Typescript'
+
+// Create URL-friendly slugs
+slugify('Hello World!');           // 'hello-world'
+slugify('TypeScript & JavaScript'); // 'typescript-javascript'
+```
+
+## 🛠️ Custom Commands
+
+This package includes a custom build command to demonstrate Nx's flexibility:
+
+```bash
+# Run the custom build-base command
+nx run strings:build-base
+
+# This will output: "Running build-base for strings. This can be replaced with arbitrary commands."
+```
+
+## 🧪 Testing
+
+```bash
+# Run tests for this package
+nx test strings
+
+# Run tests in watch mode
+nx test strings --watch
+```
+
+## 🏗️ Building
+
+```bash
+# Build the package
+nx build strings
+
+# The build output will be in dist/packages/strings
+```
+
+## 📋 Available Commands
+
+```bash
+nx build strings       # Build the package
+nx test strings        # Run tests
+nx lint strings        # Lint the package
+nx run strings:build-base  # Run custom build command
+```
+
+## 🔒 Module Boundaries
+
+This package has the tag `scope:strings` and can only import from:
+- `@org/utils` (tagged with `scope:shared`)
+
+Attempting to import from `@org/colors` or `@org/async` will result in a linting error due to module boundary constraints.

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './lib/slugify.js';
+export * from './lib/capitalize.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAA;AAChC,cAAc,qBAAqB,CAAA"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from './lib/slugify.js';
+export * from './lib/capitalize.js';

package/dist/lib/capitalize.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Capitalize first letter of each word
+ */
+export declare function capitalize(text: string, allWords?: boolean): string;
+//# sourceMappingURL=capitalize.d.ts.map

package/dist/lib/capitalize.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"capitalize.d.ts","sourceRoot":"","sources":["../../src/lib/capitalize.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,UAAO,GAAG,MAAM,CAYhE"}

package/dist/lib/capitalize.js

@@ -0,0 +1,15 @@
+import { validateType } from '@org/utils';
+/**
+ * Capitalize first letter of each word
+ */
+export function capitalize(text, allWords = true) {
+    if (!validateType(text, 'string')) {
+        throw new TypeError('Input must be a string');
+    }
+    if (!text)
+        return text;
+    if (allWords) {
+        return text.replace(/\b\w/g, (char) => char.toUpperCase());
+    }
+    return text.charAt(0).toUpperCase() + text.slice(1).toLowerCase();
+}

package/dist/lib/slugify.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Convert text to URL-friendly slug
+ */
+export declare function slugify(text: string): string;
+//# sourceMappingURL=slugify.d.ts.map

package/dist/lib/slugify.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"slugify.d.ts","sourceRoot":"","sources":["../../src/lib/slugify.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAW5C"}

package/dist/lib/slugify.js

@@ -0,0 +1,15 @@
+import { validateType } from '@org/utils';
+/**
+ * Convert text to URL-friendly slug
+ */
+export function slugify(text) {
+    if (!validateType(text, 'string')) {
+        throw new TypeError('Input must be a string');
+    }
+    return text
+        .toLowerCase()
+        .trim()
+        .replace(/[^\w\s-]/g, '') // Remove non-word chars
+        .replace(/[\s_-]+/g, '-') // Replace spaces, underscores, multiple hyphens with single hyphen
+        .replace(/^-+|-+$/g, ''); // Remove leading/trailing hyphens
+}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "vinh-strings-utils",
+  "version": "3.1.0",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "@org/source": "./src/index.ts",
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "!**/*.tsbuildinfo"
+  ],
+  "dependencies": {
+    "tslib": "^2.3.0"
+  },
+  "devDependencies": {
+    "vite": "^7.0.0",
+    "@org/utils": "0.0.1"
+  },
+  "nx": {
+    "tags": [
+      "scope:strings"
+    ],
+    "targets": {
+      "build-base": {
+        "command": "echo 'Running build-base for strings. This can be replaced with arbitrary commands.'",
+        "cache": true
+      },
+      "build": {
+        "dependsOn": [
+          "build-base"
+        ]
+      }
+    }
+  }
+}