Port make help grouping from yiisoft/app#267
Conversation
Co-authored-by: samdark <47294+samdark@users.noreply.github.com>
make help grouping from yiisoft/app
There was a problem hiding this comment.
Pull request overview
Ports the grouped make help output format from yiisoft/app so Make targets are displayed under section headers (instead of a flat list), improving usability of developer tooling in this repo.
Changes:
- Updated
Makefilehelp formatter to print section headers based on# Sectioncomments and standardized target descriptions. - Simplified section comment formatting in
docker/.envto align with the new help grouping approach. - Added a changelog entry for #266 documenting the enhancement.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
Makefile |
Adds section-based grouping for make help and updates target descriptions for consistent formatting. |
docker/.env |
Collapses multi-line section comment blocks into single # Section lines. |
CHANGELOG.md |
Records the make help grouping enhancement under #266. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| printf " \033[36m%-25s\033[0m %s\n", target, desc; \ | ||
| blank = 0; \ |
There was a problem hiding this comment.
The new make help awk parser prints any make rule that matches the target regex, even if it has no ## description. This changes prior behavior (undocumented targets were hidden) and can lead to empty-description entries or noise if other included makefiles contain rules. Consider filtering to only lines containing ## (or skipping when parts[2] is empty) so the help output stays intentional and stable.
| printf " \033[36m%-25s\033[0m %s\n", target, desc; \ | |
| blank = 0; \ | |
| if (desc != "") { \ | |
| printf " \033[36m%-25s\033[0m %s\n", target, desc; \ | |
| blank = 0; \ | |
| } \ |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #267 +/- ##
=========================================
Coverage 76.70% 76.70%
Complexity 52 52
=========================================
Files 16 16
Lines 176 176
=========================================
Hits 135 135
Misses 41 41 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Ports yiisoft/app#448 — improves
make helpoutput to display targets organized under named section headers instead of a flat list.Changes
Makefileawkhelp formatter with one that reads# Sectioncomments as group headers# Toolssection groupingyii,composer,rector,cs-fix## ...descriptions totestandtest-coverage(previously invisible inmake help)PROD |prefix from production target descriptions — group header now carries that contextdocker/.env— simplified section comments from three-line#\n# Section\n#blocks to single# Sectionlines (required for the new awk parser to detect group boundaries)CHANGELOG.md— added entry for#266make helpoutput after changesOriginal prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.