components: Instructions file for Claude Code

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Repository Overview

This is a monorepo containing 50+ production-ready components for the Hyperf PHP framework. Each component in src/ is independently installable and can be split into its own repository.

• PHP Version: >=8.2
• Framework: Hyperf >=3.2.0
• Testing Framework: Pest (PHPUnit under the hood)
• License: MIT

Development Commands

Testing

# Run all tests (lint, unit, type coverage)
composer test

# Run unit tests only
composer test:unit
# Or directly: vendor/bin/pest

# Run specific test group
vendor/bin/pest --group=telescope
vendor/bin/pest --group=http-client

# Run linting (code style check)
composer test:lint

# Run type coverage analysis
composer test:types

Code Quality

# Fix code style issues
composer cs-fix

# Run static analysis (PHPStan)
composer analyse

# Run type coverage analysis
composer analyse:types

Component Management

# Normalize composer.json files across all components
composer json-fix

# Generate README.md for components
composer gen:readme

# Check for pending repository changes
composer repo:pending

Architecture

Monorepo Structure

Each component follows a standardized structure:

src/{component-name}/
├── composer.json           # Component-specific dependencies
├── LICENSE
├── README.md
└── src/
    ├── ConfigProvider.php  # Hyperf auto-discovery
    └── [component files]

Configuration Providers

All components use Hyperf's ConfigProvider pattern for auto-discovery. When a component is installed, Hyperf automatically registers it via the ConfigProvider class. Key patterns:

• Namespace Convention: FriendsOfHyperf\{ComponentName}
• ConfigProvider defines: dependencies, commands, listeners, aspects, annotations
• Publishing: Components can publish config files and migrations to user applications