search

orium / cargo-rdme

Cargo command to create the README.md from your crate's documentation
Mozilla Public License 2.0
126 stars 5 forks source link

Get intralink information from rustdoc #177

Open orium opened 1 year ago

RReverser commented 7 months ago

Trying out the branch - looks pretty good so far, but one thing I'm finding missing is ability to pass custom Cargo args (maybe as cargo rdme -- ...[cargo options]...?) as some projects require --features to be passed in to compile at all.

orium commented 7 months ago

I'm glad you gave it a try. There's still some work to do (not to mention the code is really messy right now), but I should be able to work on it occasionally.

I was thinking of starting simply with --all-features. I might add a first class features option (both in the command line and config file) in the future that can override that default behavior.

Not sure about arbitrary cargo flags, at least for now. I can be convinced otherwise if there are compelling use cases.

RReverser commented 7 months ago

I was thinking of starting simply with --all-features.

I think that might be problematic, as a lot of repos tend to declare features like nightly or no_std or unstable etc, which are usually not desirable and might break more things than --all-features fixes.

Not sure about arbitrary cargo flags, at least for now. I can be convinced otherwise if there are compelling use cases.

Yeah I can't really think of other compelling cases for now, but it is a pattern that other cargo-based tools tend to follow, so figured might be easiest to support. Explicit --features sounds good though.

orium commented 7 months ago

I think that might be problematic, as a lot of repos tend to declare features like nightly or no_std or unstable etc, which are usually not desirable and might break more things than --all-features fixes.

That's true. I'll have an explicit features options and default to whatever default features the package has.