Files
bitvid/scripts/check-hex.js
T
thePR0M3TH3ANandClaude Opus 4.8 b8ac09ef7e [lint] Exclude the four live/shorts plan docs from the hex-color check
check-hex.js flagged planning-doc TODO refs like "**#16c**" / "**#16b**" as
3-digit hex colors (16c, 16b are valid hex), breaking `npm run lint` on HEAD.
Same false positive docs/capacitor-native-app-plan.md was already excluded for.
Add shorts-plan / live-ingest-plan / live-publish-plan / bitvid-bridge-plan.

Co-Authored-By: Claude Opus 4.8 <[email protected]>
2026-07-01 16:11:41 -04:00

100 lines
2.6 KiB
JavaScript
Executable File

#!/usr/bin/env node
import { spawnSync } from "node:child_process";
// Use PCRE2 lookbehind to avoid:
// 1. Matches preceded by a word character (e.g. `Issue#123`)
// 2. Matches preceded by `&` (e.g. HTML entities `&#039;`)
const SEARCH_PATTERN = '(?<!&|[\\w])#[0-9a-fA-F]{3,8}\\b';
// Allow-list tokens and vector logos so brand assets can keep their baked colors.
// These are translated to git pathspec exclusions.
const IGNORED_GLOBS = [
'css/tokens.css',
'**/*.svg',
'**/node_modules/**',
'.git/**',
'**/*.min.js',
'**/*.map',
'css/tailwind.generated.css',
'dist/**',
'build/**',
'vendor/**',
'js/utils/qrcode.js',
'**/dist/**',
'REMEDIATION_REPORT.md',
'CHANGELOG.md',
'scripts/daily-design-system-audit.mjs',
'config/instance-config.js',
'config/validate-config.js',
'js/embed.js',
'tests/unit/embed-accent.test.mjs',
'tests/visual/embed-layout.spec.ts',
'ai/**',
'**/*.ai',
'releases/**',
'bitvid-working-webtorrent/**',
'scripts/agent/**',
'docs/capacitor-native-app-plan.md',
// Planning docs cite TODO/issue refs (e.g. "16c", "16b") that read as 3-digit hex.
'docs/shorts-plan.md',
'docs/live-ingest-plan.md',
'docs/live-publish-plan.md',
'docs/bitvid-bridge-plan.md',
'perf/**',
'test_logs/**',
'context/**',
'decisions/**',
'todo/**',
'test-audit/**',
'js/webtorrent.min.js',
'js/webtorrent.min.js.map',
];
const gitArgs = [
'grep',
'-n',
'-I', // Ignore binary files
'-P', // Enable PCRE2 for lookbehind support
SEARCH_PATTERN,
'--',
'.'
];
// Add exclusions
for (const glob of IGNORED_GLOBS) {
gitArgs.push(`:(exclude)${glob}`);
}
// We rely on 'git' being available and 'git grep' supporting -P.
// Typically available in most CI/dev environments.
// Increase maxBuffer to 10MB to prevent ENOBUFS on large minified files
const result = spawnSync('git', gitArgs, { encoding: 'utf8', maxBuffer: 10 * 1024 * 1024 });
if (result.error) {
console.error('Failed to execute git grep:', result.error.message);
process.exit(2);
}
// git grep exits with:
// 0 when matches are found (failure for us),
// 1 when no matches are found (success for us),
// 2+ on errors.
if (result.status === 0 && result.stdout.trim()) {
console.error('Hex colors detected outside tokens or SVG assets:');
console.error(result.stdout.trimEnd());
console.error('\nAllowed exceptions: tokens (css/tokens.css) and vector logos (*.svg).');
process.exit(1);
}
if (result.status && result.status !== 1) {
console.error('git grep reported an error while scanning for hex values.');
if (result.stderr) {
console.error(result.stderr.trimEnd());
}
process.exit(result.status);
}
process.exit(0);