components: Instructions file for GitHub Copilot

GitHub Copilot Instructions for FriendsOfHyperf Components

This repository contains a monorepo of popular components for the Hyperf PHP framework. This document provides guidance for GitHub Copilot to better understand the project structure and conventions.

Note: Also see CLAUDE.md and AGENTS.md in the repository root for additional development guidance.

Project Overview

• Repository: friendsofhyperf/components
• Type: Monorepo containing 49 Hyperf components
• PHP Version: >=8.2
• Framework: Hyperf >=3.2.0
• Testing Framework: Pest (PHPUnit under the hood)
• License: MIT
• Main Author: Deeka Wong ([email protected])

Repository Structure

/
├── bin/                    # Utility scripts
├── docs/                   # Multi-language documentation (VitePress)
├── src/                    # Component source code (49 components)
├── tests/                  # Test suites (Pest)
├── types/                  # PHP type stubs
├── .github/                # GitHub workflows and configuration
├── composer.json           # Main composer configuration
├── package.json            # Documentation build configuration
├── phpstan.neon.dist       # PHPStan configuration
├── CLAUDE.md               # Claude Code (claude.ai/code) development guidance
└── AGENTS.md               # Repository guidelines for agents

Component Architecture

Each component in src/ follows this structure:

src/{component-name}/
├── .gitattributes
├── .github/                # Component-specific GitHub config
├── LICENSE
├── README.md
├── composer.json           # Component-specific dependencies
└── src/                    # Component source code
    ├── ConfigProvider.php  # Hyperf configuration provider
    └── [component files]

Key Components Include:

Development Tools:

• telescope: Application debugging and monitoring
• tinker: Interactive REPL
• ide-helper: IDE autocompletion helper
• pretty-console: Enhanced console output