https://github.com/fmease/rruxwry
A wrapper around rust{,do}c for rust{,do}c devs
https://github.com/fmease/rruxwry
build-tools developer-tools rustc rustdoc
Last synced: 4 months ago
JSON representation
A wrapper around rust{,do}c for rust{,do}c devs
- Host: GitHub
- URL: https://github.com/fmease/rruxwry
- Owner: fmease
- License: mit
- Created: 2024-01-07T11:22:20.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2026-01-18T02:36:04.000Z (5 months ago)
- Last Synced: 2026-01-18T13:50:36.916Z (5 months ago)
- Topics: build-tools, developer-tools, rustc, rustdoc
- Language: Rust
- Homepage:
- Size: 593 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
——— rruxwry ———
A power tool for rustc & rustdoc devs that wraps rustc and rustdoc.
## Command-Line Interface
`rruxwry -h`:
```
A wrapper around rust{,do}c for rust{,do}c devs
Usage: rruxwry
Commands:
build Compile the given crate with rustc
doc Document the given crate with rustdoc
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
```
`rruxwry build -h`:
```
Compile the given crate with rustc
Usage: rruxwry build [OPTIONS] [PATH] [-- [VERBATIM]...]
Arguments:
[PATH] Path to the source file
[VERBATIM]... Flags passed to `rustc` verbatim
Options:
-:, --source Provide the source code
-r, --run Also run the built binary
-c, --check-only Don't fully compile, only check the crate
-@, --directives[=] Enable compiletest-like directives
-T, --compiletest Check in a compiletest-esque manner
-., --bless Update the test expectations
-n, --crate-name Set the name of the crate
-t, --crate-type Set the type of the crate
-e, --edition Set the edition of the crate
--cfg Enable a configuration
-R, --revision Enable a compiletest revision
-F, --feature Enable an experimental library or language feature
-s, --shallow Halt after parsing the source file
-d, --dump Print the given compiler IR
-x, --extern Register an external library
-/, --suppress-lints Cap lints at allow level
-#, --internals Enable internal pretty-printing of data types
-N, --next-solver Enable the next-gen trait solver
-I, --identity Force rust{,do}c's identity
-D, --no-dedupe Don't deduplicate diagnostics
--log[=] Enable rust{,do}c logging. FILTER defaults to `debug`
-B, --no-backtrace Override `RUST_BACKTRACE` to be `0`
-V, --version Print the underlying rust{,do}c version and halt
-v, --verbose Use verbose output
--color Control when to use color [default: auto] [possible values: auto, always, never]
-h, --help Print help
```
`rruxwry doc -h`:
```
Document the given crate with rustdoc
Usage: rruxwry doc [OPTIONS] [PATH] [-- [VERBATIM]...]
Arguments:
[PATH] Path to the source file
[VERBATIM]... Flags passed to `rustc` and `rustdoc` verbatim
Options:
-:, --source Provide the source code
-o, --open Also open the generated docs in a browser
-j, --json Output JSON instead of HTML
-@, --directives[=] Enable compiletest-like directives
-T, --compiletest Check in a compiletest-esque manner
-., --bless Update the test expectations
-X, --cross-crate Enable the cross-crate re-export mode
-n, --crate-name Set the name of the crate
-t, --crate-type Set the type of the crate
--crate-version Set the version of the (base) crate
-e, --edition Set the edition of the crate
--cfg Enable a configuration
-R, --revision Enable a compiletest revision
-F, --feature Enable an experimental library or language feature
-P, --private Document private items
-H, --hidden Document hidden items
--layout Document the memory layout of types
--link-to-def Generate links to definitions
--normalize Normalize types
--theme Set the theme [default: ayu]
-x, --extern Register an external library
-/, --suppress-lints Cap lints at allow level
-#, --internals Enable internal pretty-printing of data types
-N, --next-solver Enable the next-gen trait solver
-I, --identity Force rust{,do}c's identity
-D, --no-dedupe Don't deduplicate diagnostics
--log[=] Enable rust{,do}c logging. FILTER defaults to `debug`
-B, --no-backtrace Override `RUST_BACKTRACE` to be `0`
-V, --version Print the underlying rust{,do}c version and halt
-v, --verbose Use verbose output
--color Control when to use color [default: auto] [possible values: auto, always, never]
-h, --help Print help
```
Additionally, *rruxwry* recognizes the environment variables `RUSTFLAGS` and `RUSTDOCFLAGS`.
## Documentation
Presently, there is no further documentation. Good luck!
## Name: Pronunciation and Origin
IPA transcription: /ʔə.ˈɹʌks.ɹaɪ/.
Standard phonetic transcription: \[*uh*-**ruhks**-rahy\].
Origin: **r**ustc **r**ustdoc r**u**st{,do}c e**x**ecute **w**rite **r**ead -**y**.
## License
Except as otherwise noted, the contents of this repository are licensed under the MIT license (see the license file). Some files include or are accompanied by explicit license notices.
[x-crate-reexport-bugs]: https://github.com/rust-lang/rust/labels/A-cross-crate-reexports
[Cargo]: https://github.com/rust-lang/cargo/
[rust-repo]: https://github.com/rust-lang/rust
[`ui_test`]: https://github.com/oli-obk/ui_test
[`compiletest`]: https://github.com/rust-lang/rust/tree/master/src/tools/compiletest
[`htmldocck`]: https://github.com/rust-lang/rust/blob/master/src/etc/htmldocck.py
[`jsondocck`]: https://github.com/rust-lang/rust/tree/master/src/tools/jsondocck
[bugs]: https://github.com/fmease/rruxwry/issues
[HIR]: https://rustc-dev-guide.rust-lang.org/hir.html#the-hir
[lazy type aliases]: https://github.com/rust-lang/rust/issues/112792
[rustup]: https://github.com/rust-lang/rustup/