coderabbitai[bot]
commented
2 months ago [!IMPORTANT]
Review skipped
Draft detected.
Please check the settings in the CodeRabbit UI or the
.coderabbit.yamlfile in this repository. To trigger a single review, invoke the@coderabbitai reviewcommand.You can disable this status message by setting the
reviews.review_statustofalsein the CodeRabbit configuration file.
Walkthrough
The updates across the yash project introduce crucial changes like replacing ReadEvalLoop with the read_eval_loop function, utilizing RefCell for mutable state management, and restructuring various modules to enhance code readability and organization. There's also an emphasis on modernizing the code by adopting new traits and deprecating outdated methods. These changes improve the flexibility and maintainability of the codebase, particularly affecting alias handling and input processing.
Changes
| Files and Changes |
|---|
yash-builtin/src/eval.rs, yash-semantics/src/trap.rs, yash-semantics/src/lib.rs, etc. |
- Replaced ReadEvalLoop with read_eval_loop, added RefCell, and updated related methods. |
yash-cli/CHANGELOG.md, yash-cli/src/lib.rs |
- Updated first argument of startup::prepare_input to use RefCell. Changed SourceInput::verbose handling. |
yash-env/CHANGELOG.md, yash-env/src/alias.rs, yash-env/src/input.rs, etc. |
- Added Glossary trait, input::Echo, deprecated FdReader::set_echo, moved FdReader implementation. |
yash-semantics/CHANGELOG.md, yash-semantics/src/runner.rs, yash-semantics/src/runner_legacy.rs, etc. |
- Added read_eval_loop replacing ReadEvalLoop, introduced runner_legacy. Deprecated ReadEvalLoop::set_verbose. |
yash-syntax/CHANGELOG.md, yash-syntax/src/alias.rs, yash-syntax/src/input.rs, etc. |
- Introduced Glossary trait, replaced AliasSet, deprecated old methods, and updated tests. |
Sequence Diagram(s)
sequenceDiagram
participant CLI
participant Env
participant Lexer
participant EvalLoop
CLI->>Env: RefCell<&mut Env>
CLI->>Lexer: &mut Lexer
CLI->>EvalLoop: Call read_eval_loop with RefCell<&mut Env>, &mut Lexer
EvalLoop->>Lexer: Execute
EvalLoop->>Env: Modify and update environment
EvalLoop-->>CLI: Return results🐇🌼
Beneath the code, new threads were spun, With
RefCells shining in the sun.Glossarywhispered aliases true, Echo carried your commands through. Out with the old, in with the new, Yash's heart beats bright and blue.
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
This is the preparatory part of #372.
ParserParser::aliases's typeFdReaderto a newInputdecorator.FdReader::set_echoread_eval_loopfunctionReadEvalLoopwith calls to theread_eval_loopfunctionReadEvalLoopSummary by CodeRabbit
New Features
input::Echo, a decorator for enhanced verbose shell behavior.Glossarytrait for alias management in the environment, with methods to look up and check if the alias list is empty.Refactor
ReadEvalLoopwithread_eval_loopfunction for improved async handling and code readability.FdReaderimplementation into its own module for better code organization.EmptyGlossaryinstead ofAliasSet, enhancing modularity and maintainability.Deprecations
ReadEvalLoop::set_verbosein favor of usinginput::Echo.Bug Fixes
yash-envmodule.Dependency Updates