rustdoc search: increase strictness of typechecking #137981

lolbinarycat · 2025-03-04T05:45:26Z

The signature of makePrimitiveElement is now more accurate.

I believe the intent of the code is that name cannot be null if bindingName.name is null, and I believe typescript is expressive enough to encode this, but I'm not quite sure how, or if this would be desirable.

I'm also introducing mapped types into rustdoc.d.ts, but I think it's worth it in order to avoid keeping two interfaces in sync.

I may add more commits onto this to remove more @ts-expect-error instances.

rustbot · 2025-03-04T05:45:32Z

Some changes occurred in HTML/CSS/JS.

cc @GuillaumeGomez, @jsha

we encode "if the argument is a non-empty string, this will never return null" into the type signature.

ideally we would encode that it is a string before convertTypeFilterOnElem is called, and a number after, but i'm not sure that's possible without significant refactoring.

lolbinarycat · 2025-03-04T21:02:22Z

bad news for all the bool-returning closures we have.

some of the fields of rustdoc.Row were confusing null and undefined.

notriddle · 2025-03-04T21:33:18Z

@bors r+ rollup

bors · 2025-03-04T21:33:20Z

📌 Commit 4f6772d has been approved by notriddle

It is now in the queue for this repository.

notriddle · 2025-03-04T21:34:06Z

For "bool-returning closures," do you mean the onEach and onEachLazy callbacks? Or something else?

lolbinarycat · 2025-03-04T21:57:26Z

@notriddle those, but also onEachBtwn.

also oops, I pushed more changes before I saw the approval, sorry.

lolbinarycat · 2025-03-04T21:58:44Z

if i un-push the changes, will the approval re-activate?

lolbinarycat · 2025-03-04T22:02:49Z

doesn't look like it (also wow github does not seem to like me rewinding and replaying the PR)

lolbinarycat · 2025-03-04T22:03:23Z

I'll leave this PR alone now, so you can properly review it.

lolbinarycat · 2025-03-04T23:05:39Z

@notriddle CI is green again, sorry for the hassle.

notriddle · 2025-03-04T23:10:56Z

@bors r+

bors · 2025-03-04T23:10:59Z

📌 Commit 8920167 has been approved by notriddle

It is now in the queue for this repository.

notriddle · 2025-03-04T23:11:52Z

src/librustdoc/html/static/js/search.js

@@ -1586,7 +1573,6 @@ class DocSearch {
        /**
         *  @type {Array<rustdoc.Row>}
         */
-        // @ts-expect-error


Thanks for helping clean all this stuff up.

Yeah, hopefully this should make things easier to maintain going forward.

I always planned on working on the migration if typescript got the ok, you just went and implemented half of it before I could do anything :p

I was a bit worried you were going to be put off by some of the conditional type wizardry, since it's doing things that the rust type system can't.

Rust doesn't have literal types, conditional types, or overloading.

But TypeScript can't do this, because type parameters are erased.

my_function(my_iterator.collect()) // ^^^^^^^ magically uses the correct `FromIterator`

I don't want to hammer that square peg into Rust's round hole. Writing in JS means giving up some power while accepting power elsewhere.

…kingjubilee Rollup of 15 pull requests Successful merges: - rust-lang#137829 (Stabilize [T]::split_off... methods) - rust-lang#137850 (Stabilize `box_uninit_write`) - rust-lang#137912 (Do not recover missing lifetime with random in-scope lifetime) - rust-lang#137913 (Allow struct field default values to reference struct's generics) - rust-lang#137923 (Simplify `<Postorder as Iterator>::size_hint`) - rust-lang#137949 (Update MSVC INSTALL.md instructions to recommend VS 2022 + recent Windows 10/11 SDK) - rust-lang#137963 (Add ``dyn`` keyword to `E0373` examples) - rust-lang#137975 (Remove unused `PpMode::needs_hir`) - rust-lang#137981 (rustdoc search: increase strictness of typechecking) - rust-lang#137986 (Fix some typos) - rust-lang#137991 (Add `avr-none` to SUMMARY.md and platform-support.md) - rust-lang#137993 (Remove obsolete comment from DeduceReadOnly) - rust-lang#137996 (Revert "compiler/rustc_data_structures/src/sync/worker_local.rs: delete "unsafe impl Sync"") - rust-lang#138019 (Pretty-print `#[deprecated]` attribute in HIR.) - rust-lang#138026 (Make CrateItem::body() function return an option) r? `@ghost` `@rustbot` modify labels: rollup

Rollup merge of rust-lang#137981 - lolbinarycat:rustdoc-js-less-expect-error, r=notriddle rustdoc search: increase strictness of typechecking r? `@notriddle` The signature of `makePrimitiveElement` is now more accurate. I believe the intent of the code is that `name` cannot be null if `bindingName.name` is null, and I believe typescript is expressive enough to encode this, but I'm not quite sure how, or if this would be desirable. I'm also introducing mapped types into `rustdoc.d.ts`, but I think it's worth it in order to avoid keeping two interfaces in sync. I may add more commits onto this to remove more ``@ts-expect-error`` instances.

rustdoc search: increase strictness of typechecking

a8c0b3b

rustbot assigned notriddle Mar 4, 2025

rustdoc search: give buildTypeMapIndex a conditional return type

2f9ea8a

we encode "if the argument is a non-empty string, this will never return null" into the type signature.

This comment has been minimized.

Sign in to view

ParserQueryElement.typeFilter MAY be a string, OR number.

60c5855

ideally we would encode that it is a string before convertTypeFilterOnElem is called, and a number after, but i'm not sure that's possible without significant refactoring.

This comment has been minimized.

Sign in to view

fix whitespace

7635f2b

This comment has been minimized.

Sign in to view

lolbinarycat added 6 commits March 4, 2025 13:37

don't use double quotes

32ebe8e

search.js: local variable extra is an array, annotate it as such.

d130e25

search.js: second argument of convertNameToId is optional

78b92f0

search.js: give pathSplitter a type signature

9581f19

give local mgens a type

4f6772d

search.js: give local where a type

c05f6bf

lolbinarycat added 2 commits March 4, 2025 15:19

search.js: give buildIndex a proper return type

374de12

some of the fields of rustdoc.Row were confusing null and undefined.

search.js: allow empty result arrays

5f39026

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 Mar 4, 2025

lolbinarycat added 2 commits March 4, 2025 15:53

search.js: give RawSearchIndexCrate.a an index signature

a9a52dd

search.js: remove incorrect outdated comment

8920167

lolbinarycat force-pushed the rustdoc-js-less-expect-error branch from 8920167 to 4f6772d Compare March 4, 2025 22:00

notriddle reviewed Mar 4, 2025

View reviewed changes

workingjubilee mentioned this pull request Mar 5, 2025

Rollup of 15 pull requests #138031

Merged

bors merged commit c32124f into rust-lang:master Mar 5, 2025
7 of 12 checks passed

rustbot added this to the 1.87.0 milestone Mar 5, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

rustdoc search: increase strictness of typechecking #137981

rustdoc search: increase strictness of typechecking #137981

lolbinarycat commented Mar 4, 2025 •

edited

Loading

rustbot commented Mar 4, 2025

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

lolbinarycat commented Mar 4, 2025

notriddle commented Mar 4, 2025

bors commented Mar 4, 2025

notriddle commented Mar 4, 2025

lolbinarycat commented Mar 4, 2025

lolbinarycat commented Mar 4, 2025

lolbinarycat commented Mar 4, 2025

lolbinarycat commented Mar 4, 2025

lolbinarycat commented Mar 4, 2025

notriddle commented Mar 4, 2025

bors commented Mar 4, 2025

notriddle Mar 4, 2025

lolbinarycat Mar 4, 2025

notriddle Mar 5, 2025

rustdoc search: increase strictness of typechecking #137981

rustdoc search: increase strictness of typechecking #137981

Conversation

lolbinarycat commented Mar 4, 2025 • edited Loading

rustbot commented Mar 4, 2025

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

lolbinarycat commented Mar 4, 2025

notriddle commented Mar 4, 2025

bors commented Mar 4, 2025

notriddle commented Mar 4, 2025

lolbinarycat commented Mar 4, 2025

lolbinarycat commented Mar 4, 2025

lolbinarycat commented Mar 4, 2025

lolbinarycat commented Mar 4, 2025

lolbinarycat commented Mar 4, 2025

notriddle commented Mar 4, 2025

bors commented Mar 4, 2025

notriddle Mar 4, 2025

Choose a reason for hiding this comment

lolbinarycat Mar 4, 2025

Choose a reason for hiding this comment

notriddle Mar 5, 2025

Choose a reason for hiding this comment

lolbinarycat commented Mar 4, 2025 •

edited

Loading