Skip to content
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

migrate from shellfish to rustyline with enhanced CLI features #6830

Open
wants to merge 13 commits into
base: master
Choose a base branch
from

Conversation

JoshuaBatty
Copy link
Member

@JoshuaBatty JoshuaBatty commented Jan 13, 2025

Description

This PR migrates the forc debug CLI from shellfish to rustyline, providing enhanced interactive debugging features. Key improvements include:

  • Command history with persistence
  • Intelligent command completion for debugger commands, register names, and transaction files
  • Command suggestions/corrections for typos
  • Contextual hints showing command descriptions

The migration also reorganizes the CLI code into separate modules for better maintainability while preserving all existing debugger functionality.

See video below for demo.

debug.cli.mp4

Checklist

  • I have linked to any relevant issues.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have updated the documentation where relevant (API docs, the reference, and the Sway book).
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added (or requested a maintainer to add) the necessary Breaking* or New Feature labels where relevant.
  • I have done my best to ensure that my PR adheres to the Fuel Labs Code Review Standards.
  • I have requested a review from the relevant team or maintainers.

@JoshuaBatty JoshuaBatty requested review from a team as code owners January 13, 2025 02:30
@JoshuaBatty JoshuaBatty self-assigned this Jan 13, 2025
@JoshuaBatty JoshuaBatty added the forc-debug Everything related to forc-debug label Jan 13, 2025
@JoshuaBatty JoshuaBatty marked this pull request as draft January 13, 2025 02:31
@JoshuaBatty JoshuaBatty marked this pull request as ready for review January 15, 2025 02:28
@JoshuaBatty JoshuaBatty requested a review from a team January 15, 2025 02:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
forc-debug Everything related to forc-debug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant