@eyuel_engida/ethio-helpers 1.0.0

package/README.md

@@ -0,0 +1,62 @@
+# Ethio-Helpers 🇪🇹
+
+A lightweight, zero-dependency utility library for validating and formatting Ethiopian mobile phone numbers.  
+Supports both **Ethio Telecom** and **Safaricom**.
+
+---
+
+## 🚀 Installation
+
+```bash
+npm install @eyuel_engida/ethio-helpers
+```
+
+---
+
+## 🛠 Usage
+
+### JavaScript
+
+```js
+const { isEthioPhone, formatEthioPhone } = require('@eyuel_engida/ethio-helpers');
+
+// --- 1. Validation ---
+// Checks if the number is a valid Ethio Telecom (09) or Safaricom (07) number
+
+console.log(isEthioPhone('0911234567'));       // true
+console.log(isEthioPhone('+251712345678'));    // true
+console.log(isEthioPhone('0811234567'));       // false (Invalid prefix)
+console.log(isEthioPhone('0111550000'));       // false (Landline)
+
+// --- 2. Formatting ---
+// Converts messy inputs into the standard international format: +251 9XX XXX XXX
+
+const formatted = formatEthioPhone('0911223344');
+console.log(formatted);
+// Output: "+251 911 223 344"
+
+const formattedSafaricom = formatEthioPhone('0712345678');
+console.log(formattedSafaricom);
+// Output: "+251 712 345 678"
+```
+
+---
+
+## ✨ Features
+
+- ✅ **Validation**: Correctly identifies valid `09` (Ethio Telecom) and `07` (Safaricom) prefixes  
+- ✅ **Flexible Input**: Supports numbers with `+251`, `251`, `0`, or no prefix  
+- ✅ **Formatting**: Auto-formats valid numbers into a clean, standardized UI-friendly format  
+- 🪶 **Zero Dependencies**: Fast, lightweight, and dependency-free  
+
+---
+
+## 👨‍💻 Author
+
+Created by **Eyuel**
+
+---
+
+## 📄 License
+
+ISC

package/index.js

@@ -0,0 +1,41 @@
+// index.js
+
+/**
+ * Validates if a string is a valid Ethiopian mobile number.
+ * Accepts formats: +2519..., 2519..., 09..., 9... (and 07 for Safaricom)
+ * Returns: boolean
+ */
+function isEthioPhone(phoneNumber) {
+    // This regex checks for optional +251, 251, or 0, followed by 9 or 7, then 8 digits.
+    const regex = /^(?:\+251|251|0)?(9|7)\d{8}$/;
+    return regex.test(phoneNumber);
+}
+
+/**
+ * Formats a number to the standard international format: +251 9XX XXX XXX
+ */
+function formatEthioPhone(phoneNumber) {
+    // 1. Check if it's valid first
+    if (!isEthioPhone(phoneNumber)) return "Invalid Phone Number";
+
+    // 2. Remove all non-number characters (like + or spaces)
+    let cleaned = phoneNumber.toString().replace(/\D/g, '');
+
+    // 3. Normalize to 9-digit format (remove 251 or 0 prefix)
+    if (cleaned.startsWith('251')) {
+        cleaned = cleaned.slice(3);
+    } else if (cleaned.startsWith('0')) {
+        cleaned = cleaned.slice(1);
+    }
+
+    // 4. Format the string nicely
+    // slice(0,1) gets the '9' or '7'
+    // slice(1,3) gets the next two digits
+    return `+251 ${cleaned.slice(0, 1)}${cleaned.slice(1, 3)} ${cleaned.slice(3, 6)} ${cleaned.slice(6)}`;
+}
+
+// Export the functions so others can use them
+module.exports = {
+    isEthioPhone,
+    formatEthioPhone
+};

package/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "@eyuel_engida/ethio-helpers",
+  "version": "1.0.0",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "Eyuel",
+  "license": "ISC",
+  "description": "A utility to validate Ethiopian phone numbers"
+}