Added installer version and improved welcome wording in the installer.

[AlexSkrypnyk]

Summary by CodeRabbit

• New Features

  • Improved display of installer version information and logo alignment in the installer interface.
  • Enhanced styling for keyboard shortcut hints and underlined version descriptors for better readability.
  • Footer instructions are now grouped and formatted for clearer guidance.

• Style

  • Updated emoji and phrasing in progress and header messages for a friendlier and more polished user experience.
  • Improved word wrapping and ANSI color styling for multi-line text in terminal output.

• Bug Fixes

  • Fixed multi-line color and underline formatting for terminal output.

• Tests

  • Updated expected output in tests to reflect new welcome message phrasing.

[coderabbitai]

Walkthrough

This update refines user interface text and visual formatting in the Vortex installer, focusing on improved emoji usage, header/footer clarity, and enhanced ANSI styling for multi-line strings. It also adjusts test assertions to match updated output, and introduces utility methods for consistent text styling in the terminal UI.

Changes

File(s)	Change Summary
.vortex/installer/src/Command/InstallCommand.php	Refined UI text: updated emojis, centered header/logo, improved version display, clearer instructions, and footer.
.vortex/installer/src/Utils/Tui.php	Enhanced word wrapping, added underscore and escapeMultiline methods, refactored color/style methods.
.vortex/installer/tests/Functional/InstallTest.php, .vortex/installer/tests/Functional/PharTest.php	Updated test assertions to match revised welcome message with "the" added.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant InstallCommand
    participant Tui

    User->>InstallCommand: Run installer
    InstallCommand->>Tui: Render header (centered logo, version)
    InstallCommand->>Tui: Display progress (with updated emojis)
    InstallCommand->>Tui: Render footer (clearer instructions)
    Note over InstallCommand,Tui: Tui applies multi-line ANSI styling
    InstallCommand->>User: Show updated UI and instructions

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

• Added a smaller header to the installer. #1724: Both PRs modify the header() method in the InstallCommand class to change the installer header display, with the main PR refining the header centering and version display while the retrieved PR adds a smaller header variant and dynamic selection based on terminal width.

Suggested labels

PR: Needs review

Poem

A rabbit hopped across the screen,
To polish text and make it clean.
Emojis swapped, instructions neat,
Headers centered, quite a feat!
Colors now dance on every line—
This installer’s looking mighty fine!
🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 phpcs (3.7.2)

.vortex/installer/src/Command/InstallCommand.php

ERROR: Referenced sniff "Drupal" does not exist

Run "phpcs --help" for usage information

.vortex/installer/src/Utils/Tui.php

ERROR: Referenced sniff "Drupal" does not exist

Run "phpcs --help" for usage information

.vortex/installer/tests/Functional/InstallTest.php

ERROR: Referenced sniff "Drupal" does not exist

Run "phpcs --help" for usage information

• 1 others

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between daeba7f and cc089b7.

📒 Files selected for processing (4)

• .vortex/installer/src/Command/InstallCommand.php (5 hunks)
• .vortex/installer/src/Utils/Tui.php (2 hunks)
• .vortex/installer/tests/Functional/InstallTest.php (2 hunks)
• .vortex/installer/tests/Functional/PharTest.php (3 hunks)

🧰 Additional context used

🧠 Learnings (2)

.vortex/installer/tests/Functional/InstallTest.php (2)

Learnt from: AlexSkrypnyk
PR: drevops/vortex#0
File: :0-0
Timestamp: 2025-05-29T12:15:32.188Z
Learning: Do not review files in .vortex/installer/tests/Fixtures/install directory as they are test fixtures.

Learnt from: AlexSkrypnyk
PR: #1697
File: .vortex/installer/tests/Fixtures/install/provision_database_lagoon/docs/onboarding.md:16-17
Timestamp: 2025-06-02T00:41:36.321Z
Learning: DO NOT EVER REVIEW FILES IN .vortex/installer/tests/Fixtures/ directory - these are test fixtures and should not be reviewed under any circumstances.

.vortex/installer/tests/Functional/PharTest.php (3)

Learnt from: AlexSkrypnyk
PR: drevops/vortex#0
File: :0-0
Timestamp: 2025-05-29T12:15:32.188Z
Learning: Do not review files in .vortex/installer/tests/Fixtures/install directory as they are test fixtures.

Learnt from: AlexSkrypnyk
PR: #1697
File: .vortex/installer/tests/Fixtures/install/provision_database_lagoon/docs/onboarding.md:16-17
Timestamp: 2025-06-02T00:41:36.321Z
Learning: DO NOT EVER REVIEW FILES IN .vortex/installer/tests/Fixtures/ directory - these are test fixtures and should not be reviewed under any circumstances.

Learnt from: AlexSkrypnyk
PR: #1693
File: .vortex/installer/src/Prompts/Handlers/Internal.php:52-52
Timestamp: 2025-06-01T08:10:15.903Z
Learning: The File utility class in .vortex/installer/src/Utils/File.php extends AlexSkrypnyk\File\File, and methods like collapseRepeatedEmptyLines() are available from this external parent class dependency.

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (12)

• GitHub Check: build (1)
• GitHub Check: build (0)
• GitHub Check: vortex-test-workflow (1)
• GitHub Check: vortex-test-workflow (2)
• GitHub Check: vortex-test-workflow (0)
• GitHub Check: vortex-test-workflow (3)
• GitHub Check: vortex-test-deployment (0)
• GitHub Check: vortex-test-deployment (1)
• GitHub Check: vortex-test-common
• GitHub Check: vortex-test-installer (8.3)
• GitHub Check: vortex-test-installer (8.4)
• GitHub Check: vortex-test-installer (8.2)

🔇 Additional comments (9)

.vortex/installer/tests/Functional/PharTest.php (1)

61-61: LGTM! Consistent test assertion updates.

The test assertions have been correctly updated to include the definite article "the" in the welcome message, maintaining consistency with the updated installer output.

Also applies to: 70-70, 80-80

.vortex/installer/tests/Functional/InstallTest.php (1)

117-117: LGTM! Consistent test assertion updates.

The test assertions have been correctly updated to include the definite article "the" in the welcome message, ensuring consistency across both the test method and data provider with the updated installer output.

Also applies to: 137-137, 143-143

.vortex/installer/src/Command/InstallCommand.php (4)

140-140: LGTM! Improved emoji choices for better semantic meaning.

The emoji updates improve semantic clarity: 📁 better represents "Preparing destination directory" than 🥣, and 🎭 is more appropriate for "Preparing demo content" than 🎬.

Also applies to: 152-152

---

391-396: LGTM! Enhanced logo display and version information.

The improvements include:

• Centering with a sensible max width (80 characters) for better readability
• Adding installer version display with proper placeholder replacement
• Proper alignment and formatting

---

399-399: LGTM! Improved user-facing text with better grammar and styling.

The enhancements include:

• Adding the definite article "the" for improved grammar
• Using underscore styling to emphasize version descriptors (stable, development, custom)
• Highlighting keyboard shortcuts (Ctrl+C, Ctrl+U) in yellow for better visibility
• More natural and user-friendly phrasing throughout

Also applies to: 404-404, 407-407, 410-410, 423-423, 425-425, 428-428, 431-431, 433-434

---

450-461: LGTM! Improved footer formatting with clear structure.

The footer now has better organization with:

• Clear sectioning of instructions
• Proper indentation for commands
• Logical grouping of related steps (add/commit, build, CI/CD setup)
• Enhanced readability with appropriate spacing

.vortex/installer/src/Utils/Tui.php (3)

89-93: LGTM! Improved text wrapping precision in box display.

The enhancements include:

• More accurate offset calculation (6 characters) accounting for margins, borders, and padding
• Word wrapping with cut=FALSE to prevent breaking words mid-word
• Title underline calculation fix to use only the first line length for proper formatting

Also applies to: 96-96, 98-98

---

171-171: LGTM! Refactored styling methods for consistency and maintainability.

The refactoring improves the codebase by:

• Delegating all color/style methods to the new escapeMultiline helper
• Adding a new underscore method for underline styling
• Ensuring consistent ANSI escape sequence handling across all styling methods
• Improving maintainability with a centralized approach

Also applies to: 175-175, 179-179, 183-183, 187-187, 191-196, 199-199, 203-204

---

206-212: LGTM! Well-designed helper method for multi-line ANSI styling.

The escapeMultiline method provides:

• Proper handling of multi-line strings by applying ANSI codes to each line individually
• Correct ANSI escape sequence format with configurable start and end codes
• Clean implementation that splits, processes, and rejoins lines appropriately

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feature/better-installer-text

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[codecov]

Codecov Report

Attention: Patch coverage is 82.22222% with 8 lines in your changes missing coverage. Please review.

Project coverage is 74.09%. Comparing base (daeba7f) to head (cc089b7).

Files with missing lines	Patch %	Lines
.vortex/installer/src/Command/InstallCommand.php	77.77%	6 Missing ⚠️
.vortex/installer/src/Utils/Tui.php	88.88%	2 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #1837      +/-   ##
===========================================
+ Coverage    74.00%   74.09%   +0.09%     
===========================================
  Files           84       84              
  Lines         4813     4830      +17     
  Branches        35       35              
===========================================
+ Hits          3562     3579      +17     
  Misses        1251     1251              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.