Migrated from inquirer to @inquirer/prompts library

[richardgaunt]

Checklist before requesting a review

• I have formatted the subject to include ticket number as \ Verb in past tense with dot at the end.
• I have performed a self-review of my code
• I have commented my code, particularly in hard-to-understand areas
• I have run new and existing relevant tests locally with my changes, and they passed

Changed

1. Replaced deprecated library with modern
2. Updated all interactive functions to use the new API
3. Improved user experience with confirmation prompts for deployments
4. Removed old autocomplete logic which is now handled by the new library
5. Maintained the same user interface and functionality throughout

This migration improves maintainability by removing dependencies on deprecated libraries and adopting modern practices.

Summary by CodeRabbit

• New Features

  • Updated interactive prompts throughout the CLI to use a modern prompt library, providing a more consistent and responsive user experience.

• Refactor

  • Replaced deprecated prompt methods with updated ones for all interactive flows, including branch and SSH key selection.
  • Improved formatting and readability in documentation comments.

• Chores

  • Updated dependencies to include the new prompt library.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes update interactive CLI components from the deprecated inquirer package to the modern @inquirer/prompts package. Prompt calls are refactored to match the new API, including label/value usage and async/await style. The autocomplete prompt is removed and replaced with a paginated select prompt. No changes are made to exported function signatures or core logic. Additional minor comment formatting adjustments are included.

Changes

File(s)	Change Summary
package.json	Added @inquirer/prompts as a dependency; removed inquirer and inquirer-autocomplete-prompt.
src/interactive.mjs	Replaced all inquirer prompt usages with @inquirer/prompts equivalents; removed autocomplete prompt; updated prompt objects and calls; added explicit confirmation after branch selection.
src/lagoon-ssh-key-configurator.mjs	Switched from inquirer.prompt to select from @inquirer/prompts; updated choice formatting and selection logic.
src/lagoon-api.mjs	Reformatted JSDoc comments for readability; minor regex tweak; no logic or API changes.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant @inquirer/prompts

    User->>CLI: Start interactive command
    CLI->>@inquirer/prompts: Prompt for selection/input/confirm
    @inquirer/prompts-->>CLI: Return user response
    CLI->>User: Proceed with next step or output result

Loading

Possibly related PRs

• [#1] Implemented branch deployment feature. #8: Introduced branch deployment with autocomplete prompt using inquirer-autocomplete-prompt; this PR refactors that flow by replacing deprecated packages and removing autocomplete.

Poem

A rabbit hopped through prompts anew,
Swapping old for modern view.
With labels clear and choices bright,
Async hops through CLI night.
Now every question, crisp and keen—
The friendliest prompts you've ever seen!
🐇✨

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b9da695 and 18d83f1.

⛔ Files ignored due to path filters (1)

• package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (3)

• package.json (1 hunks)
• src/interactive.mjs (20 hunks)
• src/lagoon-ssh-key-configurator.mjs (2 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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 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.