🚀 Shared Utils - Reusable TypeScript Utility Library

Welcome to Shared Utils, a TypeScript-based utility package designed for frontend and backend development.

This package ensures:

• 🎯 Maintainability – Standardized utility functions.
• ⚡ Reusability – Avoid duplicating logic across projects.
• 🏗 Scalability – Works across different environments seamlessly.

🔧 Installation Guide

🔑 Prerequisite: Generate a GitHub Personal Access Token (PAT)

Since this package is private, you need a GitHub Personal Access Token (PAT) with the right permissions to install it.

Steps to Generate a GitHub PAT:

1️⃣ Log into GitHub 2️⃣ Navigate to Settings → Developer Settings → Personal Access Tokens 3️⃣ Click "Generate new token" 4️⃣ Select read:packages permission (and write:packages if publishing) 5️⃣ Click Generate token and copy it (it won’t be visible again!)

📥 Configure npm for GitHub Packages

Before installing, you need to authenticate using the generated token.

1️⃣ Create a .npmrc file in your project’s root folder:

//npm.pkg.github.com/:_authToken=YOUR_PERSONAL_ACCESS_TOKEN
@dev-validusfintech:registry=https://npm.pkg.github.com/

📌 Replace YOUR_PERSONAL_ACCESS_TOKEN with the token you generated.

📥 Install via npm

npm install @dev-validusfintech/validus-ui-core

📥 Install via Yarn

yarn add @dev-validusfintech/validus-ui-core

💻 Usage

Import and use the utilities in your TypeScript/JavaScript projects:

🔢 Number Utilities

import { amountInWords } from "@dev-validusfintech/validus-ui-core";

console.log(amountInWords(123)); // "One Hundred Twenty-Three"

🔤 String Utilities

import { capitalize } from "@dev-validusfintech/validus-ui-core";

console.log(capitalize("hello world")); // "Hello World"

📅 Date Utilities

import { formatDate } from "@dev-validusfintech/validus-ui-core";

console.log(formatDate(new Date(), "YYYY-MM-DD")); // "2025-02-12"

📦 Building & Testing

🚀 Build the Package

npm run build

🧪 Run Tests

npm test

📊 Versioning & Publishing

✅ 1️⃣ Ensure Clean Git State

git status
git add .
git commit -m "chore: prepare for release"

🔢 2️⃣ Version Update

📌 For a patch release (bug fixes):

npm version patch

📌 For a minor release (new features):

npm version minor

📌 For a major release (breaking changes):

npm version major

🚀 3️⃣ Push & Publish

git push origin main --follow-tags
npm publish --access=restricted

📊 Commit Guidelines

This project follows conventional commits for structured commit history:

• 🎉 feat: New feature
• 🐛 fix: Bug fix
• 📖 docs: Documentation update
• 🔄 refactor: Code restructuring
• 🏗 build: Build system updates
• 🏷 chore: Maintenance work
• ⚡ perf: Performance improvements
• 🧪 test: Add/modify tests
• 🚀 ci: CI/CD changes
• 🎨 style: Code formatting & style

📌 Example Commit:

git commit -m "feat: add amountInWords utility function"

📜 License

This project is licensed under the MIT License. See the LICENSE file for details.

💙 Crafted with ❤️ for Developers 🚀