search

magicant / yash-rs

Reimplementation of yash, an extended POSIX shell
65 stars 3 forks source link

Basic command prompt #376

Closed magicant closed 3 months ago

magicant commented 4 months ago

This is part of #372. This PR only supports $PS1.

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

Walkthrough

The changes introduce a new crate, yash-prompt, for prompt strings following POSIX expansion standards. It adds build and test commands, updates several dependencies, implements new functionality for prompt handling, and integrates yash-prompt with yash-cli. The alterations include function signature updates, new modules, and modified imports to support prompt decoration in the interactive shell environment.

Changes

Files / Folders Summary of Changes
check-extra.sh Added build and test commands for yash-prompt.
check-msrv.sh Updated workspace members for testing yash-prompt.
yash-prompt/CHANGELOG.md Introduced initial changelog documentation for yash-prompt.
yash-prompt/Cargo.toml Defined package dependencies and configurations.
yash-prompt/LICENSE-GPL Added GPL v3 license document.
yash-prompt/README.md Introduced crate features, badges, and license info.
yash-prompt/src/expand_posix.rs Implemented POSIX prompt expansion with new function signature.
yash-prompt/src/lib.rs Added library entry point, exporting expand_posix and Prompter.
yash-prompt/src/prompter.rs Implemented Prompter decorator for displaying shell prompts.
yash-cli/Cargo.toml Added yash-prompt as a dependency.
yash-cli/src/startup.rs Conditional prompt decoration applied in prepare_input function.

Sequence Diagram

sequenceDiagram
    participant User
    participant CLI
    participant Prompter
    participant Env
    participant PosixExpander

    User->>CLI: Start interactive shell
    CLI->>Prompter: Apply prompt decorator
    Prompter->>Env: Retrieve prompt template ($PS1)
    Prompter->>PosixExpander: Expand POSIX prompt
    PosixExpander->>Prompter: Return expanded prompt
    Prompter->>CLI: Display prompt
    User->>CLI: Enter command
    CLI->>Prompter: Remove prompt decorator
    CLI->>Env: Execute command
    Env-->>CLI: Command result
    CLI-->>User: Output result

Possibly related issues

Poem

In the realm of shells so bright,
A prompt awakens, shining light,
With POSIX rules, it doth expand,
To greet each command at your hand.
In code it whispers, "Here I stand,"
Ready to serve in interactive land.
The future smiles at this prompt's command.

🐇💻✨

[!TIP]

AI model upgrade ## `gpt-4o` model for reviews and chat is now live OpenAI claims that this model is better at understanding and generating code than the previous models. Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide any feedback or to report any issues.

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?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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.` 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 as 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 resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.