@qvaroo/configs 1.0.0 → 1.0.2

package/README.md

@@ -1,10 +1,10 @@
-# @qvaro/configs
+# @qvaroo/configs
 
-> **Centralized Qvaro coding standards for TypeScript frontend projects.**
+> **Centralized Qvaroo coding standards for TypeScript frontend projects.**
 >
 > This library acts as the **single source of truth** for all coding, architecture, and tooling standards. All rule violations **fail CI/CD pipelines**, removing human discretion from standards enforcement.
 
-[![npm version](https://img.shields.io/npm/v/@qvaro/configs.svg)](https://www.npmjs.com/package/@qvaro/configs)
+[![npm version](https://img.shields.io/npm/v/@qvaroo/configs.svg)](https://www.npmjs.com/package/@qvaroo/configs)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 ---
@@ -12,7 +12,7 @@
 ## 📦 Installation
 
 ```bash
-npm install --save-dev @qvaro/configs
+npm install --save-dev @qvaroo/configs
 ```
 
 ### Peer Dependencies
@@ -34,7 +34,7 @@ Create `.eslintrc.js` in your project root:
 **For React/Next.js projects:**
 ```javascript
 module.exports = {
-  extends: ['./node_modules/@qvaro/configs/eslint/react.js'],
+  extends: ['./node_modules/@qvaroo/configs/eslint/react.js'],
   parserOptions: {
     project: './tsconfig.json',
     tsconfigRootDir: __dirname,
@@ -45,7 +45,7 @@ module.exports = {
 **For Node.js/Backend projects:**
 ```javascript
 module.exports = {
-  extends: ['./node_modules/@qvaro/configs/eslint/node.js'],
+  extends: ['./node_modules/@qvaroo/configs/eslint/node.js'],
   parserOptions: {
     project: './tsconfig.json',
     tsconfigRootDir: __dirname,
@@ -56,7 +56,7 @@ module.exports = {
 **For base TypeScript projects:**
 ```javascript
 module.exports = {
-  extends: ['./node_modules/@qvaro/configs/eslint/index.js'],
+  extends: ['./node_modules/@qvaroo/configs/eslint/index.js'],
   parserOptions: {
     project: './tsconfig.json',
     tsconfigRootDir: __dirname,
@@ -69,7 +69,7 @@ module.exports = {
 Create `prettier.config.js`:
 
 ```javascript
-module.exports = require('@qvaro/configs/prettier');
+module.exports = require('@qvaroo/configs/prettier');
 ```
 
 ### 3. TypeScript Configuration
@@ -79,7 +79,7 @@ Create `tsconfig.json`:
 **For React projects:**
 ```json
 {
-  "extends": "@qvaro/configs/typescript/react",
+  "extends": "@qvaroo/configs/typescript/react",
   "compilerOptions": {
     "baseUrl": "."
   },
@@ -91,7 +91,7 @@ Create `tsconfig.json`:
 **For Node.js projects:**
 ```json
 {
-  "extends": "@qvaro/configs/typescript/node",
+  "extends": "@qvaroo/configs/typescript/node",
   "compilerOptions": {
     "baseUrl": "."
   },
@@ -170,6 +170,39 @@ src/
 
 ---
 
+## ⛔️ Local Enforcement (Pre-commit Hooks)
+
+To ensure developers fix errors **before** they commit, set up [Husky](https://typicode.github.io/husky/).
+
+1. **Install Husky & Lint-staged**:
+   ```bash
+   npm install --save-dev husky lint-staged
+   npx husky init
+   ```
+
+2. **Configure Pre-commit Hook**:
+   Update `.husky/pre-commit` to run lint-staged:
+   ```bash
+   npx lint-staged
+   ```
+
+3. **Update `package.json`**:
+   Add the configuration to check only changed files:
+   ```json
+   {
+     "lint-staged": {
+       "src/**/*.{ts,tsx,js}": [
+         "eslint --fix",
+         "prettier --write"
+       ]
+     }
+   }
+   ```
+
+   > Now, if a developer tries to commit code with errors, **git will reject the commit** until fixed.
+
+---
+
 ## 🔧 CI/CD Integration
 
 ### GitHub Actions
@@ -309,7 +342,7 @@ Override specific rules in your project's `.eslintrc.js`:
 
 ```javascript
 module.exports = {
-  extends: ['./node_modules/@qvaro/configs/eslint/react.js'],
+  extends: ['./node_modules/@qvaroo/configs/eslint/react.js'],
   rules: {
     // Relax for specific project needs
     'max-lines-per-function': ['error', { max: 60 }],
@@ -330,12 +363,12 @@ Variable names are checked for spelling. Add project-specific terms:
 
 ```javascript
 module.exports = {
-  extends: ['./node_modules/@qvaro/configs/eslint'],
+  extends: ['./node_modules/@qvaroo/configs/eslint'],
   rules: {
     'spellcheck/spell-checker': ['warn', {
       skipWords: [
         // Add your domain terms
-        'qvaro',
+        'qvaroo',
         'oauth',
         'saml',
       ],
@@ -363,7 +396,7 @@ module.exports = {
 ## 📁 Package Contents
 
 ```
-@qvaro/configs/
+@qvaroo/configs/
 ├── eslint/
 │   ├── index.js          # Base ESLint config
 │   ├── react.js          # React/Next.js config
@@ -388,4 +421,4 @@ module.exports = {
 
 ## 📄 License
 
-MIT © Qvaro DevOps Team
+MIT © Qvaroo DevOps Team

package/index.d.ts

@@ -2,3 +2,8 @@ export declare const eslint: import('eslint').Linter.Config;
 export declare const eslintReact: import('eslint').Linter.Config;
 export declare const eslintNode: import('eslint').Linter.Config;
 export declare const prettier: import('prettier').Config;
+
+export declare const namingConventions: Record<string, any>;
+export declare const codeQuality: Record<string, any>;
+export declare const architecture: Record<string, any>;
+export declare const spellcheck: Record<string, any>;

package/index.js

@@ -8,4 +8,10 @@ module.exports = {
     eslintReact: require('./eslint/react'),
     eslintNode: require('./eslint/node'),
     prettier: require('./prettier'),
+
+    // Individual Rule Sets
+    namingConventions: require('./eslint/rules/naming-conventions'),
+    codeQuality: require('./eslint/rules/code-quality'),
+    architecture: require('./eslint/rules/architecture'),
+    spellcheck: require('./eslint/rules/spellcheck'),
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@qvaroo/configs",
-    "version": "1.0.0",
+    "version": "1.0.2",
     "description": "Centralized Qvaroo coding standards, ESLint, Prettier, and TypeScript configurations for TypeScript frontend projects",
     "main": "index.js",
     "types": "index.d.ts",