fix: switch CI to TypeScript validator to resolve hanging bash script (#129 )

- Add TypeScript registry validator using Bun (< 1 second vs bash hanging)
- Install Bun in CI workflow
- Update workflow to use bun validator instead of bash script
- Add npm scripts for local validation
- Add comprehensive README for registry validation

This fixes the CI timeout issue where bash validator hangs in GitHub Actions.
The TypeScript validator is faster, more reliable, and easier to debug.

Related: Unblocks PR #128 which is currently failing due to bash script timeout

2026-01-29 10:34:26 +00:00

2.1 KiB

Raw Permalink Blame History

Registry Validation Scripts

This directory contains scripts to validate the registry.json file.

Available Scripts

TypeScript Version (Recommended) ⚡

Fast, modern, and easy to debug

# Run validation
npm run validate:registry

# Run with verbose output
npm run validate:registry:verbose

# Run with fix suggestions
npm run validate:registry:fix

# Or run directly with bun
bun run scripts/registry/validate-registry.ts
bun run scripts/registry/validate-registry.ts -v
bun run scripts/registry/validate-registry.ts -f

Requirements:

Bun runtime

Features:

✅ Fast execution (< 1 second)
✅ Easy to debug
✅ Type-safe
✅ Validates all registry paths
✅ Validates component dependencies
✅ Colored output
✅ Verbose mode
✅ Fix suggestions

Bash Version (Legacy)

Original bash script - still maintained for CI compatibility

# Run validation
./scripts/registry/validate-registry.sh

# Run with verbose output
./scripts/registry/validate-registry.sh -v

# Run with fix suggestions
./scripts/registry/validate-registry.sh -f

Requirements:

bash
jq

Note: The bash version may hang in some CI environments. The TypeScript version is recommended for local development.

What Gets Validated

Both scripts validate:

Registry JSON Format - Ensures registry.json is valid JSON
Component Paths - Verifies all file paths in the registry exist
Component Dependencies - Validates that all dependencies reference existing components

Exit Codes

0 - All paths valid, all dependencies valid
1 - Missing files or missing dependencies found
2 - Registry parse error or missing script dependencies

CI Integration

The GitHub Actions workflow (.github/workflows/validate-registry.yml) currently uses the bash version for compatibility with the base branch workflow file. Once this PR is merged, future PRs can use the TypeScript version.

Development

To modify the TypeScript validator:

Edit scripts/registry/validate-registry.ts
Test locally: npm run validate:registry
Commit changes

The TypeScript version is the source of truth for new features.

2.1 KiB Raw Permalink Blame History