Skip to content

Commit

Permalink
Add idiom lint for bare extern crate
Browse files Browse the repository at this point in the history
  • Loading branch information
Manishearth committed May 4, 2018
1 parent 0bfe307 commit dafbdeb
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 1 deletion.
63 changes: 63 additions & 0 deletions src/librustc_lint/builtin.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1508,3 +1508,66 @@ impl<'a, 'tcx> LateLintPass<'a, 'tcx> for UnusedBrokenConst {
}
}
}

declare_lint! {
pub UNNECESSARY_EXTERN_CRATE,
Allow,
"suggest removing `extern crate` for the 2018 edition"
}

pub struct ExternCrate(/* depth */ u32);

impl ExternCrate {
pub fn new() -> Self {
ExternCrate(0)
}
}

impl LintPass for ExternCrate {
fn get_lints(&self) -> LintArray {
lint_array!(UNNECESSARY_EXTERN_CRATE)
}
}

impl<'a, 'tcx> LateLintPass<'a, 'tcx> for ExternCrate {
fn check_item(&mut self, cx: &LateContext, it: &hir::Item) {
if let hir::ItemExternCrate(ref orig) = it.node {
if it.attrs.iter().any(|a| a.check_name("macro_use")) {
return
}
let mut err = cx.struct_span_lint(UNNECESSARY_EXTERN_CRATE,
it.span, "`extern crate` is unnecessary in the new edition");
if it.vis == hir::Visibility::Public || self.0 > 1 || orig.is_some() {
let pub_ = if it.vis == hir::Visibility::Public {
"pub "
} else {
""
};

let help = format!("use `{}use`", pub_);

if let Some(orig) = orig {
err.span_suggestion(it.span, &help,
format!("{}use {} as {}", pub_, orig, it.name));
} else {
err.span_suggestion(it.span, &help,
format!("{}use {}", pub_, it.name));
}
} else {
err.span_suggestion(it.span, "remove it", "".into());
}

err.emit();
}
}

fn check_mod(&mut self, _: &LateContext, _: &hir::Mod,
_: Span, _: ast::NodeId) {
self.0 += 1;
}

fn check_mod_post(&mut self, _: &LateContext, _: &hir::Mod,
_: Span, _: ast::NodeId) {
self.0 += 1;
}
}
4 changes: 3 additions & 1 deletion src/librustc_lint/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,7 @@ pub fn register_builtins(store: &mut lint::LintStore, sess: Option<&Session>) {
TypeLimits,
MissingDoc,
MissingDebugImplementations,
ExternCrate,
);

add_lint_group!(sess,
Expand Down Expand Up @@ -180,7 +181,8 @@ pub fn register_builtins(store: &mut lint::LintStore, sess: Option<&Session>) {
add_lint_group!(sess,
"rust_2018_idioms",
BARE_TRAIT_OBJECT,
UNREACHABLE_PUB);
UNREACHABLE_PUB,
UNNECESSARY_EXTERN_CRATE);

// Guidelines for creating a future incompatibility lint:
//
Expand Down

0 comments on commit dafbdeb

Please sign in to comment.