search

magicant / yash-rs

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

Show $PS2 prompt for continuation lines in the read built-in #380

Closed magicant closed 2 months ago

magicant commented 2 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

This update introduces enhancements across various modules for the Yash shell. Key changes include adding dependency checks for complex builds, updating built-in functionalities, refining environment detection for interactivity, and improving prompt handling. These modifications aim to align the project with POSIX 2018 requirements, optimize the code, and enhance user interaction.

Changes

Files/Paths Change Summaries
check-extra.sh Added extra cargo check and cargo build commands focusing on yash-builtin and yash-syntax dependency checks and builds with different features.
yash-builtin/CHANGELOG.md Updated for read built-in prompt, break, and continue semantics.
yash-builtin/Cargo.toml Added yash-prompt to default features, made it an optional dependency.
.../src/read.rs Documented prompt requirement for yash-prompt feature.
.../src/read/input.rs Updated read function for interactive prompts, added print_prompt.
yash-cli/CHANGELOG.md Documented read built-in prompt addition in CLI.
yash-env/CHANGELOG.md Added Env::is_interactive method.
yash-env/src/lib.rs Introduced Interactive option and is_interactive method in Env.
yash-prompt/src/lib.rs Added fetch_posix function in prompter module.
.../src/prompter.rs Refactored print_prompt, added fetch_posix, reorganized logic for prompt fetching and expansion.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant YashCLI
    participant YashBuiltin
    participant YashEnv
    participant YashPrompt

    User->>YashCLI: Enter command with read built-in
    YashCLI->>YashEnv: Check if interactive (is_interactive)
    YashEnv-->>YashCLI: Return interactivity status
    YashCLI->>YashBuiltin: Call read function
    YashBuiltin->>YashPrompt: Fetch and print prompt for continuation (fetch_posix)
    YashPrompt-->>YashBuiltin: Return prompt string
    YashBuiltin-->>User: Display prompt and read input

Possibly related issues

Poem

In the land of code so fine, Yash's features now align. Prompts that glow, interactivity flows, Enhanced with care, for users to share. A build so strong, to last for long, With each command, the shell's true song.

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.