-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
feat(install): Add separator at the end of notes, highlight suggestions #6418
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
1b7b8fc
to
25ca8a1
Compare
The separator should only output when suggestion existed instead always, if we have to do this. |
We could remove |
That makes sense to me. Simply highlighting suggestions would be helpful as well. |
25ca8a1
to
6b2adae
Compare
WalkthroughAdded output formatting tweaks in the install script: an extra separator after notes and DarkYellow highlighting for unmet feature suggestions. Updated CHANGELOG under Unreleased to document this feature. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (5 passed)
✨ Finishing touches🧪 Generate unit tests
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal). Please share your feedback with us on this Discord post. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (3)
CHANGELOG.md (1)
3-6
: Wording nit: tighten the feature bulletConsider slight wording polish for consistency with other entries.
Apply this diff:
-- **install:** Add separator at the end of notes, highlight suggestions ([#6418](https://github.com/ScoopInstaller/Scoop/issues/6418)) +- **install:** Add separator after notes; highlight suggestions ([#6418](https://github.com/ScoopInstaller/Scoop/issues/6418))lib/install.ps1 (2)
358-364
: Optional: drop the “Notes” label when wrapped by separatorsPer review thread, removing the header reduces redundancy when the block is delimited above and below.
Apply this diff:
function show_notes($manifest, $dir, $original_dir, $persist_dir) { if ($manifest.notes) { - Write-Output 'Notes' Write-Output '-----' Write-Output (wraptext (substitute $manifest.notes @{ '$dir' = $dir; '$original_dir' = $original_dir; '$persist_dir' = $persist_dir })) Write-Output '-----' } }
422-424
: Color choice: avoid conflating with warningsIf
warn
logs are yellow in this codebase, DarkYellow suggestions may read as warnings. Consider a non-warning color (e.g., Cyan or DarkCyan) to distinguish suggestions.Would you like to switch to Cyan? If so:
- Write-Host "'$app' suggests installing '$([string]::join("' or '", $feature_suggestions))'." -ForegroundColor DarkYellow + Write-Host "'$app' suggests installing '$([string]::join("' or '", $feature_suggestions))'." -ForegroundColor CyanIf warnings aren’t yellow in practice, keeping DarkYellow is fine—please confirm.
As mentioned above, is it better to remove 'Notes' characters when they are wrapped by separators? Like: -Write-Output 'Notes'
Write-Output '-----'
Write-Output (wraptext (substitute $manifest.notes @{ '$dir' = $dir; '$original_dir' = $original_dir; '$persist_dir' = $persist_dir }))
Write-Output '-----' Or make 'Notes' characters wrapped by separators too? Like this: Write-Output '-----'
Write-Output 'Notes:'
Write-Output (wraptext (substitute $manifest.notes @{ '$dir' = $dir; '$original_dir' = $original_dir; '$persist_dir' = $persist_dir }))
Write-Output '-----' |
Keep it as is now imo. A |
Description
This PR makes the following changes:
feat(install)
: Add separator at the end of notes, highlight suggestions.Motivation and Context
The suggestion and note sections lack proper visual separation, and suggestion section isn't highlighted, making it easy to be ignored.
Checklist:
develop
branch.Summary by CodeRabbit
New Features
Documentation