feat: enhance commit and pre-commit hooks with environment variable support and improved logging

Author: TerrorSquad

booster/tools/git-hooks/hooks/commit-msg.ts

@@ -7,19 +7,28 @@
  * - Branch name validation using validate-branch-name
  * - Commit message linting with commitlint
  * - Automatic ticket footer appending when required
+ *
+ * Environment Variables:
+ * - SKIP_COMMITMSG=1: Skip the entire commit-msg hook
+ * - COMMITMSG_VERBOSE=1: Enable verbose output for debugging
  */
 
 import { $, fs, path } from 'zx'
+import validateBranchNameConfig from '../../../validate-branch-name.config.cjs'
 import {
+  getCurrentBranch,
   log,
-  shouldSkipDuringMerge,
   runTool,
   runWithRunner,
-  getCurrentBranch,
+  shouldSkipDuringMerge,
 } from '../shared/utils.ts'
 
 // Configure zx
-$.verbose = false
+$.verbose = process.env.COMMITMSG_VERBOSE === '1' || process.env.COMMITMSG_VERBOSE === 'true'
+
+// Fix locale issues that can occur in VS Code
+process.env.LC_ALL = 'C'
+process.env.LANG = 'C'
 
 /**
  * Branch validation configuration interface
@@ -43,51 +52,21 @@ interface ProcessedConfig {
   config: BranchConfig
 }
 
-/**
- * Options for running commands with runner
- */
-interface RunnerOptions {
-  quiet?: boolean
-  showCommand?: boolean
-}
-
 /**
  * Load and parse validate-branch-name configuration
  */
-async function loadConfig(): Promise<BranchConfig> {
-  const configPath = path.resolve('./validate-branch-name.config.cjs')
+function loadConfig(): BranchConfig {
+  const config = validateBranchNameConfig.config
 
-  if (!(await fs.pathExists(configPath))) {
-    throw new Error(`Configuration file not found: ${configPath}`)
-  }
-
-  try {
-    const content = await fs.readFile(configPath, 'utf8')
-
-    // Extract the config object from the CommonJS module
-    const configMatch = content.match(/const config = ({.*?});/s)
-    if (!configMatch) {
-      throw new Error('Could not find config object in config file')
-    }
-
-    const configStr = configMatch[1]
-
-    // Safely evaluate the JavaScript object
-    const config = eval(`(${configStr})`)
-
-    // Validate required properties and apply defaults
-    return {
-      types: Array.isArray(config.types) ? config.types : [],
-      ticketIdPrefix: config.ticketIdPrefix || null,
-      ticketNumberPattern: config.ticketNumberPattern || null,
-      commitFooterLabel: config.commitFooterLabel || 'Closes',
-      requireTickets: Boolean(config.requireTickets),
-      skipped: Array.isArray(config.skipped) ? config.skipped : [],
-      namePattern: config.namePattern || null,
-    }
-  } catch (error: unknown) {
-    const errorMessage = error instanceof Error ? error.message : String(error)
-    throw new Error(`Failed to load branch validation config: ${errorMessage}`)
+  // Validate required properties and apply defaults
+  return {
+    types: Array.isArray(config.types) ? config.types : [],
+    ticketIdPrefix: config.ticketIdPrefix || null,
+    ticketNumberPattern: config.ticketNumberPattern || null,
+    commitFooterLabel: config.commitFooterLabel || 'Closes',
+    requireTickets: Boolean(config.requireTickets),
+    skipped: Array.isArray(config.skipped) ? config.skipped : [],
+    namePattern: config.namePattern || null,
   }
 }
 
@@ -106,10 +85,6 @@ function processConfig(config: BranchConfig): ProcessedConfig {
   // Use explicit requireTickets flag, but validate that patterns exist if tickets are required
   const needTicket =
     config.requireTickets && !!(config.ticketIdPrefix && config.ticketNumberPattern)
-  console.log('Need ticket:', needTicket)
-  console.log('Ticket ID Prefix:', config.ticketIdPrefix)
-  console.log('Ticket Number Pattern:', config.ticketNumberPattern)
-  console.log('config.requireTickets:', config.requireTickets)
 
   let footerLabel = String(config.commitFooterLabel || 'Closes').trim()
 
@@ -216,7 +191,7 @@ async function lintCommitMessage(commitFile: string): Promise<boolean> {
  */
 async function appendTicketFooter(commitFile: string): Promise<void> {
   // Load and process configuration
-  const config = await loadConfig()
+  const config = loadConfig()
   const branchName = await getCurrentBranch()
 
   // Check if current branch is skipped (exempt from all validation)
@@ -272,6 +247,12 @@ async function main(): Promise<void> {
 
   log.step('Starting commit-msg validation...')
 
+  // Check if we should skip the entire hook
+  if (process.env.SKIP_COMMITMSG === '1' || process.env.SKIP_COMMITMSG === 'true') {
+    log.info('Skipping commit-msg validation (SKIP_COMMITMSG environment variable set)')
+    process.exit(0)
+  }
+
   // Check if we should skip all checks (during merge)
   if (await shouldSkipDuringMerge()) {
     log.info('Skipping commit-msg checks during merge')

booster/tools/git-hooks/hooks/pre-commit.ts

@@ -9,28 +9,43 @@
  * - ECS (code style auto-fixes)
  * - PHPStan (static analysis)
  * - Psalm (static analysis)
+ *
+ * Environment Variables:
+ * - SKIP_PRECOMMIT=1: Skip the entire pre-commit hook
+ * - FORCE_COMMIT=1: Continue with commit even if PHPStan or Psalm fail
+ * - PRECOMMIT_VERBOSE=1: Enable verbose output for debugging
  */
 
 import { $, fs } from 'zx'
 import {
-  log,
+  checkPhpSyntax,
+  exitIfChecksFailed,
   getStagedPhpFiles,
   hasVendorBin,
-  shouldSkipDuringMerge,
+  log,
   runTool,
-  checkPhpSyntax,
-  stageFiles,
   runVendorBin,
   runWithRunner,
-  exitIfChecksFailed,
+  shouldSkipDuringMerge,
+  stageFiles,
 } from '../shared/utils.ts'
 
 // Configure zx
-$.verbose = false
+$.verbose = process.env.PRECOMMIT_VERBOSE === '1' || process.env.PRECOMMIT_VERBOSE === 'true'
+
+// Fix locale issues that can occur in VS Code
+process.env.LC_ALL = 'C'
+process.env.LANG = 'C'
 
 async function main(): Promise<void> {
   log.step('Starting pre-commit checks...')
 
+  // Check if we should skip the entire hook
+  if (process.env.SKIP_PRECOMMIT === '1' || process.env.SKIP_PRECOMMIT === 'true') {
+    log.info('Skipping pre-commit checks (SKIP_PRECOMMIT environment variable set)')
+    process.exit(0)
+  }
+
   // Check if we should skip all checks
   if (await shouldSkipDuringMerge()) {
     log.info('Skipping pre-commit checks during merge')
@@ -55,6 +70,13 @@ async function main(): Promise<void> {
   // Track overall success
   let allSuccessful = true
 
+  // Check if we should force commit even if static analysis fails
+  const forceCommit = process.env.FORCE_COMMIT === '1' || process.env.FORCE_COMMIT === 'true'
+
+  if (forceCommit) {
+    log.info('Force commit mode enabled (FORCE_COMMIT environment variable set)')
+  }
+
   // Run Rector if available
   if (await hasVendorBin('rector')) {
     const success = await runTool('Rector', async () => {
@@ -100,7 +122,11 @@ async function main(): Promise<void> {
     })
 
     if (!success) {
-      allSuccessful = false
+      if (forceCommit) {
+        log.warn('PHPStan failed, but continuing due to FORCE_COMMIT flag')
+      } else {
+        allSuccessful = false
+      }
     }
   } else {
     log.skip('PHPStan not found in vendor/bin. Skipping...')
@@ -144,7 +170,11 @@ async function main(): Promise<void> {
     })
 
     if (!success) {
-      allSuccessful = false
+      if (forceCommit) {
+        log.warn('Psalm failed, but continuing due to FORCE_COMMIT flag')
+      } else {
+        allSuccessful = false
+      }
     }
   } else {
     log.skip('Psalm not found in vendor/bin. Skipping...')

booster/tools/git-hooks/shared/utils.ts

@@ -5,7 +5,7 @@
  * Provides consistent logging, file operations, and tool detection
  */
 
-import { $, fs, path, chalk } from 'zx'
+import { $, chalk, fs, path } from 'zx'
 
 // Configure zx behavior
 $.verbose = false
@@ -17,21 +17,6 @@ interface RunOptions {
   quiet?: boolean
 }
 
-/**
- * Detect if we're in a DDEV environment and DDEV is available
- */
-export async function isDdevRunning(): Promise<boolean> {
-  try {
-    // Check if DDEV is available and we're in a DDEV project
-    await $`ddev --version`.quiet()
-
-    // Check if .ddev directory exists (indicates DDEV project)
-    return await fs.pathExists('.ddev')
-  } catch (error) {
-    return false
-  }
-}
-
 /**
  * Check if we're already inside a DDEV container
  */
@@ -56,31 +41,33 @@ export async function runWithRunner(command: string[], options: RunOptions = {})
   let fullCommand: string[]
   let contextLabel: string
 
-  const isDdev = await isDdevRunning()
-  const isContainer = await isInsideDdevContainer()
+  const isInsideContainer = await isInsideDdevContainer()
 
-  if (isDdev && !isContainer) {
-    // We're in a DDEV project but not inside container - run via DDEV
+  if (!isInsideContainer) {
+    // We're not inside a container - run via DDEV
     fullCommand = ['ddev', 'exec', ...command]
     contextLabel = 'via DDEV'
   } else {
-    // Run directly (either no DDEV or already inside container)
+    // Run directly (already inside container)
     fullCommand = command
-    contextLabel = isContainer ? 'inside DDEV container' : 'direct'
+    contextLabel = isInsideContainer ? 'inside DDEV container' : 'direct'
   }
 
   // Log command execution if not quiet
   if (!quiet) {
     const commandStr = command.join(' ')
-    console.log(chalk.cyan(`🔧 Executing (${contextLabel}): ${commandStr}`))
+    log.info(`Executing (${contextLabel}): ${commandStr}`)
   }
 
-  // Execute with appropriate stdio handling
-  if (quiet) {
-    return await $({ stdio: 'pipe' })`${fullCommand}`
-  } else {
-    return await $({ stdio: 'inherit' })`${fullCommand}`
+  // Set clean environment to avoid locale warnings
+  const cleanEnv = {
+    ...process.env,
+    LC_ALL: 'C',
+    LANG: 'C',
   }
+
+  // Execute with appropriate stdio handling and clean environment
+  return await $({ stdio: quiet ? 'pipe' : 'inherit', env: cleanEnv })`${fullCommand}`
 }
 
 /**
@@ -112,7 +99,7 @@ export async function getStagedPhpFiles(): Promise<string[]> {
     // Filter for PHP files that actually exist
     const phpFiles: string[] = []
     for (const file of allFiles) {
-      if (file.endsWith('.php') && (await fs.pathExists(file))) {
+      if (file.endsWith('.php') && !file.includes('/vendor/') && (await fs.pathExists(file))) {
         phpFiles.push(file)
       }
     }
@@ -176,7 +163,24 @@ export async function getCurrentBranch(): Promise<string> {
     const result = await runWithRunner(['git', 'rev-parse', '--abbrev-ref', 'HEAD'], {
       quiet: true,
     })
-    return result.toString().trim()
+
+    // Clean the result to handle any locale warnings or extra output
+    const branchName = result.toString().trim()
+
+    // Extract just the last line if there are multiple lines (locale warnings, etc.)
+    const lines = branchName.split('\n').filter((line: string) => line.trim() !== '')
+    const cleanBranchName = lines[lines.length - 1].trim()
+
+    // Additional validation to ensure we have a valid branch name
+    if (
+      !cleanBranchName ||
+      cleanBranchName.includes('warning:') ||
+      cleanBranchName.includes('error:')
+    ) {
+      throw new Error(`Invalid branch name detected: "${cleanBranchName}"`)
+    }
+
+    return cleanBranchName
   } catch (error: unknown) {
     throw new Error(
       `Failed to get current branch: ${error instanceof Error ? error.message : String(error)}`,