fmease / rrustdoc Goto Github PK

E.g., // compile-flags: --crate-name=name, // edition: 2015, // revisions: one two, // aux-crate:dep=dep.rs.

Figure out if we can use https://github.com/Manishearth/compiletest-rs here to obtain those directives. If that isn't feasible, lex source files with ra_ap_rustc_lexer, extract line comments and manually parse a subset of compiletest directives in a semi ad hoc fashion.

After that, add a flag / mode / means to run rrustdoc on test/ui/{rustdoc,rustdoc-ui,rustdoc-json}/ files directly (i.e., without any modifications to those files). Figure out how to deal with revisions (obviously we should automatically run rrustdoc for each revision but the specifics like UX aren't clear).

Lex the Rust source files with ra-ap-rustc_lexer and implement a quick & dirty parser that looks for #![crate_name = "…"] for increased robustness and correctness.

At the moment we just do a string-based search.

Actually using such crate names should however still be gated behind -a/--crate-name-attr.

This way you can pass -eS to mean -e2021 (at the time of writing) and -eU to mean -e2024 (at the time of writing).

If multiple input source files are passed, we should do something very similar to cargo doc, i.e., “running rustc N-1 times and rustdoc N times” given N input files.

Figure out what -x/--cross-crate means if multiple files are passed. Probably reject.

We should have more “dev-y” configuration options available like passing --cfg doc to dependency crates (which is what Cargo doesn't do at the moment, CC rust-lang/rust#114952) or not running rustc at all (I don't know if that's useful, maybe for debugging cross-crate stuff; basically N input files => N rustdoc executions (modulo compiletest revisions, lol)).

Since we can't provide custom CLI flags ad nauseam (per rustc and rustdoc flag), we should have a fallback method just like Cargo via environment variables.

--cfg KEY, --cfg KEY=VALUE; -f FEATURE (expands to --cfg 'feature="FEATURE"' (or something like that, I can't remember)).

I probably won't use it that much but it would enable you to generate docs in even fewer steps:

⟨editor⟩ | rrustdoc - -o

For extensibility, we should support invocations of the form:

rrustdoc file.rs -- -a -b -c

Where the arguments following the -- get passed verbatim to rustc and rustdoc. This is not a replacement for the env vars RUSTFLAGS and RUSTDOCFLAGS (#5) since the latter gives you more control.

It's less flexible than the env vars but it's more ergonomic for sure.