search

magicant / yash-rs

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

Make more crates build on non-Unix targets #400

Closed magicant closed 2 months ago

magicant commented 2 months ago

This pull request makes it possible to build most crates on non-Unix platforms. The RealSystem is excluded from the build on non-Unix platforms, so the other parts of the code will build successfully.

This change improves the portability of the codebase and also helps ensure that the underlying system is only accessed through the RealSystem interface.

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The recent changes enhance the testing strategy of the Rust project by implementing broader test coverage, ensuring all features across various packages are validated. Additionally, the project now supports non-Unix platforms, improving compatibility. The API has been refined to reduce dependency on the nix crate, simplifying the interface and enhancing control over semantic versioning.

Changes

File(s) Change Summary
.github/workflows/rust.yml Added --all-features flag to cargo test commands for multiple packages to enhance testing coverage.
yash-builtin/CHANGELOG.md Added support for non-Unix platforms, improving compatibility; modified API handling of std::path::Path and std::path::PathBuf.
yash-builtin/src/command.rs Updated comments and conditionally included imports based on configurations; removed direct RealSystem import.
yash-env/CHANGELOG.md Noted support for non-Unix platforms; added new From trait implementations for improved interoperability.
yash-env/Cargo.toml Moved nix dependency to a Unix-specific section, allowing for targeted dependency management.
yash-env/src/job.rs Removed From trait implementations for Pid, altering how it interacts with nix.
yash-env/src/lib.rs Added conditional compilation directive for exporting RealSystem, making its visibility dependent on the target OS.
yash-env/src/system.rs Modified module visibility and import directives based on platform conditions, refining public access.
yash-env/src/system/errno.rs Introduced new From trait implementations for converting between Errno and nix::Error.
yash-env/src/system/real.rs Enhanced process ID handling using direct libc calls, adding new methods for conversion between Pid and nix::unistd::Pid.
yash-semantics/CHANGELOG.md Updated documentation to reflect non-Unix platform support and improved error handling in the expansion module.

Possibly related issues

Poem

🐇 In the garden where code does hop,
Changes bloom, and features pop!
With tests that cover all the ground,
Non-Unix friends now gather 'round.
Simplified APIs, oh what a treat,
Hopping forward, we can’t be beat! 🌼

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 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](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.