Task/gd/adding tests code quality

.github/workflows/code.quality.yml

@@ -0,0 +1,31 @@
+name: "Code Quality 🏆"
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+  push:
+    branches:
+      - main
+
+jobs:
+  linting:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "18.x"
+
+      - name: Install packages
+        working-directory: .
+        run: npm ci --legacy-peer-deps
+
+      - name: Build
+        working-directory: .
+        run: npm run build
+
+      - name: ESLint
+        working-directory: .
+        run: npm run lint

.gitignore

@@ -1,3 +1,3 @@
 node_modules
 dist
-examples
+.DS_Store

.husky/pre-commit

@@ -0,0 +1 @@
+npm run lint

README.md

@@ -1,2 +1,57 @@
-# validate-form-fields
+# Validate Form Fields
 A lightweight, zero-dependency JavaScript/TypeScript library for validating form inputs with customisable rules. Supports length limits, alphanumeric enforcement, HTML blocking, and more.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [License](#license)
+
+## Installation
+
+To install the library, you can use npm or yarn:
+
+```bash
+npm install validate-form-fields
+```
+
+## Usage
+
+Basic examples:
+
+```React 
+import  { ValidateFormFields } from 'validate-form-fields';
+
+  useEffect(() => {
+    const input = document.getElementById('name') as HTMLInputElement;
+    if (input){
+      ValidateFormFields.attachValidation(input, {
+        minLength: 3,
+        maxLength: 255,
+        allowAlphanumericOnly: true,
+        blockHTML: true,
+        requireNonEmpty: true,
+      });
+    }
+  }, []);
+```
+
+```JavaScript 
+import  { ValidateFormFields } from 'validate-form-fields';
+
+const input = document.getElementById('name');
+if (input){
+    ValidateFormFields.attachValidation(input, {
+    minLength: 3,
+    maxLength: 255,
+    allowAlphanumericOnly: true,
+    blockHTML: true,
+    requireNonEmpty: true,
+    });
+}
+
+```
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.

eslint.config.mjs

@@ -0,0 +1,15 @@
+import globals from "globals";
+import pluginJs from "@eslint/js";
+
+
+/** @type {import('eslint').Linter.Config[]} */
+export default [
+  {
+    languageOptions: { 
+      ecmaVersion: 2020, 
+      sourceType: "module", 
+      globals: globals.browser,
+    }
+  },
+  pluginJs.configs.recommended,
+];

jest.config.js

@@ -0,0 +1,7 @@
+/* eslint-env node */
+
+export default {
+  preset: "ts-jest",
+  testEnvironment: "node",
+  testMatch: ["**/__tests__/**/*.ts", "**/?(*.)+(spec|test).ts"],
+};