@bluefly/reelcode v1.0.3

ReelCode - Code Standards Validator

A TypeScript-based tool for validating and enforcing code standards across JavaScript, TypeScript, and PHP projects.

Current Status

This tool provides code validation and standards enforcement capabilities. The core validation framework exists, with many advanced features still in development.

What Works

• Basic CLI interface
• TypeScript compilation
• Configuration file support (YAML)
• Basic linting integration
• ESLint configuration
• Simple validation reporting

In Progress

• 🚧 JavaScript validation engine
• 🚧 TypeScript validation engine
• 🚧 PHP validation support
• 🚧 AI-powered code suggestions
• 🚧 Standards inheritance system
• 🚧 CI/CD integration generators
• 🚧 Ownership tracking
• 🚧 Custom rule creation

Planned (Not Started)

• 📋 Machine learning for code pattern detection
• 📋 Auto-fix capabilities
• 📋 Team collaboration features
• 📋 IDE integrations
• 📋 Performance profiling

Installation

npm install -g reelcode

Basic Usage

# Validate current directory
reelcode validate

# Validate specific files
reelcode validate src/**/*.ts

# Check configuration
reelcode config check

# Generate report
reelcode report --format json

Configuration

Create a reelcode.config.yaml file in your project root:

standards:
  - javascript: es2022
  - typescript: strict
  - php: psr-12

rules:
  max-line-length: 100
  indent-size: 2
  quote-style: single

ignore:
  - node_modules/
  - dist/
  - vendor/

CLI Commands

validate

reelcode validate [options] [files...]

Validates code against configured standards.

config

reelcode config check
reelcode config init

Manages configuration files.

report

reelcode report --format [json|html|markdown]

Generates validation reports.

Development

# Install dependencies
npm install

# Build the project
npm run build

# Run tests
npm test

# Development mode
npm run dev

Architecture

reelcode/
├── src/
│   ├── cli/          # CLI command implementations
│   ├── core/         # Core validation logic
│   ├── validation/   # Language-specific validators
│   └── utils/        # Utility functions
├── bin/              # CLI entry point
└── config/          # Default configurations

Validation Engines

JavaScript

• ES2022 compliance
• Best practices enforcement
• Security vulnerability detection

TypeScript

• Type safety validation
• Strict mode compliance
• TSConfig validation

PHP (Planned)

• PSR-12 compliance
• Security best practices
• Dependency validation

Integration

ESLint

ReelCode can work alongside ESLint:

{
  "extends": ["reelcode/recommended"]
}

CI/CD

Generate CI configurations:

reelcode ci generate --platform gitlab

Testing

# Run all tests
npm test

# Run specific test suite
npm test -- validation

# Coverage report
npm run test:coverage

Known Issues

• Limited PHP support
• AI features not implemented
• Performance issues with large codebases
• Some edge cases in TypeScript validation
• CI generation is basic

Contributing

Guidelines:

1. Add tests for new validators
2. Follow TypeScript strict mode
3. Document validation rules
4. Update CLI help text

License

MIT