wgtechlabs
diff --git a/‎.github/assets/repo_banner.jpg‎
-63.1 KB b/‎.github/assets/repo_banner.jpg‎
-63.1 KB
diff --git a/‎.github/workflows/size-check.yml‎
Lines changed: 62 additions & 0 deletions b/‎.github/workflows/size-check.yml‎
Lines changed: 62 additions & 0 deletions
diff --git a/‎CONTRIBUTING.md‎
Lines changed: 1 addition & 1 deletion b/‎CONTRIBUTING.md‎
Lines changed: 1 addition & 1 deletion
diff --git a/‎README.md‎
Lines changed: 234 additions & 37 deletions b/‎README.md‎
Lines changed: 234 additions & 37 deletions
diff --git a/‎eslint.config.js‎
Lines changed: 19 additions & 0 deletions b/‎eslint.config.js‎
Lines changed: 19 additions & 0 deletions
diff --git a/‎package.json‎
Lines changed: 3 additions & 2 deletions b/‎package.json‎
Lines changed: 3 additions & 2 deletions
diff --git a/‎scripts/check-size.js‎
Lines changed: 194 additions & 0 deletions b/‎scripts/check-size.js‎
Lines changed: 194 additions & 0 deletions
@@ -0,0 +1,62 @@
+name: Bundle Size Check
+
+on:
+  push:
+    branches: [main, dev]
+  pull_request:
+    branches: [main, dev]
+
+jobs:
+  size-check:
+    name: Check Bundle Size
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          
+      - name: Enable Corepack for pnpm
+        run: |
+          echo "Enabling Corepack..."
+          corepack enable
+          echo "Preparing pnpm 9.15.4..."
+          corepack prepare pnpm@9.15.4 --activate
+          echo "pnpm setup complete"
+          
+      - name: Verify pnpm version
+        run: |
+          echo "pnpm version:"
+          pnpm --version
+          
+      - name: Install dependencies
+        run: |
+          echo "Installing dependencies with pnpm..."
+          pnpm install --frozen-lockfile
+          echo "Dependencies installed successfully"
+        
+      - name: Build package
+        run: |
+          echo "Building package..."
+          pnpm build
+          echo "Build completed successfully"
+          
+      - name: Check bundle size
+        run: |
+          echo "Running bundle size checker..."
+          pnpm run size:check
+          echo "Size check completed"
+          
+      - name: Display dist contents
+        run: |
+          echo "Dist directory structure:"
+          find dist -type f -exec ls -lh {} \; | awk '{print $5, $9}'
+          echo ""
+          echo "Total dist size:"
+          du -sh dist
@@ -126,7 +126,7 @@ pnpm test:debug
 
 **For Production Release:**
 
-1. Run full validation: `pnpm validate` (lint + test + build)
+1. Run full validation: `pnpm validate` (lint + test + build + size check)
 2. Ensure coverage requirements are met with `pnpm test:coverage`
 3. Run security checks: `pnpm secure` (if Snyk is configured)
 4. Create PR to `main` for review
 
@@ -1,5 +1,6 @@
 import tsPlugin from '@typescript-eslint/eslint-plugin';
 import tsParser from '@typescript-eslint/parser';
+import securityPlugin from 'eslint-plugin-security';
 
 export default [
   {
@@ -15,6 +16,7 @@ export default [
     },
     plugins: {
       '@typescript-eslint': tsPlugin,
+      'security': securityPlugin,
     },
     rules: {
       // TypeScript specific rules
@@ -42,6 +44,22 @@ export default [
       'no-implied-eval': 'error',
       'no-new-func': 'error',
       'no-script-url': 'error',
+      
+      // Security plugin rules - disabled here (run separately in lint:security)
+      // but included so eslint-disable comments are recognized
+      'security/detect-object-injection': 'off',
+      'security/detect-non-literal-regexp': 'off',
+      'security/detect-unsafe-regex': 'off',
+      'security/detect-buffer-noassert': 'off',
+      'security/detect-child-process': 'off',
+      'security/detect-disable-mustache-escape': 'off',
+      'security/detect-eval-with-expression': 'off',
+      'security/detect-no-csrf-before-method-override': 'off',
+      'security/detect-non-literal-fs-filename': 'off',
+      'security/detect-non-literal-require': 'off',
+      'security/detect-possible-timing-attacks': 'off',
+      'security/detect-pseudoRandomBytes': 'off',
+      'security/detect-bidi-characters': 'off',
     },
   },
   {
@@ -56,6 +74,7 @@ export default [
     },
     plugins: {
       '@typescript-eslint': tsPlugin,
+      'security': securityPlugin,
     },
     rules: {
       // Relax some rules for test files
 
@@ -1,6 +1,6 @@
 {
   "name": "@wgtechlabs/log-engine",
-  "version": "2.2.2",
+  "version": "2.3.0",
   "description": "A lightweight, security-first logging utility with automatic data redaction for Node.js applications - the first logging library with built-in PII protection.",
   "type": "module",
   "keywords": [
@@ -103,7 +103,8 @@
     "secure:test": "snyk test --org=wgtechlabs",
     "secure:code": "snyk code test --org=wgtechlabs",
     "secure": "run-s lint:security secure:test secure:code",
-    "validate": "run-s lint test build",
+    "size:check": "node scripts/check-size.js",
+    "validate": "run-s lint test build size:check",
     "clean": "rm -rf dist coverage",
     "coverage:open": "open coverage/lcov-report/index.html",
     "coverage:upload": "npx codecov"
 
@@ -0,0 +1,194 @@
+#!/usr/bin/env node
+
+/**
+ * @wgtechlabs/log-engine - Bundle Size Checker
+ * 
+ * This script validates that the built package remains lightweight by checking
+ * the total size of the dist directory and individual build formats.
+ * 
+ * ## Purpose
+ * As a lightweight logging library with zero dependencies, it's critical to
+ * maintain a small bundle size. This checker ensures the package doesn't
+ * exceed reasonable size limits for a lightweight library.
+ * 
+ * ## Size Limits
+ * - Total dist size: 1MB (1024KB)
+ * - ESM build: 512KB
+ * - CJS build: 512KB
+ * 
+ * ## Usage
+ * ```bash
+ * node scripts/check-size.js
+ * pnpm run size:check
+ * ```
+ * 
+ * ## Exit Codes
+ * - 0: All size checks passed
+ * - 1: Size limit exceeded or dist directory not found
+ * 
+ * @author WG Tech Labs
+ * @license MIT
+ */
+
+import { stat, readdir } from 'fs/promises';
+import { join, dirname } from 'path';
+import { fileURLToPath } from 'url';
+import { existsSync } from 'fs';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+// Size limits in KB
+const SIZE_LIMITS = {
+  total: 1024,     // 1MB total dist size
+  esm: 512,        // 512KB for ESM build
+  cjs: 512,        // 512KB for CJS build
+};
+
+/**
+ * Calculate the total size of a directory recursively
+ * 
+ * @param {string} dirPath - Path to directory
+ * @returns {Promise<number>} Total size in bytes
+ */
+async function getDirectorySize(dirPath) {
+  let totalSize = 0;
+
+  try {
+    const entries = await readdir(dirPath, { withFileTypes: true });
+
+    for (const entry of entries) {
+      const fullPath = join(dirPath, entry.name);
+
+      if (entry.isDirectory()) {
+        totalSize += await getDirectorySize(fullPath);
+      } else if (entry.isFile()) {
+        const stats = await stat(fullPath);
+        totalSize += stats.size;
+      }
+    }
+  } catch (error) {
+    // Only treat missing directories as empty; surface other errors
+    if (error && typeof error === 'object' && 'code' in error && error.code === 'ENOENT') {
+      return 0;
+    }
+
+    console.error(
+      `Failed to calculate directory size for "${dirPath}":`,
+      error
+    );
+    throw error;
+  }
+
+  return totalSize;
+}
+
+/**
+ * Format bytes to human-readable string
+ * 
+ * @param {number} bytes - Size in bytes
+ * @returns {string} Formatted size string
+ */
+function formatBytes(bytes) {
+  if (bytes === 0) return '0 B';
+  
+  const kb = bytes / 1024;
+  if (kb < 1) return `${bytes} B`;
+  
+  const mb = kb / 1024;
+  if (mb < 1) return `${kb.toFixed(2)} KB`;
+  
+  return `${mb.toFixed(2)} MB`;
+}
+
+/**
+ * Check if size is within limit
+ * 
+ * @param {number} sizeBytes - Actual size in bytes
+ * @param {number} limitKB - Limit in KB
+ * @param {string} label - Label for the check
+ * @returns {boolean} True if within limit
+ */
+function checkSize(sizeBytes, limitKB, label) {
+  const limitBytes = limitKB * 1024;
+  const percentage = (sizeBytes / limitBytes) * 100;
+  
+  const passed = sizeBytes <= limitBytes;
+  const icon = passed ? '✅' : '❌';
+  const status = passed ? 'PASS' : 'FAIL';
+  
+  console.log(`${icon} ${label.padEnd(20)} ${formatBytes(sizeBytes).padEnd(12)} / ${formatBytes(limitBytes).padEnd(12)} (${percentage.toFixed(1)}%) [${status}]`);
+  
+  return passed;
+}
+
+/**
+ * Main size checker function
+ */
+async function main() {
+  console.log('\n🔍 Log Engine Bundle Size Checker\n');
+  console.log('═'.repeat(80));
+  console.log();
+
+  const projectRoot = join(__dirname, '..');
+  const distPath = join(projectRoot, 'dist');
+
+  // Check if dist directory exists
+  if (!existsSync(distPath)) {
+    console.error('❌ Error: dist directory not found. Please run "pnpm build" first.\n');
+    process.exit(1);
+  }
+
+  const esmPath = join(distPath, 'esm');
+  const cjsPath = join(distPath, 'cjs');
+
+  // Check if expected build outputs exist
+  if (!existsSync(esmPath)) {
+    console.error('❌ Error: dist/esm directory not found. Build may be incomplete.\n');
+    process.exit(1);
+  }
+
+  if (!existsSync(cjsPath)) {
+    console.error('❌ Error: dist/cjs directory not found. Build may be incomplete.\n');
+    process.exit(1);
+  }
+
+  // Get directory sizes
+  const totalSize = await getDirectorySize(distPath);
+  const esmSize = await getDirectorySize(esmPath);
+  const cjsSize = await getDirectorySize(cjsPath);
+
+  console.log('📊 Bundle Size Report:\n');
+
+  // Check sizes against limits
+  const results = [];
+  results.push(checkSize(totalSize, SIZE_LIMITS.total, 'Total (dist)'));
+  results.push(checkSize(esmSize, SIZE_LIMITS.esm, 'ESM Build'));
+  results.push(checkSize(cjsSize, SIZE_LIMITS.cjs, 'CJS Build'));
+
+  console.log();
+  console.log('═'.repeat(80));
+
+  // Determine overall result
+  const allPassed = results.every(result => result === true);
+
+  if (allPassed) {
+    console.log('\n✅ All size checks passed! Package remains lightweight.\n');
+    process.exit(0);
+  } else {
+    console.log('\n❌ Size limit exceeded! Please review and optimize the bundle size.\n');
+    console.log('💡 Tips to reduce bundle size:');
+    console.log('   - Remove unused code and dependencies');
+    console.log('   - Check for duplicate code that can be refactored');
+    console.log('   - Review imports and ensure tree-shaking works properly');
+    console.log('   - Consider code splitting for large features\n');
+    process.exit(1);
+  }
+}
+
+// Run the checker
+main().catch((error) => {
+  console.error('\n❌ Unexpected error:', error.message);
+  console.error(error.stack);
+  process.exit(1);
+});