rustdoc-json: Report default field values information
Open
Nobody has claimed this yet.
A-rustdoc-json
A-stability
C-enhancement
F-default_field_values
T-rustdoc
- Dominant language
- Rust
- Stars
- 119k
- Forks
- 16.1k
- PR merge metrics
- PR metrics pending
Description
RFC 3681 (tracking issue) proposes supporting default values on fields.
As I mentioned at RustWeek, I'd love to move toward having SemVer lints available in cargo-semver-checks on day 1 of new language features hitting stable Rust. This feature is a perfect candidate to trial that:
- @estebank and I have already worked to identify the new SemVer hazards in this language feature
- the
cargo-semver-checksschema and lints we'd need are relatively straightforward - all we need is for rustdoc JSON to include the info we need.
cc @aDotInTheVoid
@rustbot label A-rustdoc-json
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading RFC 3681 and tracking issue #132162 to understand the default-field-values metadata that rustdoc JSON must expose. Then inspect the rustdoc JSON output and the cargo-semver-checks schema and lints; done means the required default-value information is available for those lints to consume.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- compilers, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100