@webpieces/code-rules 0.0.1 → 0.2.114

package/src/{validate-catch-error-pattern.ts → validate-catch-error-pattern.js}

@@ -1,3 +1,4 @@
+"use strict";
 /**
  * Validate Catch Error Pattern Executor
  *
@@ -35,57 +36,31 @@
  *   // webpieces-disable catch-error-pattern -- [your justification]
  *   } catch (err: unknown) {
  */
-
-import { execSync } from 'child_process';
-import * as fs from 'fs';
-import * as path from 'path';
-import * as ts from 'typescript';
-
-export type CatchErrorPatternMode = 'OFF' | 'MODIFIED_CODE' | 'MODIFIED_FILES';
-
-export interface ValidateCatchErrorPatternOptions {
-    mode?: CatchErrorPatternMode;
-    disableAllowed?: boolean;
-    ignoreModifiedUntilEpoch?: number;
-}
-
-export interface ExecutorResult {
-    success: boolean;
-}
-
-interface CatchViolation {
-    file: string;
-    line: number;
-    message: string;
-    context: string;
-}
-
-interface CatchViolationInfo {
-    line: number;
-    message: string;
-    context: string;
-    hasDisableComment: boolean;
-}
-
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = runValidator;
+const tslib_1 = require("tslib");
+const child_process_1 = require("child_process");
+const fs = tslib_1.__importStar(require("fs"));
+const path = tslib_1.__importStar(require("path"));
+const ts = tslib_1.__importStar(require("typescript"));
 /**
  * Check if a file is a test file that should be skipped.
  */
-function isTestFile(filePath: string): boolean {
+function isTestFile(filePath) {
     return filePath.includes('.spec.ts') ||
         filePath.includes('.test.ts') ||
         filePath.includes('__tests__/');
 }
-
 /**
  * Get changed TypeScript files between base and head.
  * Excludes test files.
  */
 // webpieces-disable max-lines-new-methods -- Git command handling with untracked files requires multiple code paths
-function getChangedTypeScriptFiles(workspaceRoot: string, base: string, head?: string): string[] {
+function getChangedTypeScriptFiles(workspaceRoot, base, head) {
     // eslint-disable-next-line @webpieces/no-unmanaged-exceptions
     try {
         const diffTarget = head ? `${base} ${head}` : base;
-        const output = execSync(`git diff --name-only ${diffTarget} -- '*.ts' '*.tsx'`, {
+        const output = (0, child_process_1.execSync)(`git diff --name-only ${diffTarget} -- '*.ts' '*.tsx'`, {
             cwd: workspaceRoot,
             encoding: 'utf-8',
         });
@@ -93,11 +68,10 @@ function getChangedTypeScriptFiles(workspaceRoot: string, base: string, head?: s
             .trim()
             .split('\n')
             .filter((f) => f && !isTestFile(f));
-
         if (!head) {
             // eslint-disable-next-line @webpieces/no-unmanaged-exceptions
             try {
-                const untrackedOutput = execSync(`git ls-files --others --exclude-standard '*.ts' '*.tsx'`, {
+                const untrackedOutput = (0, child_process_1.execSync)(`git ls-files --others --exclude-standard '*.ts' '*.tsx'`, {
                     cwd: workspaceRoot,
                     encoding: 'utf-8',
                 });
@@ -107,39 +81,37 @@ function getChangedTypeScriptFiles(workspaceRoot: string, base: string, head?: s
                     .filter((f) => f && !isTestFile(f));
                 const allFiles = new Set([...changedFiles, ...untrackedFiles]);
                 return Array.from(allFiles);
-            // webpieces-disable catch-error-pattern -- intentional swallow of git command failure
-            } catch {
+                // webpieces-disable catch-error-pattern -- intentional swallow of git command failure
+            }
+            catch {
                 return changedFiles;
             }
         }
-
         return changedFiles;
-    // webpieces-disable catch-error-pattern -- intentional swallow of git command failure
-    } catch {
+        // webpieces-disable catch-error-pattern -- intentional swallow of git command failure
+    }
+    catch {
         return [];
     }
 }
-
 /**
  * Get the diff content for a specific file.
  */
-function getFileDiff(workspaceRoot: string, file: string, base: string, head?: string): string {
+function getFileDiff(workspaceRoot, file, base, head) {
     // eslint-disable-next-line @webpieces/no-unmanaged-exceptions
     try {
         const diffTarget = head ? `${base} ${head}` : base;
-        const diff = execSync(`git diff ${diffTarget} -- "${file}"`, {
+        const diff = (0, child_process_1.execSync)(`git diff ${diffTarget} -- "${file}"`, {
             cwd: workspaceRoot,
             encoding: 'utf-8',
         });
-
         if (!diff && !head) {
             const fullPath = path.join(workspaceRoot, file);
             if (fs.existsSync(fullPath)) {
-                const isUntracked = execSync(`git ls-files --others --exclude-standard "${file}"`, {
+                const isUntracked = (0, child_process_1.execSync)(`git ls-files --others --exclude-standard "${file}"`, {
                     cwd: workspaceRoot,
                     encoding: 'utf-8',
                 }).trim();
-
                 if (isUntracked) {
                     const content = fs.readFileSync(fullPath, 'utf-8');
                     const lines = content.split('\n');
@@ -147,47 +119,44 @@ function getFileDiff(workspaceRoot: string, file: string, base: string, head?: s
                 }
             }
         }
-
         return diff;
-    // webpieces-disable catch-error-pattern -- intentional swallow of git command failure
-    } catch {
+        // webpieces-disable catch-error-pattern -- intentional swallow of git command failure
+    }
+    catch {
         return '';
     }
 }
-
 /**
  * Parse diff to extract changed line numbers (additions only).
  */
-function getChangedLineNumbers(diffContent: string): Set<number> {
-    const changedLines = new Set<number>();
+function getChangedLineNumbers(diffContent) {
+    const changedLines = new Set();
     const lines = diffContent.split('\n');
     let currentLine = 0;
-
     for (const line of lines) {
         const hunkMatch = line.match(/^@@ -\d+(?:,\d+)? \+(\d+)(?:,\d+)? @@/);
         if (hunkMatch) {
             currentLine = parseInt(hunkMatch[1], 10);
             continue;
         }
-
         if (line.startsWith('+') && !line.startsWith('+++')) {
             changedLines.add(currentLine);
             currentLine++;
-        } else if (line.startsWith('-') && !line.startsWith('---')) {
+        }
+        else if (line.startsWith('-') && !line.startsWith('---')) {
             // Deletions don't increment line number
-        } else {
+        }
+        else {
             currentLine++;
         }
     }
-
     return changedLines;
 }
-
 /**
  * Check if a line contains a disable comment for catch-error-pattern.
  * Recognizes both webpieces-disable and eslint-disable-next-line @webpieces/ formats.
  */
-function hasDisableComment(lines: string[], lineNumber: number): boolean {
+function hasDisableComment(lines, lineNumber) {
     const startCheck = Math.max(0, lineNumber - 5);
     for (let i = lineNumber - 2; i >= startCheck; i--) {
         const line = lines[i]?.trim() ?? '';
@@ -203,56 +172,37 @@ function hasDisableComment(lines: string[], lineNumber: number): boolean {
     }
     return false;
 }
-
 /**
  * Check if the catch block contains a disable comment for catch-error-pattern.
  */
-function hasBlockLevelDisable(sourceText: string, blockStart: number, blockEnd: number): boolean {
+function hasBlockLevelDisable(sourceText, blockStart, blockEnd) {
     const blockText = sourceText.substring(blockStart, blockEnd);
     return blockText.includes('webpieces-disable') && blockText.includes('catch-error-pattern') ||
         blockText.includes('@webpieces/catch-error-pattern');
 }
-
 /**
  * Check if the catch block body text contains the commented-out ignore pattern.
  */
-function hasIgnoreComment(
-    sourceText: string,
-    blockStart: number,
-    blockEnd: number,
-    expectedVarName: string,
-    actualParamName: string,
-): boolean {
+function hasIgnoreComment(sourceText, blockStart, blockEnd, expectedVarName, actualParamName) {
     const blockText = sourceText.substring(blockStart, blockEnd);
-    const ignorePattern = new RegExp(
-        `//\\s*const\\s+${expectedVarName}\\s*=\\s*toError\\(${actualParamName}\\)`,
-    );
+    const ignorePattern = new RegExp(`//\\s*const\\s+${expectedVarName}\\s*=\\s*toError\\(${actualParamName}\\)`);
     return ignorePattern.test(blockText);
 }
-
 /**
  * Validate a single CatchClause node.
  */
 // webpieces-disable max-lines-new-methods -- AST validation with multiple check paths for param name, type, and toError
-function validateCatchClause(
-    node: ts.CatchClause,
-    sourceFile: ts.SourceFile,
-    fileLines: string[],
-    depth: number,
-    disableAllowed: boolean,
-): CatchViolationInfo[] {
-    const violations: CatchViolationInfo[] = [];
+function validateCatchClause(node, sourceFile, fileLines, depth, disableAllowed) {
+    const violations = [];
     const suffix = depth === 1 ? '' : String(depth);
     const expectedParam = 'err' + suffix;
     const expectedVar = 'error' + suffix;
-
     const catchLine = sourceFile.getLineAndCharacterOfPosition(node.getStart(sourceFile)).line + 1;
     const catchContext = fileLines[catchLine - 1]?.trim() ?? '';
     const blockStart = node.block.getStart(sourceFile);
     const blockEnd = node.block.getEnd();
     const disabled = hasDisableComment(fileLines, catchLine) ||
         hasBlockLevelDisable(sourceFile.text, blockStart, blockEnd);
-
     const varDecl = node.variableDeclaration;
     if (!varDecl) {
         violations.push({
@@ -262,9 +212,7 @@ function validateCatchClause(
         });
         return violations;
     }
-
     const actualParam = ts.isIdentifier(varDecl.name) ? varDecl.name.text : expectedParam;
-
     // Check parameter name
     if (ts.isIdentifier(varDecl.name) && varDecl.name.text !== expectedParam) {
         violations.push({
@@ -273,7 +221,6 @@ function validateCatchClause(
             hasDisableComment: resolveDisable(disabled, disableAllowed),
         });
     }
-
     // Check type annotation is : unknown
     if (!varDecl.type || varDecl.type.kind !== ts.SyntaxKind.UnknownKeyword) {
         violations.push({
@@ -282,12 +229,10 @@ function validateCatchClause(
             hasDisableComment: resolveDisable(disabled, disableAllowed),
         });
     }
-
     // Check for commented-out ignore pattern
     if (hasIgnoreComment(sourceFile.text, blockStart, blockEnd, expectedVar, actualParam)) {
         return violations;
     }
-
     // Check first statement is const error = toError(err)
     if (node.block.statements.length === 0) {
         violations.push({
@@ -297,40 +242,26 @@ function validateCatchClause(
         });
         return violations;
     }
-
     const firstStmt = node.block.statements[0];
     const toErrorViolation = validateToErrorStatement(firstStmt, sourceFile, fileLines, expectedParam, expectedVar, actualParam, disabled, disableAllowed);
     if (toErrorViolation) {
         violations.push(toErrorViolation);
     }
-
     return violations;
 }
-
-function resolveDisable(disabled: boolean, disableAllowed: boolean): boolean {
+function resolveDisable(disabled, disableAllowed) {
     if (!disableAllowed && disabled) {
         return false;
     }
     return disabled;
 }
-
 /**
  * Validate that the first statement is `const error = toError(err);`
  */
 // webpieces-disable max-lines-new-methods -- Deep AST check for variable declaration with toError call expression
-function validateToErrorStatement(
-    stmt: ts.Statement,
-    sourceFile: ts.SourceFile,
-    fileLines: string[],
-    expectedParam: string,
-    expectedVar: string,
-    actualParam: string,
-    disabled: boolean,
-    disableAllowed: boolean,
-): CatchViolationInfo | null {
+function validateToErrorStatement(stmt, sourceFile, fileLines, expectedParam, expectedVar, actualParam, disabled, disableAllowed) {
     const stmtLine = sourceFile.getLineAndCharacterOfPosition(stmt.getStart(sourceFile)).line + 1;
     const stmtContext = fileLines[stmtLine - 1]?.trim() ?? '';
-
     if (!ts.isVariableStatement(stmt)) {
         return {
             line: stmtLine,
@@ -339,7 +270,6 @@ function validateToErrorStatement(
             hasDisableComment: resolveDisable(disabled, disableAllowed),
         };
     }
-
     const declarations = stmt.declarationList.declarations;
     if (declarations.length === 0) {
         return {
@@ -349,9 +279,7 @@ function validateToErrorStatement(
             hasDisableComment: resolveDisable(disabled, disableAllowed),
         };
     }
-
     const decl = declarations[0];
-
     // Check variable name
     if (ts.isIdentifier(decl.name) && decl.name.text !== expectedVar) {
         return {
@@ -361,7 +289,6 @@ function validateToErrorStatement(
             hasDisableComment: resolveDisable(disabled, disableAllowed),
         };
     }
-
     // Check initializer is toError(actualParam)
     const init = decl.initializer;
     if (!init || !ts.isCallExpression(init)) {
@@ -372,7 +299,6 @@ function validateToErrorStatement(
             hasDisableComment: resolveDisable(disabled, disableAllowed),
         };
     }
-
     if (!ts.isIdentifier(init.expression) || init.expression.text !== 'toError') {
         return {
             line: stmtLine,
@@ -381,7 +307,6 @@ function validateToErrorStatement(
             hasDisableComment: resolveDisable(disabled, disableAllowed),
         };
     }
-
     // Check argument
     const args = init.arguments;
     if (args.length !== 1 || !ts.isIdentifier(args[0]) || args[0].text !== actualParam) {
@@ -392,29 +317,21 @@ function validateToErrorStatement(
             hasDisableComment: resolveDisable(disabled, disableAllowed),
         };
     }
-
     return null;
 }
-
 /**
  * Find all catch pattern violations in a file using AST.
  */
-function findCatchViolationsInFile(
-    filePath: string,
-    workspaceRoot: string,
-    disableAllowed: boolean,
-): CatchViolationInfo[] {
+function findCatchViolationsInFile(filePath, workspaceRoot, disableAllowed) {
     const fullPath = path.join(workspaceRoot, filePath);
-    if (!fs.existsSync(fullPath)) return [];
-
+    if (!fs.existsSync(fullPath))
+        return [];
     const content = fs.readFileSync(fullPath, 'utf-8');
     const fileLines = content.split('\n');
     const sourceFile = ts.createSourceFile(filePath, content, ts.ScriptTarget.Latest, true);
-
-    const violations: CatchViolationInfo[] = [];
+    const violations = [];
     let catchDepth = 0;
-
-    function visit(node: ts.Node): void {
+    function visit(node) {
         if (ts.isCatchClause(node)) {
             catchDepth++;
             const clauseViolations = validateCatchClause(node, sourceFile, fileLines, catchDepth, disableAllowed);
@@ -425,105 +342,85 @@ function findCatchViolationsInFile(
         }
         ts.forEachChild(node, visit);
     }
-
     visit(sourceFile);
     return violations;
 }
-
 /**
  * MODIFIED_CODE mode: Flag violations on changed lines.
  */
-function findViolationsForModifiedCode(
-    workspaceRoot: string,
-    changedFiles: string[],
-    base: string,
-    head: string | undefined,
-    disableAllowed: boolean,
-): CatchViolation[] {
-    const violations: CatchViolation[] = [];
-
+function findViolationsForModifiedCode(workspaceRoot, changedFiles, base, head, disableAllowed) {
+    const violations = [];
     for (const file of changedFiles) {
         const diff = getFileDiff(workspaceRoot, file, base, head);
         const changedLines = getChangedLineNumbers(diff);
-
-        if (changedLines.size === 0) continue;
-
+        if (changedLines.size === 0)
+            continue;
         const allViolations = findCatchViolationsInFile(file, workspaceRoot, disableAllowed);
-
         for (const v of allViolations) {
-            if (disableAllowed && v.hasDisableComment) continue;
-            if (!changedLines.has(v.line)) continue;
-
+            if (disableAllowed && v.hasDisableComment)
+                continue;
+            if (!changedLines.has(v.line))
+                continue;
             violations.push({ file, line: v.line, message: v.message, context: v.context });
         }
     }
-
     return violations;
 }
-
 /**
  * MODIFIED_FILES mode: Flag ALL violations in modified files.
  */
-function findViolationsForModifiedFiles(
-    workspaceRoot: string,
-    changedFiles: string[],
-    disableAllowed: boolean,
-): CatchViolation[] {
-    const violations: CatchViolation[] = [];
-
+function findViolationsForModifiedFiles(workspaceRoot, changedFiles, disableAllowed) {
+    const violations = [];
     for (const file of changedFiles) {
         const allViolations = findCatchViolationsInFile(file, workspaceRoot, disableAllowed);
-
         for (const v of allViolations) {
-            if (disableAllowed && v.hasDisableComment) continue;
+            if (disableAllowed && v.hasDisableComment)
+                continue;
             violations.push({ file, line: v.line, message: v.message, context: v.context });
         }
     }
-
     return violations;
 }
-
 /**
  * Auto-detect the base branch by finding the merge-base with origin/main.
  */
-function detectBase(workspaceRoot: string): string | null {
+function detectBase(workspaceRoot) {
     // eslint-disable-next-line @webpieces/no-unmanaged-exceptions
     try {
-        const mergeBase = execSync('git merge-base HEAD origin/main', {
+        const mergeBase = (0, child_process_1.execSync)('git merge-base HEAD origin/main', {
             cwd: workspaceRoot,
             encoding: 'utf-8',
             stdio: ['pipe', 'pipe', 'pipe'],
         }).trim();
-
         if (mergeBase) {
             return mergeBase;
         }
-    // webpieces-disable catch-error-pattern -- intentional swallow of git command failure
-    } catch {
+        // webpieces-disable catch-error-pattern -- intentional swallow of git command failure
+    }
+    catch {
         // eslint-disable-next-line @webpieces/no-unmanaged-exceptions
         try {
-            const mergeBase = execSync('git merge-base HEAD main', {
+            const mergeBase = (0, child_process_1.execSync)('git merge-base HEAD main', {
                 cwd: workspaceRoot,
                 encoding: 'utf-8',
                 stdio: ['pipe', 'pipe', 'pipe'],
             }).trim();
-
             if (mergeBase) {
                 return mergeBase;
             }
-        // webpieces-disable catch-error-pattern -- intentional swallow of git command failure
-        } catch {
+            // webpieces-disable catch-error-pattern -- intentional swallow of git command failure
+        }
+        catch {
             // Ignore
         }
     }
     return null;
 }
-
 /**
  * Report violations to console.
  */
 // webpieces-disable max-lines-new-methods -- Console output with pattern examples and escape hatch
-function reportViolations(violations: CatchViolation[], mode: CatchErrorPatternMode, disableAllowed: boolean): void {
+function reportViolations(violations, mode, disableAllowed) {
     console.error('');
     console.error('\u274c Catch blocks must follow the standardized error handling pattern!');
     console.error('');
@@ -541,18 +438,17 @@ function reportViolations(violations: CatchViolation[], mode: CatchErrorPatternM
     console.error('');
     console.error('   For nested catches: err2/error2, err3/error3, etc.');
     console.error('');
-
     for (const v of violations) {
         console.error(`  \u274c ${v.file}:${v.line}`);
         console.error(`     ${v.message}`);
         console.error(`     ${v.context}`);
     }
     console.error('');
-
     if (disableAllowed) {
         console.error('   Escape hatch (use sparingly):');
         console.error('   // webpieces-disable catch-error-pattern -- [your reason]');
-    } else {
+    }
+    else {
         console.error('   Escape hatch: DISABLED (disableAllowed: false)');
         console.error('   Disable comments are ignored. Fix the catch block directly.');
     }
@@ -560,11 +456,10 @@ function reportViolations(violations: CatchViolation[], mode: CatchErrorPatternM
     console.error(`   Current mode: ${mode}`);
     console.error('');
 }
-
 /**
  * Resolve mode considering ignoreModifiedUntilEpoch override.
  */
-function resolveMode(normalMode: CatchErrorPatternMode, epoch: number | undefined): CatchErrorPatternMode {
+function resolveMode(normalMode, epoch) {
     if (epoch === undefined || normalMode === 'OFF') {
         return normalMode;
     }
@@ -577,63 +472,47 @@ function resolveMode(normalMode: CatchErrorPatternMode, epoch: number | undefine
     }
     return normalMode;
 }
-
-export default async function runValidator(
-    options: ValidateCatchErrorPatternOptions,
-    workspaceRoot: string
-): Promise<ExecutorResult> {
-    const mode: CatchErrorPatternMode = resolveMode(options.mode ?? 'OFF', options.ignoreModifiedUntilEpoch);
+async function runValidator(options, workspaceRoot) {
+    const mode = resolveMode(options.mode ?? 'OFF', options.ignoreModifiedUntilEpoch);
     const disableAllowed = options.disableAllowed ?? true;
-
     if (mode === 'OFF') {
         console.log('\n\u23ed\ufe0f  Skipping catch-error-pattern validation (mode: OFF)');
         console.log('');
         return { success: true };
     }
-
     console.log('\n\ud83d\udccf Validating Catch Error Pattern\n');
     console.log(`   Mode: ${mode}`);
-
     let base = process.env['NX_BASE'];
     const head = process.env['NX_HEAD'];
-
     if (!base) {
         base = detectBase(workspaceRoot) ?? undefined;
-
         if (!base) {
             console.log('\n\u23ed\ufe0f  Skipping catch-error-pattern validation (could not detect base branch)');
             console.log('');
             return { success: true };
         }
     }
-
     console.log(`   Base: ${base}`);
     console.log(`   Head: ${head ?? 'working tree (includes uncommitted changes)'}`);
     console.log('');
-
     const changedFiles = getChangedTypeScriptFiles(workspaceRoot, base, head);
-
     if (changedFiles.length === 0) {
         console.log('\u2705 No TypeScript files changed');
         return { success: true };
     }
-
     console.log(`\ud83d\udcc2 Checking ${changedFiles.length} changed file(s)...`);
-
-    let violations: CatchViolation[] = [];
-
+    let violations = [];
     if (mode === 'MODIFIED_CODE') {
         violations = findViolationsForModifiedCode(workspaceRoot, changedFiles, base, head, disableAllowed);
-    } else if (mode === 'MODIFIED_FILES') {
+    }
+    else if (mode === 'MODIFIED_FILES') {
         violations = findViolationsForModifiedFiles(workspaceRoot, changedFiles, disableAllowed);
     }
-
     if (violations.length === 0) {
         console.log('\u2705 No catch error pattern violations found');
         return { success: true };
     }
-
     reportViolations(violations, mode, disableAllowed);
-
     return { success: false };
 }
+//# sourceMappingURL=validate-catch-error-pattern.js.map