Replace `check_missing_items.py` with `jsondoclint` by aDotInTheVoid · Pull Request #101809 · rust-lang/rust

aDotInTheVoid · 2022-09-14T15:08:03Z

check_missing_items.py was a python script that checked rustdoc json output to make sure all the Id's referenced existed in the JSON index. This PR replaces that with a rust binary (jsondoclint) that does the same thing.

Motivation

Easier to change when rustdoc-json-types changes, as jsondoclint uses the types directly.

Better Errors:

Multiple Errors can be emited for a single crate

Errors can say where in JSON they occored

2:2889:408 not in index or paths, but refered to at '.index."2:2888:104".inner.items[0]'
2:2890:410 not in index or paths, but refered to at '.index."2:2888:104".inner.items[1]'

Catches more bugs.
- Because matches are exaustive, all posible variants considered for enums
- All Id's checked
- Has already found Rustdoc-Json: Don't loose subitems of foreign traits. #101770, Rustdoc-Json: async fn foo() -> T return type is given as impl Future<Output=T> not T #101199 and Rustdoc-Json: Reference to missing item with 2 glob imports #100973
- Id type is also checked, so the Id's in a structs fields can only be field items.
Allows the possibility of running from rustdoc::json, which we should do in a crator run at some point.

cc @CraftSpider

r? @GuillaumeGomez

CraftSpider

This looks amazing to me! Much more maintainable than the old check_missing

GuillaumeGomez · 2022-09-15T11:15:40Z

This is a great improvement, thanks!

@bors r+

bors · 2022-09-15T11:15:42Z

📌 Commit f69a6c2 has been approved by GuillaumeGomez

It is now in the queue for this repository.

…aumeGomez Replace `check_missing_items.py` with `jsondoclint` [zulip discussion](https://rust-lang.zulipchat.com/#narrow/stream/266220-rustdoc/topic/check_missing_items.2Epy.20Replacement.2E) check_missing_items.py was a python script that checked rustdoc json output to make sure all the Id's referenced existed in the JSON index. This PR replaces that with a rust binary (`jsondoclint`) that does the same thing. ### Motivation 1. Easier to change when `rustdoc-json-types` changes, as `jsondoclint` uses the types directly. 2. Better Errors: - Multiple Errors can be emited for a single crate - Errors can say where in JSON they occored ``` 2:2889:408 not in index or paths, but refered to at '.index."2:2888:104".inner.items[0]' 2:2890:410 not in index or paths, but refered to at '.index."2:2888:104".inner.items[1]' ``` 3. Catches more bugs. - Because matches are exaustive, all posible variants considered for enums - All Id's checked - Has already found rust-lang#101770, rust-lang#101199 and rust-lang#100973 - Id type is also checked, so the Id's in a structs fields can only be field items. 4. Allows the possibility of running from `rustdoc::json`, which we should do in a crator run at some point. cc `@CraftSpider` r? `@GuillaumeGomez`

Dylan-DPC · 2022-09-15T12:31:37Z

failed in rollup
@bors r-

(or likely shouldnt be rolledup)

aDotInTheVoid · 2022-09-15T12:54:37Z

@Dylan-DPC The rollup failure is due to #101783, not this. That PR touched src/bootstrap/configure.py, and added an f-string, that isn't supported in whatever version of python CI uses

Dylan-DPC · 2022-09-15T13:12:25Z

@bors r=GuillaumeGomez

bors · 2022-09-15T13:12:28Z

📌 Commit f69a6c2 has been approved by GuillaumeGomez

It is now in the queue for this repository.

…aumeGomez Replace `check_missing_items.py` with `jsondoclint` [zulip discussion](https://rust-lang.zulipchat.com/#narrow/stream/266220-rustdoc/topic/check_missing_items.2Epy.20Replacement.2E) check_missing_items.py was a python script that checked rustdoc json output to make sure all the Id's referenced existed in the JSON index. This PR replaces that with a rust binary (`jsondoclint`) that does the same thing. ### Motivation 1. Easier to change when `rustdoc-json-types` changes, as `jsondoclint` uses the types directly. 2. Better Errors: - Multiple Errors can be emited for a single crate - Errors can say where in JSON they occored ``` 2:2889:408 not in index or paths, but refered to at '.index."2:2888:104".inner.items[0]' 2:2890:410 not in index or paths, but refered to at '.index."2:2888:104".inner.items[1]' ``` 3. Catches more bugs. - Because matches are exaustive, all posible variants considered for enums - All Id's checked - Has already found rust-lang#101770, rust-lang#101199 and rust-lang#100973 - Id type is also checked, so the Id's in a structs fields can only be field items. 4. Allows the possibility of running from `rustdoc::json`, which we should do in a crator run at some point. cc `@CraftSpider` r? `@GuillaumeGomez`

Rollup of 7 pull requests Successful merges: - rust-lang#101722 (Rustdoc-Json: Fix Type docs.) - rust-lang#101738 (Fix `#[link kind="raw-dylib"]` to respect `#[link_name]`) - rust-lang#101753 (Prefer explict closure sig types over expected ones) - rust-lang#101787 (cache `collect_trait_impl_trait_tys`) - rust-lang#101802 (Constify impl Fn* &(mut) Fn*) - rust-lang#101809 (Replace `check_missing_items.py` with `jsondoclint`) - rust-lang#101864 (rustdoc: remove no-op CSS `h1-4 { color: --main-color }`) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup

jsondoclint: New Tool

2506aa0

rustbot added T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) A-rustdoc-json Area: Rustdoc JSON backend T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Sep 14, 2022

rust-highfive assigned GuillaumeGomez Sep 14, 2022

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Sep 14, 2022

This comment has been minimized.

Sign in to view

aDotInTheVoid added 10 commits September 14, 2022 16:14

jsondoclint: Tree Walk Validator

a7a4fe9

jsondoclint: Add Kind abstraction

bb1911d

jsondocck: Better errors

5f1bc6f

jsondocck: Find path to Id's not in index

41d35a9

Primitives can appear in modules.

c98c7cb

jsondoclint: Document validator

5956b56

Remove check_missing_items.py

393792d

Rustdoc-Json: Add test for extern_types

24c751b

jsondoclint: More precise Path checks

6e21a28

jsondoclint: Fix TODO's

f69a6c2

aDotInTheVoid force-pushed the jsondoclint branch from dfed0ad to f69a6c2 Compare September 14, 2022 15:14

CraftSpider approved these changes Sep 14, 2022

View reviewed changes

GuillaumeGomez approved these changes Sep 15, 2022

View reviewed changes

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Sep 15, 2022

Dylan-DPC mentioned this pull request Sep 15, 2022

Rollup of 6 pull requests #101850

Closed

bors added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Sep 15, 2022

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Sep 15, 2022

Dylan-DPC mentioned this pull request Sep 15, 2022

Rollup of 6 pull requests #101854

Closed

Dylan-DPC mentioned this pull request Sep 16, 2022

Rollup of 7 pull requests #101882

Merged

bors merged commit 458555d into rust-lang:master Sep 16, 2022

rustbot added this to the 1.65.0 milestone Sep 16, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Replace `check_missing_items.py` with `jsondoclint`#101809

Replace `check_missing_items.py` with `jsondoclint`#101809
bors merged 11 commits intorust-lang:masterfrom
aDotInTheVoid:jsondoclint

aDotInTheVoid commented Sep 14, 2022

Uh oh!

This comment has been minimized.

CraftSpider left a comment

Uh oh!

GuillaumeGomez commented Sep 15, 2022

Uh oh!

bors commented Sep 15, 2022

Uh oh!

Dylan-DPC commented Sep 15, 2022 •

edited

Loading

Uh oh!

aDotInTheVoid commented Sep 15, 2022 •

edited

Loading

Uh oh!

Dylan-DPC commented Sep 15, 2022

Uh oh!

bors commented Sep 15, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

Uh oh!

Conversation

aDotInTheVoid commented Sep 14, 2022

Motivation

Uh oh!

This comment has been minimized.

CraftSpider left a comment

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez commented Sep 15, 2022

Uh oh!

bors commented Sep 15, 2022

Uh oh!

Dylan-DPC commented Sep 15, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aDotInTheVoid commented Sep 15, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Dylan-DPC commented Sep 15, 2022

Uh oh!

bors commented Sep 15, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

Dylan-DPC commented Sep 15, 2022 •

edited

Loading

aDotInTheVoid commented Sep 15, 2022 •

edited

Loading