Add README for PHP extension with detailed information#118
Open
Maybach91 wants to merge 3 commits intozed-extensions:mainfrom
Open
Add README for PHP extension with detailed information#118Maybach91 wants to merge 3 commits intozed-extensions:mainfrom
Maybach91 wants to merge 3 commits intozed-extensions:mainfrom
Conversation
Add comprehensive documentation for the PHP extension, covering capabilities, limitations, prerequisites, installation, configuration, debugging, contributing, and useful links.
There was a problem hiding this comment.
Pull request overview
Adds an initial comprehensive README.md for the PHP Zed extension to document capabilities/limitations and provide setup/configuration/debugging/contributing guidance (addressing Issue #105).
Changes:
- Introduces a full README describing language server options, syntax/highlighting features, and Xdebug debugging.
- Adds configuration examples for Zed settings and Tailwind CSS language server integration.
- Documents contributing/build steps and repository file layout.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| - **Tree-sitter grammar** ([tree-sitter/tree-sitter-php](https://github.com/tree-sitter/tree-sitter-php)) for fast, local, offline parsing | ||
| - **PHPDoc syntax highlighting** ([claytonrcarter/tree-sitter-phpdoc](https://github.com/claytonrcarter/tree-sitter-phpdoc)) inside doc comment blocks | ||
| - Language injection: HTML, CSS, JavaScript, and SQL embedded in PHP files are highlighted in their respective grammars |
| - **Outline panel** showing classes, methods, and functions | ||
| - **Symbol indexing** for workspace-wide navigation | ||
| - **Test detection** — automatically detects PHPUnit test methods for run/debug from the editor | ||
| - **Text objects** for selecting PHP constructs (functions, classes, arguments) |
| { | ||
| "label": "PHP: Listen to Xdebug", | ||
| "adapter": "Xdebug", | ||
| "request": "launch", |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Adds a comprehensive README.md documenting the Zed PHP extension’s features, configuration, debugging workflow, contribution guidelines, and related links, addressing Issue #105’s request for capability/limitation documentation.
Changes:
- Documented supported language servers (Phpactor/Intelephense/PHP Tools), syntax highlighting, runnables, and Xdebug debugging.
- Added setup/config examples for Zed settings and Tailwind CSS language injection.
- Added contributor-oriented sections (build, local dev, code quality commands, repo layout).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add comprehensive documentation for the PHP extension, covering capabilities, limitations, prerequisites, installation, configuration, debugging, contributing, and useful links.
Generated by Claude. :) But it may be a better start then no README.md at all.
#105