Updates

Updated Readme, Added prettier and usage details

Author: Kathuria

.github/workflows/release.yml

@@ -7,37 +7,37 @@ on:
       - next
 
 permissions:
-    contents: write
-    issues: write
-    pull-requests: write
+  contents: write
+  issues: write
+  pull-requests: write
 
 jobs:
   release:
     runs-on: ubuntu-latest
 
     steps:
-    - name: Checkout code
-      uses: actions/checkout@v4
+      - name: Checkout code
+        uses: actions/checkout@v4
 
-    - name: Set up Node.js
-      uses: actions/setup-node@v4
-      with:
-        node-version: "lts/*" 
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 'lts/*'
 
-    - name: Install dependencies
-      run: npm ci
+      - name: Install dependencies
+        run: npm ci
 
-    - name: Run tests
-      run: npm test
+      - name: Run tests
+        run: npm test
 
-    - name: Build project
-      run: npm run build
+      - name: Build project
+        run: npm run build
 
-    - name: Audit npm signatures
-      run: npm audit signatures
+      - name: Audit npm signatures
+        run: npm audit signatures
 
-    - name: Release
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-      run: npx semantic-release
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx semantic-release

.gitignore

@@ -1,2 +1,4 @@
 dist
-node_modules
+node_modules
+coverage
+.DS_Store

.prettierrc

@@ -0,0 +1,29 @@
+{
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "es5",
+  "bracketSpacing": true,
+  "arrowParens": "always",
+  "tabWidth": 2,
+  "printWidth": 80,
+  "endOfLine": "lf",
+  "proseWrap": "always",
+  "quoteProps": "as-needed",
+  "jsxSingleQuote": false,
+  "htmlWhitespaceSensitivity": "css",
+  "bracketSameLine": false,
+  "overrides": [
+    {
+      "files": "*.ts",
+      "options": {
+        "parser": "typescript"
+      }
+    },
+    {
+      "files": "*.tsx",
+      "options": {
+        "parser": "typescript"
+      }
+    }
+  ]
+}

README.md

@@ -1,6 +1,6 @@
 # validate-functions
 
-The `validate-functions` package provides a set of utility functions for validating common identification numbers and formats, such as SSN, Email, and Aadhaar. This package is designed to be extensible, allowing for additional validation functions to be added incrementally.
+The `validate-functions` package provides a set of utility functions for validating common identification numbers and formats. This package will be keep on updating so better look out for latest version for more validation functions.
 
 ## Installation
 
@@ -9,3 +9,12 @@ To install the package, use npm:
 ```bash
 npm install validate-functions
 ```
+
+## Features
+
+- **Email Validation**: Ensures that email addresses conform to standard formats.
+- **SSN Validation**: Validates U.S. Social Security Numbers based on predefined rules.
+- **Aadhaar Validation**: Checks the validity of Indian Aadhaar numbers using specific patterns.
+
+
+Usage Details available at [here](./USAGE_DETAILS.md).

USAGE_DETAILS.md

@@ -0,0 +1,28 @@
+## Usage Details
+
+- **isValid_Email**
+
+```typescript
+import { isValid_Email } from 'validate-functions/email-validation';
+
+const email = '<a href="mailto:[email protected]">[email protected]</a>';
+console.log(isValid_Email(email)); // Output: true if valid, false otherwise
+```
+
+- **isValid_SSN**
+
+```typescript
+import { isValid_SSN } from 'validate-functions/ssn-validation';
+
+const ssn = '123-45-6789';
+console.log(isValid_SSN(ssn)); // Output: true if valid, false otherwise
+```
+
+- **isValid_Aadhaar_Number**
+
+```typescript
+import { isValid_Aadhaar_Number } from 'validate-functions/aadhaar-validation';
+
+const aadhaarNumber = '1234 5678 9012';
+console.log(isValid_Aadhaar_Number(aadhaarNumber)); // Output: true if valid, false otherwise
+```

package-lock.json

@@ -1,11 +1,12 @@
 {
   "name": "validate-functions",
   "version": "0.0.0-development",
-  "description": "A library containing validation functions such as SSN.",
+  "description": "A library containing various validation functions.",
   "main": "index.js",
   "scripts": {
-    "test": "jest",
+    "test": "jest --silent --coverage",
     "build": "tsc",
+    "format": "prettier --config .prettierrc --write 'src/**/*.{ts,tsx}'",
     "semantic-release": "semantic-release"
   },
   "repository": {
@@ -25,6 +26,7 @@
   "devDependencies": {
     "@types/jest": "^29.5.14",
     "jest": "^29.7.0",
+    "prettier": "^3.4.2",
     "semantic-release": "^24.2.0",
     "ts-jest": "^29.2.5",
     "typescript": "^5.7.2"

package.json

@@ -1,3 +1,3 @@
 module.exports = {
-        branches: ["main", { name: "beta", prerelease: true }],
-};
+  branches: ['main', { name: 'beta', prerelease: true }],
+};

release.config.cjs

@@ -1,17 +1,17 @@
-/** Funtion to validate Aadhaar Number */
+/**
+ * Aadhaar is a twelve-digit unique identity number that can be obtained voluntarily by all residents of India, based on their biometrics and demographic data.
+ * @param aadhaar_number
+ * @returns
+ */
 export const isValid_Aadhaar_Number = (aadhaar_number: string): boolean => {
+  // Regex to check valid aadhaar_number
+  let regex = new RegExp(/^[2-9]{1}[0-9]{3}\s[0-9]{4}\s[0-9]{4}$/);
 
-	// Regex to check valid
-	// aadhaar_number 
-	let regex = new RegExp(/^[2-9]{1}[0-9]{3}\s[0-9]{4}\s[0-9]{4}$/);
+  // if aadhaar_number is empty return false
+  if (aadhaar_number == null) {
+    return false;
+  }
 
-	// if aadhaar_number 
-	// is empty return false
-	if (aadhaar_number == null) {
-		return false;
-	}
-
-	// Return true if the aadhaar_number
-	// matched the ReGex
-	return regex.test(aadhaar_number);
-}
+  // Return true if the aadhaar_number matched the ReGex
+  return regex.test(aadhaar_number);
+};

src/aadhaar-validation.ts

@@ -1,4 +1,9 @@
+/**
+ * Electronic mail (e-mail) is a computer-based application for the exchange of messages between users.
+ * @param email
+ * @returns
+ */
 export const isValid_Email = (email: string): boolean => {
-        const re = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
-        return re.test(email);
-      }
+  const re = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
+  return re.test(email);
+};