Add pre-commit hook to auto-remove ESLint warnings

When developers modify files that are in the ESLint warnings list,
this pre-commit hook automatically removes those files from the
warnings list in eslint.config.mjs. This enforces that any touched
file must have its ESLint errors fixed before committing.

The update-eslint-warnings script runs before lint-staged in the
pre-commit hook, ensuring modified files are subject to full ESLint
error checking rather than just warnings. This helps gradually clean
up the codebase as developers work on different files.

Author: samholmes

package.json

@@ -45,7 +45,7 @@
     "maestro": "node -r sucrase/register ./scripts/runMaestro.ts",
     "maestro:ios": "node -r sucrase/register ./scripts/runMaestro.ts test --include-tags all,ios maestro",
     "maestro:android": "node -r sucrase/register ./scripts/runMaestro.ts test --include-tags all,android maestro",
-    "precommit": "npm run localize && lint-staged && tsc && npm test",
+    "precommit": "npm run localize && npm run update-eslint-warnings && lint-staged && tsc && npm test",
     "prepare.ios": "(cd ios; pod repo update; pod install)",
     "prepare": "husky install && ./scripts/prepare.sh",
     "server": "node ./loggingServer.js",
@@ -57,7 +57,8 @@
     "updateVersion": "node -r sucrase/register scripts/updateVersion.ts",
     "updot": "EDGE_MODE=development updot",
     "verify": "npm run lint && npm run typechain && npm run tsc && npm run test",
-    "watch": "npm test -- --watch"
+    "watch": "npm test -- --watch",
+    "update-eslint-warnings": "node -r sucrase/register ./scripts/updateEslintWarnings.ts"
   },
   "lint-staged": {
     "*.{js,jsx,ts,tsx}": "eslint"

scripts/updateEslintWarnings.ts

@@ -0,0 +1,111 @@
+#!/usr/bin/env node
+import { execSync } from 'child_process'
+import fs from 'fs'
+import path from 'path'
+
+// Get the root directory
+const rootDir = path.resolve(__dirname, '..')
+const eslintConfigPath = path.join(rootDir, 'eslint.config.mjs')
+
+// Get list of staged files
+function getStagedFiles(): string[] {
+  try {
+    const output = execSync(
+      'git diff --cached --name-only --diff-filter=ACMR',
+      { encoding: 'utf8' }
+    )
+    return output
+      .trim()
+      .split('\n')
+      .filter(file => file.length > 0)
+  } catch (error) {
+    console.error('Error getting staged files:', error)
+    return []
+  }
+}
+
+// Remove staged files from the warnings list
+function removeStagedFilesFromWarningsList(): void {
+  const stagedFiles = getStagedFiles()
+  if (stagedFiles.length === 0) {
+    console.log('No staged files to process')
+    return
+  }
+
+  console.log('Processing staged files:', stagedFiles.length)
+
+  // Read the config file
+  let configContent = fs.readFileSync(eslintConfigPath, 'utf8')
+
+  // Track what was removed
+  let removedCount = 0
+  const removedFiles: string[] = []
+
+  // Process each staged file
+  for (const stagedFile of stagedFiles) {
+    // Create regex to match the file in the array with surrounding quotes and possible comma
+    // This handles files with quotes like 'file.ts' or "file.ts"
+    const patterns = [
+      new RegExp(
+        `^(\\s*)(['"])${stagedFile.replace(
+          /[.*+?^${}()|[\]\\]/g,
+          '\\$&'
+        )}\\2,?\\s*$`,
+        'gm'
+      ),
+      new RegExp(
+        `^(\\s*)(['"])${stagedFile.replace(
+          /[.*+?^${}()|[\]\\]/g,
+          '\\$&'
+        )}\\2,?\\s*\n`,
+        'gm'
+      )
+    ]
+
+    for (const pattern of patterns) {
+      const matches = configContent.match(pattern)
+      if (matches != null) {
+        configContent = configContent.replace(pattern, '')
+        removedFiles.push(stagedFile)
+        removedCount++
+        break
+      }
+    }
+  }
+
+  if (removedCount > 0) {
+    // Clean up any double newlines that might have been created
+    configContent = configContent.replace(/\n\s*\n\s*\n/g, '\n\n')
+
+    // Fix any trailing commas before the closing bracket
+    configContent = configContent.replace(/,(\s*\])/g, '$1')
+
+    // Write the updated config
+    fs.writeFileSync(eslintConfigPath, configContent, 'utf8')
+
+    // Stage the updated ESLint config
+    try {
+      execSync(`git add ${eslintConfigPath}`)
+      console.log(
+        `\nRemoved ${removedCount} file(s) from ESLint warnings list:`
+      )
+      removedFiles.forEach(file => {
+        console.log(`  - ${file}`)
+      })
+      console.log('\nUpdated eslint.config.mjs has been staged')
+    } catch (error) {
+      console.error('Error staging ESLint config:', error)
+      process.exit(1)
+    }
+  } else {
+    console.log('No staged files found in the ESLint warnings list')
+  }
+}
+
+// Main execution
+try {
+  removeStagedFilesFromWarningsList()
+} catch (error) {
+  console.error('Error:', error)
+  process.exit(1)
+}