——— rruxwry ———

A power tool for rustc & rustdoc devs that wraps rustc and rustdoc.

Important

This project is undergoing major reworks and is not yet suitable for general use.

Command-Line Interface

rruxwry -h:

A wrapper around rust{,do}c for rust{,do}c devs

Usage: rruxwry <COMMAND>

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:
  -r, --run                   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 <NAME>     Set the name of the crate
  -t, --crate-type <TYPE>     Set the type of the crate
  -e, --edition <EDITION>     Set the edition of the crate
      --cfg <NAME>            Enable a `cfg`
  -R, --revision <NAME>       Enable a compiletest revision
  -f, --cargo-feature <NAME>  Enable a Cargo-like feature
  -F, --rustc-feature <NAME>  Enable an experimental rustc library or language feature
  -/, --suppress-lints        Cap lints at allow level
  -#, --internals             Enable rust{,do}c's `-Zverbose-internals`
  -N, --next-solver           Enable the next-gen trait solver
  -I, --identity <IDENTITY>   Force rust{,do}c's identity
      --log[=<FILTER>]        Enable rust{,do}c logging. FILTER defaults to `debug`
  -B, --no-backtrace          Override `RUST_BACKTRACE` to be `0`
  -V, --verbose               Use verbose output
  -0, --dry-run               Run through without making any changes
      --color <WHEN>          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:
  -o, --open                     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 <NAME>        Set the name of the crate
  -t, --crate-type <TYPE>        Set the type of the crate
  -v, --crate-version <VERSION>  Set the version of the (base) crate
  -e, --edition <EDITION>        Set the edition of the crate
      --cfg <NAME>               Enable a `cfg`
  -R, --revision <NAME>          Enable a compiletest revision
  -f, --cargo-feature <NAME>     Enable a Cargo-like feature
  -F, --rustc-feature <NAME>     Enable an experimental rustc 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 <THEME>            Set the theme [default: ayu]
  -/, --suppress-lints           Cap lints at allow level
  -#, --internals                Enable rust{,do}c's `-Zverbose-internals`
  -N, --next-solver              Enable the next-gen trait solver
  -I, --identity <IDENTITY>      Force rust{,do}c's identity
      --log[=<FILTER>]           Enable rust{,do}c logging. FILTER defaults to `debug`
  -B, --no-backtrace             Override `RUST_BACKTRACE` to be `0`
  -V, --verbose                  Use verbose output
  -0, --dry-run                  Run through without making any changes
      --color <WHEN>             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.

Name: Pronunciation and Origin

IPA transcription: /ʔə.ˈɹʌks.ɹaɪ/. Standard phonetic transcription: [uh-ruhks-rahy].

Origin: rustc rustdoc rust{,do}c execute write read -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.