Skip to content

Add cargo-xwin to the CONTRIBUTING guide #17507

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.

Sign up for GitHub

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

Merged
zanieb merged 5 commits into from
Jan 16, 2026
Merged

Add cargo-xwin to the CONTRIBUTING guide #17507

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ce47e30
Add cargo-xwin clippy instructions to contributing guide
claude Jan 15, 2026
3699148
Simplify cargo-xwin section title and comment
claude Jan 15, 2026
92a7523
Note cargo-xwin works on macOS too
claude Jan 15, 2026
73cb86e
Match cargo xwin clippy flags with regular clippy command
claude Jan 15, 2026
c721b2d
Use 'a Windows target' instead of 'the'
claude Jan 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,22 @@ uvx typos
cargo shear
```

### Compiling for Windows from Unix

To run clippy for a Windows target from Linux or macOS, you can use
[cargo-xwin](https://github.com/rust-cross/cargo-xwin):

```shell
# Install cargo-xwin
cargo install cargo-xwin --version 0.18.0
Copy link
Copy Markdown
Member

@konstin konstin Jan 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we pin the version?

Copy link
Copy Markdown
Member Author

@zanieb zanieb Jan 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

❯ cargo install cargo-xwin
    Updating crates.io index
  Downloaded cargo-xwin v0.20.2
  Downloaded 1 crate (39.4KiB) in 0.16s
  Installing cargo-xwin v0.20.2
    Updating crates.io index
error: failed to compile `cargo-xwin v0.20.2`, intermediate artifacts can be found at `/var/folders/6p/k5sd5z7j31b31pq4lhn0l8d80000gn/T/cargo-installZU3vlq`.
To reuse those artifacts with a future compilation, set the environment variable `CARGO_TARGET_DIR` to that path.

Caused by:
  failed to select a version for the requirement `xwin = "^0.6.6"`
    version 0.6.6 is yanked
    version 0.6.7 is yanked
  location searched: crates.io index
  required by package `cargo-xwin v0.20.2`

Copy link
Copy Markdown
Member Author

@zanieb zanieb Jan 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not really sure what's going on there

Copy link
Copy Markdown
Member

@konstin konstin Jan 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's my fault: Jake-Shadle/xwin#168, rust-cross/cargo-xwin#181

Copy link
Copy Markdown
Member

@konstin konstin Jan 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cargo install cargo-xwin --locked also works


# Add the Windows target
rustup target add x86_64-pc-windows-msvc

# Run clippy for Windows
cargo xwin clippy --workspace --all-targets --all-features --locked -- -D warnings
```

## Crate structure

Rust does not allow circular dependencies between crates. To visualize the crate hierarchy, install
Expand Down
Loading