show-password-strength 1.0.0

package/README.md

@@ -0,0 +1,52 @@
+# About
+
+A simple and efficient npm package to validate password strength using rules such as minimum length, numbers, lowercase letters, uppercase letters, and special characters.
+
+# Features
+
+* Validates password minimum length
+* Checks for numeric characters
+* Ensures lowercase letters are included
+* Ensures uppercase letters are included
+* Validates presence of special characters
+* Simple and easy-to-use API
+* Lightweight with zero external dependencies
+* Works in both frontend and backend JavaScript applications
+* Easy to integrate with any authentication or form validation flow
+
+# Installation
+
+```bash
+npm install show-password-strength
+```
+
+# Usage
+
+```js
+import showPasswordStrength from 'show-password-strength'
+
+const passwordStrengthOne = showPasswordStrength("midh", 6)
+console.log(passwordStrengthOne) // {level: "weak", score: 25}
+
+const passwordStrengthTwo = showPasswordStrength("midhun", 6)
+console.log(passwordStrengthTwo) // {level: "medium", score: 33}
+
+const passwordStrengthThree = showPasswordStrength("midhun123U", 6)
+console.log(passwordStrengthThree) // {level: "strong", score: 50}
+
+const passwordStrengthFour = showPasswordStrength("midhun123@U", 6)
+console.log(passwordStrengthFour) // {level: "strong", score: 75}
+
+const passwordStrengthFive = showPasswordStrength("Midhun123@whoam", 6)
+console.log(passwordStrengthFive) // {level: "strong", score: 100}
+```
+
+# ISC License
+
+Copyright (c) 2025 Midhun
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+Readme

package/index.js

@@ -0,0 +1,61 @@
+/**
+    @param {string} password - The password which is for checking if the password is strong
+    @param {number} minLength - The minimum length of the password should be
+    @returns {{level: "weak" | "medium" | "strong", score: number}}
+ */
+
+// Function for checking password is strong
+const showPasswordStrength = (password, minLength) => {
+
+    const hasLower = /[a-z]/.test(password) // For checking if password contains lower characters 
+    const hasUpper = /[A-Z]/.test(password) // For checking if password contains upper characters
+    const hasNumber = /[0-9]/.test(password) // For checking if password contains numbers
+    const hasSpecialCharacters = /[^A-Za-z0-9]/.test(password) // For checking if password contains special characters
+
+    if (password.length < minLength) {
+        return { level: "weak", score: 100 / 4 }
+    }
+
+    if(
+        (password.length >= minLength + minLength) &&
+        hasLower &&
+        hasNumber &&
+        hasUpper &&
+        hasSpecialCharacters
+    ){
+        return {level: "strong", score: 100}
+    }
+
+    if(
+        password.length >= minLength &&
+        hasLower &&
+        hasNumber &&
+        hasUpper &&
+        hasSpecialCharacters
+    ){
+        return {level: "strong", score: 75}
+    }
+
+    if (
+        password.length >= minLength &&
+        hasLower &&
+        hasUpper &&
+        hasNumber
+    ) {
+        return { level: "strong", score: 50 }
+    }
+
+    if (
+        (password.length >= minLength) &&
+        hasLower ||
+        hasUpper ||
+        hasNumber ||
+        hasSpecialCharacters
+    ) {
+
+        return { level: "medium", score: Math.round(100 / 3) }
+
+    }
+}
+
+export default showPasswordStrength

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "show-password-strength",
+  "version": "1.0.0",
+  "description": "A small NPM package for checking password strength.",
+  "main": "index.js",
+  "type": "module",
+  "scripts": {
+    "start": "node ./index.js",
+    "dev": "node --watch ./index.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Midhun-u/show-password-strength.git"
+  },
+  "keywords": [
+    "password",
+    "password",
+    "strength",
+    "check",
+    "password",
+    "strength",
+    "npm",
+    "nodejs",
+    "password",
+    "checker"
+  ],
+  "author": "midhun-u",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/Midhun-u/show-password-strength/issues"
+  },
+  "homepage": "https://github.com/Midhun-u/show-password-strength#readme"
+}