Add lint to deny diagnostics composed of static strings #108760

clubby789 · 2023-03-05T04:11:02Z

r? ghost

I'm hoping to have a lint that semi-automatically converts simple diagnostics such as struct_span_err(span, "msg").help("msg").span_note(span2, "msg").emit() to typed session diagnostics. It's quite hacky and not entirely working because of problems with x fix but should hopefully help reduce some of the work.
I'm going to start trying to apply what I can from this, but opening this as a draft in case anyone wants to develop on it.

cc #100717

compiler-errors · 2023-03-05T18:37:32Z

Cool! I like this a lot. Do you plan on landing this as a lint enabled against the compiler, or are you just using it locally? Couldn't tell what your next steps were in "but opening this as a draft in case anyone wants to develop on it.".

clubby789 · 2023-03-05T18:42:07Z

I don't think tihs is something that should end up landing since it's reasonably hacky and also hopefully should be a one-time run to apply all the fixes it can.
Sorry if my comment was a bit vague - my thoughts were that this only transforms the most basic cases, but I wanted to have it available in case other people wanted to enhance it to catch more cases (like

let mut err = struct_span_err(..);
err.help(..);
err.note(..);
err.emit();

compiler-errors · 2023-03-05T18:54:30Z

I guess so -- it would be nice if we could enforce some lint to make sure people don't add new usages of struct_span_err with static strings, even if it doesn't do the fixing or even provides as helpful of a suggestion as this one.

clubby789 · 2023-03-05T19:02:00Z

Maybe this could be landed )with improved messages) but with all the code that does fixing and file modification cfg'd out? Then the detection part of the lint stays working and the rest is readily available if the lint is enhanced

compiler-errors · 2023-03-05T23:36:30Z

but with all the code that does fixing and file modification cfg'd out?

Happy to review a version of this lint with all of that logic removed, but would also be open to considering it cfg'd out if it's pretty easily separable from the other logic. Not a huge fan of cfg'ing it out, just because it's like committing commented out code :) but definitely could change my mind.

bors · 2023-03-12T07:35:25Z

☔ The latest upstream changes (presumably #108682) made this pull request unmergeable. Please resolve the merge conflicts.

compiler-errors · 2023-03-17T05:38:33Z

@rustbot author

compiler-errors · 2023-04-10T06:45:28Z

@clubby789 any thoughts on this?

clubby789 · 2023-04-10T15:03:56Z

Some failures will be fixed by #110092 so I'll finish fixing up the other failures once that is merged

@rustbot label +S-blocked

compiler-errors · 2023-04-13T19:25:25Z

Seems to be unblocked because of #11092 landing

@rustbot author

clubby789 · 2023-04-16T14:42:46Z

@rustbot ready
@rustbot label -S-blocked -S-experimental

clubby789 · 2023-04-17T18:08:01Z

In a future PR I'll probably relax the static string check, since any diagnostic created in a chain of diagnostic functions in a single statement should be easily translatable to derive diagnostics, without requiring subdiagnostics or much refactoring of the logic.

bors · 2023-04-22T03:08:05Z

☔ The latest upstream changes (presumably #106934) made this pull request unmergeable. Please resolve the merge conflicts.

clubby789 · 2023-04-25T15:13:56Z

(oops, I left this as ghost)
r? compiler

bors · 2023-04-25T16:42:45Z

☔ The latest upstream changes (presumably #110325) made this pull request unmergeable. Please resolve the merge conflicts.

wesleywiser · 2023-04-26T15:40:39Z

Thanks @clubby789! Using a lint to find these was a really good idea 👍

@bors r+ rollup

bors · 2023-04-26T15:40:41Z

📌 Commit 0138513 has been approved by wesleywiser

It is now in the queue for this repository.

…iaskrgr Rollup of 10 pull requests Successful merges: - rust-lang#108760 (Add lint to deny diagnostics composed of static strings) - rust-lang#109444 (Change tidy error message for TODOs) - rust-lang#110419 (Spelling library) - rust-lang#110550 (Suggest deref on comparison binop RHS even if type is not Copy) - rust-lang#110641 (Add new rustdoc book chapter to describe in-doc settings) - rust-lang#110798 (pass `unused_extern_crates` in `librustdoc::doctest::make_test`) - rust-lang#110819 (simplify TrustedLen impls) - rust-lang#110825 (diagnostics: add test case for already-solved issue) - rust-lang#110835 (Make some region folders a little stricter.) - rust-lang#110847 (rustdoc-json: Time serialization.) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup

…ial, r=compiler-errors Migrate trivially translatable `rustc_parse` diagnostics cc rust-lang#100717 Migrate diagnostics in `rustc_parse` which are emitted in a single statement. I worked on this by expanding the lint introduced in rust-lang#108760, although that isn't included here as there is much more work to be done to satisfy it

This comment has been minimized.

Sign in to view

rustbot 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-review Status: Awaiting review from the assignee but also interested parties. labels Mar 17, 2023

clubby789 force-pushed the autolintstuff branch from ea582c4 to bf0a59b Compare April 10, 2023 15:00

clubby789 changed the title ~~experiment: Add lint to automatically generate typed diagnostics for simple cases~~ Add lint to deny diagnostics composed of static strings Apr 10, 2023

rustbot added the S-blocked Status: Blocked on something else such as an RFC or other implementation work. label Apr 10, 2023

This comment has been minimized.

Sign in to view

clubby789 force-pushed the autolintstuff branch from bf0a59b to 09521df Compare April 16, 2023 14:41

clubby789 marked this pull request as ready for review April 16, 2023 14:42

This comment has been minimized.

Sign in to view

clubby789 force-pushed the autolintstuff branch from 09521df to 16d2954 Compare April 16, 2023 15:25

clubby789 force-pushed the autolintstuff branch from 47f4188 to 93bedb9 Compare April 17, 2023 10:57

This comment has been minimized.

Sign in to view

clubby789 force-pushed the autolintstuff branch from 93bedb9 to 86138c2 Compare April 17, 2023 12:23

jyn514 added the D-diagnostic-infra Diagnostics: Issues that affect all diagnostics, or relate to the diagnostic machinery itself. label Apr 17, 2023

clubby789 force-pushed the autolintstuff branch from 86138c2 to 81f09e8 Compare April 22, 2023 03:12

rustbot removed the S-experimental Status: Ongoing experiment that does not require reviewing and won't be merged in its current state. label Apr 22, 2023

clubby789 force-pushed the autolintstuff branch from 81f09e8 to 8f8ec29 Compare April 25, 2023 14:47

rustbot assigned wesleywiser Apr 25, 2023

clubby789 mentioned this pull request Apr 25, 2023

Diagnostic Translation #100717

Open

84 tasks

clubby789 added 2 commits April 25, 2023 18:44

Add deny lint to prevent untranslatable diagnostics using static strings

eeb5276

Fix static string lints

0138513

clubby789 force-pushed the autolintstuff branch from 8f8ec29 to 0138513 Compare April 25, 2023 18:00

wesleywiser approved these changes Apr 26, 2023

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 Apr 26, 2023

matthiaskrgr mentioned this pull request Apr 26, 2023

Rollup of 10 pull requests #110852

Merged

bors merged commit 309496c into rust-lang:master Apr 26, 2023

rustbot added this to the 1.71.0 milestone Apr 26, 2023

clubby789 mentioned this pull request Apr 27, 2023

Migrate trivially translatable rustc_parse diagnostics #110873

Merged

matthiaskrgr mentioned this pull request May 6, 2023

ICE: 'index out of bounds: the len is 1 but the index is 1', compiler/rustc_lint/src/internal.rs:481:82 #111280

Closed

Add lint to deny diagnostics composed of static strings #108760

Add lint to deny diagnostics composed of static strings #108760

Uh oh!

Conversation

clubby789 commented Mar 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

compiler-errors commented Mar 5, 2023

Uh oh!

This comment has been minimized.

clubby789 commented Mar 5, 2023

Uh oh!

compiler-errors commented Mar 5, 2023

Uh oh!

clubby789 commented Mar 5, 2023

Uh oh!

compiler-errors commented Mar 5, 2023

Uh oh!

bors commented Mar 12, 2023

Uh oh!

compiler-errors commented Mar 17, 2023

Uh oh!

compiler-errors commented Apr 10, 2023

Uh oh!

clubby789 commented Apr 10, 2023

Uh oh!

This comment has been minimized.

compiler-errors commented Apr 13, 2023

Uh oh!

clubby789 commented Apr 16, 2023

Uh oh!

This comment has been minimized.

This comment has been minimized.

clubby789 commented Apr 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bors commented Apr 22, 2023

Uh oh!

clubby789 commented Apr 25, 2023

Uh oh!

bors commented Apr 25, 2023

Uh oh!

wesleywiser commented Apr 26, 2023

Uh oh!

bors commented Apr 26, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

clubby789 commented Mar 5, 2023 •

edited

Loading

clubby789 commented Apr 17, 2023 •

edited

Loading