Macro use sugg #5279

DevinR528 · 2020-03-06T12:54:02Z

changelog: Add auto applicable suggstion to macro_use_imports

Where exactly is the wildcard_imports_helper I haven't been able to import anything ex.
use lazy_static; or something like for that I get version/compiler conflicts?
Found it.

Should we also check for #[macro_use] extern crate, although this is still depended on for stuff like rustc_private?

DevinR528 · 2020-03-07T02:23:59Z

clippy_lints/src/macro_use.rs

+                for kid in lcx.tcx.item_children(id).iter() {
+                    if let Res::Def(DefKind::Macro(_mac_type), mac_id) = kid.res {
+                        let span = mac_attr.span.clone();
+                        println!("{:#?}", lcx.tcx.def_path_str(mac_id));
+                        self.imports.push((lcx.tcx.def_path_str(mac_id), span));
+                    }
+                }


This seems to work exactly how we need it to, so far it ignores all the modules the macro they are defined in but not found in. I need to figure out how to import from another crate into my test crate so I can have the macro stick in a module.

Note: since the prelude import is shadowed by the (builtin?) macro prelude import it doesn't catch that any more.

For macros from another crate you can use the mini-macro subcrate in the Clippy repo: https://github.com/rust-lang/rust-clippy/tree/master/mini-macro

This is also used in some other tests and includes a few proc-macros.

flip1995 · 2020-03-09T17:08:36Z

Since I'm not really sure, how far you're along with implementing this, can you give me a short summary, what you already implemented, what you think needs to be added, and which questions you still might have, before you can continue?

DevinR528 · 2020-03-09T18:17:42Z

It catches anything from any level of an imported crate directly imported

// crate importing from "macros"
extern crate macro_rules;

#[macro_export]
macro_rules! pub_macro {
    () => {
        ()
    };
}
pub mod inner {
    // RE-EXPORT
    // this will stick in `inner` module
    pub use macro_rules::try_err;

    #[macro_export]
    macro_rules! inner_mod {
        () => {
            #[allow(dead_code)]
            pub struct Tardis;
        };
    }
}

// using in this crate 
#[macro_use]
use mac;

fn main() {
    pub_macro!();
    inner_mod!();
    // without the inner:: it fails to compile?
    inner::try_err!();
}

it correctly ignores modules only using the root/crate name, it also aliases correctly so it will use the renamed name. The re-export works (it will produce a suggestion of macro::inner::try_err) but only if I call it like inner::try_err!(), otherwise it fails to compile can't resolve macro try_err. This seems more like me setting up something wrong in the auxiliary crate folder though?

By iterating over the children of an imported Mod we miss std::prelude so the original test of println fails. I'd imagine not many people are #[macro_use] std::prelude so maybe that's ok?

I can update the .stderr file that may make it easier to see what I've done?

bors · 2020-03-10T22:38:08Z

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

DevinR528 · 2020-03-18T02:46:25Z

Since we know if we encountered a macro that wasn't found in the imports search, and therefor is one of the weird import kinds (std::prelude). Could we defer all the span_lint_and_suggest calls until this point pushing them into a Vec then once we know there are no weird macro imports we emit all the suggestions as machine fixable.

how they are gathered

if lcx.sess().opts.edition == Edition::Edition2018;
if let hir::ItemKind::Use(path, _kind) = &item.kind;
if let Some(mac_attr) = item
    .attrs
    .iter()
    .find(|attr| attr.ident().map(|s| s.to_string()) == Some("macro_use".to_string()));
if let Res::Def(DefKind::Mod, id) = path.res;
then {
    for kid in lcx.tcx.item_children(id).iter() {
        if let Res::Def(DefKind::Macro(_mac_type), mac_id) = kid.res {
            let span = mac_attr.span.clone();
            self.imports.push((lcx.tcx.def_path_str(mac_id), span));
        }
    }
}

where this would happen

fn check_crate_post(&mut self, lcx: &LateContext<'_, '_>, _krate: &hir::Crate<'_>) {
    for (import, span) in self.imports.iter() {
        let matched = self
            .mac_refs
            .iter()
            .find(|(_span, mac)| import.ends_with(&mac.name))
            .is_some();

        if matched {
            self.mac_refs.retain(|(_span, mac)| !import.ends_with(&mac.name));
            let msg = "`macro_use` attributes are no longer needed in the Rust 2018 edition";
            let help = format!("use {}", import);
            span_lint_and_sugg(
                lcx,
                MACRO_USE_IMPORTS,
                *span,
                msg,
                "remove the attribute and import the macro directly, try",
                help,
                Applicability::HasPlaceholders,
            )
        }
    }
    if !self.mac_refs.is_empty() {
        // TODO if not empty we found one we could not make a suggestion for
        // such as std::prelude::v1 or something else I haven't thought of.
        // If we defer the calling of span_lint_and_sugg we can make a decision about its
        // applicability?
    }
}

bors · 2020-03-23T20:55:52Z

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

bors · 2020-03-30T20:12:25Z

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

flip1995 · 2020-04-15T17:56:31Z

@DevinR528 Sorry for taking so long for the review. I don't have an excuse, just wasn't really motivated to review PRs recently. I didn't forget this PR and want to review it in the coming days.

bors · 2020-04-15T18:56:26Z

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

bors · 2020-04-17T16:20:59Z

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

bors · 2020-04-19T19:39:36Z

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

bors · 2020-04-20T20:43:31Z

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

bors · 2020-04-27T06:17:20Z

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

bors · 2020-05-02T14:55:31Z

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

DevinR528 · 2020-05-04T12:27:38Z

Is this compile failure something I can fix?

error[E0624]: associated function `seek_after` is private
   --> clippy_lints/src/redundant_clone.rs:594:25
    |
594 |         self.maybe_live.seek_after(at);
    |                         ^^^^^^^^^^ private associated function

flip1995 · 2020-05-04T20:21:59Z

#5566 We're currently figuring out some stuff with the move to subtree in the Rust repo, so a rustup may take a day or two more this time. A fix is ready, though.

flip1995 · 2020-06-08T14:16:20Z

stderr differs? That is weird 🤔

bors · 2020-06-08T14:17:33Z

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

DevinR528 · 2020-06-08T19:52:12Z

It's the ordering of the suggestions, hmmm I'll look into this...

cargo dev update lints use if_chain clean up alot, span_lint_and_sugg find imported macros for sugg

how to compare macro to import path add more imports to test

remove stdout, fix clippy warnings, fmtcar

…dcard impotrs

…ort segments duh

flip1995 · 2020-06-09T15:16:06Z

@bors r+

Thanks!

bors · 2020-06-09T15:16:07Z

📌 Commit 3f91e39 has been approved by flip1995

bors · 2020-06-09T15:16:18Z

⌛ Testing commit 3f91e39 with merge 0537c9d...

Macro use sugg changelog: Add auto applicable suggstion to macro_use_imports fixes #5275 <s>Where exactly is the `wildcard_imports_helper` I haven't been able to import anything ex. `use lazy_static;` or something like for that I get version/compiler conflicts?</s> Found it. Should we also check for `#[macro_use] extern crate`, although this is still depended on for stuff like `rustc_private`?

bors · 2020-06-09T15:44:51Z

💔 Test failed - checks-action_test

flip1995 · 2020-06-09T15:58:17Z

Wait the problem is, that the output is different on 32bit linux 🤔 Since only the order is different, you can add // ignore-32bit

flip1995 · 2020-06-09T20:32:09Z

You also have to update the .fixed and .stderr files

… fmt/`clippy`

DevinR528 · 2020-06-09T20:39:50Z

Oops duh 🤦

flip1995 · 2020-06-09T20:49:23Z

Thanks!

@bors r+

bors · 2020-06-09T20:49:24Z

📌 Commit e521a4e has been approved by flip1995

bors · 2020-06-09T20:49:31Z

⌛ Testing commit e521a4e with merge f065d4b...

bors · 2020-06-09T21:16:47Z

☀️ Test successful - checks-action_dev_test, checks-action_remark_test, checks-action_test
Approved by: flip1995
Pushing f065d4b to master...

DevinR528 force-pushed the macro-use-sugg branch from 30d9aff to 2b4fbfc Compare March 7, 2020 02:18

DevinR528 commented Mar 7, 2020

View reviewed changes

flip1995 added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties label Mar 9, 2020

DevinR528 force-pushed the macro-use-sugg branch 2 times, most recently from 530fc20 to a46ff1f Compare March 18, 2020 02:46

DevinR528 force-pushed the macro-use-sugg branch from a46ff1f to b9a5d9f Compare March 24, 2020 02:17

flip1995 self-requested a review March 30, 2020 19:11

DevinR528 force-pushed the macro-use-sugg branch 2 times, most recently from d611683 to 81048cd Compare April 10, 2020 10:35

DevinR528 force-pushed the macro-use-sugg branch from 81048cd to 4f1698f Compare April 16, 2020 18:58

DevinR528 force-pushed the macro-use-sugg branch from 4f1698f to e535b66 Compare April 19, 2020 14:39

DevinR528 force-pushed the macro-use-sugg branch from e535b66 to 71896a1 Compare April 20, 2020 10:31

DevinR528 force-pushed the macro-use-sugg branch from 71896a1 to 4fdf54b Compare April 21, 2020 19:55

DevinR528 force-pushed the macro-use-sugg branch from 6beb998 to d273ee8 Compare April 27, 2020 10:54

DevinR528 force-pushed the macro-use-sugg branch from d273ee8 to a3b881a Compare May 4, 2020 11:27

DevinR528 added 9 commits June 8, 2020 15:59

warn on macro_use attr

a4b8bb8

cargo dev update lints use if_chain clean up alot, span_lint_and_sugg find imported macros for sugg

collected all the imports and names

ede366b

how to compare macro to import path add more imports to test

use hashset not map for keeping track of seen macro refs

8ffbf6f

remove stdout, fix clippy warnings, fmtcar

remove session

1d9e80a

fix some of the review, rename, fmt, refactor

8bc106b

still working on displaying nested imports

451363d

wip: of handling nested import paths for multi-macro paths

d4f60b5

cleaned up import suggestion formatter, look into code reuse with wil…

8c5a5a9

…dcard impotrs

Fix suggestion output, add run-rustfix to test file, stop sorting imp…

288df59

…ort segments duh

DevinR528 force-pushed the macro-use-sugg branch from ea55d0c to 3f91e39 Compare June 8, 2020 20:02

DevinR528 force-pushed the macro-use-sugg branch from 3f91e39 to 94cbf3c Compare June 9, 2020 20:27

Add enough attrs to the test file so the fix compiles with no errors,…

e521a4e

… fmt/`clippy`

DevinR528 force-pushed the macro-use-sugg branch from 94cbf3c to e521a4e Compare June 9, 2020 20:39

bors merged commit f065d4b into rust-lang:master Jun 9, 2020

bors mentioned this pull request Jun 9, 2020

#5626: lint iterator.map(|x| x) #5694

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Macro use sugg #5279

Macro use sugg #5279

DevinR528 commented Mar 6, 2020 •

edited

Loading

DevinR528 Mar 7, 2020 •

edited

Loading

flip1995 Mar 9, 2020

flip1995 commented Mar 9, 2020 •

edited

Loading

DevinR528 commented Mar 9, 2020 •

edited

Loading

bors commented Mar 10, 2020

DevinR528 commented Mar 18, 2020 •

edited

Loading

bors commented Mar 23, 2020

bors commented Mar 30, 2020

flip1995 commented Apr 15, 2020

bors commented Apr 15, 2020

bors commented Apr 17, 2020

bors commented Apr 19, 2020

bors commented Apr 20, 2020

bors commented Apr 27, 2020

bors commented May 2, 2020

DevinR528 commented May 4, 2020

flip1995 commented May 4, 2020

flip1995 commented Jun 8, 2020

bors commented Jun 8, 2020

DevinR528 commented Jun 8, 2020

flip1995 commented Jun 9, 2020

bors commented Jun 9, 2020

bors commented Jun 9, 2020

bors commented Jun 9, 2020

flip1995 commented Jun 9, 2020

flip1995 commented Jun 9, 2020 •

edited

Loading

DevinR528 commented Jun 9, 2020

flip1995 commented Jun 9, 2020

bors commented Jun 9, 2020

bors commented Jun 9, 2020

bors commented Jun 9, 2020

Macro use sugg #5279

Macro use sugg #5279

Conversation

DevinR528 commented Mar 6, 2020 • edited Loading

DevinR528 Mar 7, 2020 • edited Loading

Choose a reason for hiding this comment

flip1995 Mar 9, 2020

Choose a reason for hiding this comment

flip1995 commented Mar 9, 2020 • edited Loading

DevinR528 commented Mar 9, 2020 • edited Loading

bors commented Mar 10, 2020

DevinR528 commented Mar 18, 2020 • edited Loading

bors commented Mar 23, 2020

bors commented Mar 30, 2020

flip1995 commented Apr 15, 2020

bors commented Apr 15, 2020

bors commented Apr 17, 2020

bors commented Apr 19, 2020

bors commented Apr 20, 2020

bors commented Apr 27, 2020

bors commented May 2, 2020

DevinR528 commented May 4, 2020

flip1995 commented May 4, 2020

flip1995 commented Jun 8, 2020

bors commented Jun 8, 2020

DevinR528 commented Jun 8, 2020

flip1995 commented Jun 9, 2020

bors commented Jun 9, 2020

bors commented Jun 9, 2020

bors commented Jun 9, 2020

flip1995 commented Jun 9, 2020

flip1995 commented Jun 9, 2020 • edited Loading

DevinR528 commented Jun 9, 2020

flip1995 commented Jun 9, 2020

bors commented Jun 9, 2020

bors commented Jun 9, 2020

bors commented Jun 9, 2020

DevinR528 commented Mar 6, 2020 •

edited

Loading

DevinR528 Mar 7, 2020 •

edited

Loading

flip1995 commented Mar 9, 2020 •

edited

Loading

DevinR528 commented Mar 9, 2020 •

edited

Loading

DevinR528 commented Mar 18, 2020 •

edited

Loading

flip1995 commented Jun 9, 2020 •

edited

Loading