use clippy_utils::diagnostics::span_lint_hir_and_then;
-use clippy_utils::paths;
+use clippy_utils::return_ty;
use clippy_utils::source::snippet;
use clippy_utils::sugg::DiagnosticBuilderExt;
-use clippy_utils::{get_trait_def_id, return_ty};
use if_chain::if_chain;
use rustc_errors::Applicability;
use rustc_hir as hir;
use rustc_hir::HirIdSet;
use rustc_lint::{LateContext, LateLintPass, LintContext};
use rustc_middle::lint::in_external_macro;
-use rustc_middle::ty::{Ty, TyS};
use rustc_session::{declare_tool_lint, impl_lint_pass};
use rustc_span::sym;
declare_clippy_lint! {
- /// **What it does:** Checks for types with a `fn new() -> Self` method and no
+ /// ### What it does
+ /// Checks for public types with a `pub fn new() -> Self` method and no
/// implementation of
/// [`Default`](https://doc.rust-lang.org/std/default/trait.Default.html).
///
- /// **Why is this bad?** The user might expect to be able to use
+ /// ### Why is this bad?
+ /// The user might expect to be able to use
/// [`Default`](https://doc.rust-lang.org/std/default/trait.Default.html) as the
/// type can be constructed without arguments.
///
- /// **Known problems:** Hopefully none.
- ///
- /// **Example:**
- ///
+ /// ### Example
/// ```ignore
- /// struct Foo(Bar);
+ /// pub struct Foo(Bar);
///
/// impl Foo {
- /// fn new() -> Self {
+ /// pub fn new() -> Self {
/// Foo(Bar::new())
/// }
/// }
/// To fix the lint, add a `Default` implementation that delegates to `new`:
///
/// ```ignore
- /// struct Foo(Bar);
+ /// pub struct Foo(Bar);
///
/// impl Default for Foo {
/// fn default() -> Self {
/// }
/// }
/// ```
+ #[clippy::version = "pre 1.29.0"]
pub NEW_WITHOUT_DEFAULT,
style,
- "`fn new() -> Self` method without `Default` implementation"
+ "`pub fn new() -> Self` method without `Default` implementation"
}
#[derive(Clone, Default)]
if let hir::ItemKind::Impl(hir::Impl {
of_trait: None,
ref generics,
+ self_ty: impl_self_ty,
items,
..
}) = item.kind
{
for assoc_item in items {
- if let hir::AssocItemKind::Fn { has_self: false } = assoc_item.kind {
+ if assoc_item.kind == (hir::AssocItemKind::Fn { has_self: false }) {
let impl_item = cx.tcx.hir().impl_item(assoc_item.id);
if in_external_macro(cx.sess(), impl_item.span) {
return;
// can't be implemented for unsafe new
return;
}
+ if clippy_utils::is_doc_hidden(cx.tcx.hir().attrs(id)) {
+ // shouldn't be implemented when it is hidden in docs
+ return;
+ }
if impl_item
.generics
.params
if_chain! {
if sig.decl.inputs.is_empty();
if name == sym::new;
- if cx.access_levels.is_reachable(id);
- let self_def_id = cx.tcx.hir().local_def_id(cx.tcx.hir().get_parent_item(id));
+ if cx.access_levels.is_reachable(impl_item.def_id);
+ let self_def_id = cx.tcx.hir().get_parent_item(id);
let self_ty = cx.tcx.type_of(self_def_id);
- if TyS::same_type(self_ty, return_ty(cx, id));
- if let Some(default_trait_id) = get_trait_def_id(cx, &paths::DEFAULT_TRAIT);
+ if self_ty == return_ty(cx, id);
+ if let Some(default_trait_id) = cx.tcx.get_diagnostic_item(sym::Default);
then {
if self.impling_types.is_none() {
let mut impls = HirIdSet::default();
}
let generics_sugg = snippet(cx, generics.span, "");
+ let self_ty_fmt = self_ty.to_string();
+ let self_type_snip = snippet(cx, impl_self_ty.span, &self_ty_fmt);
span_lint_hir_and_then(
cx,
NEW_WITHOUT_DEFAULT,
impl_item.span,
&format!(
"you should consider adding a `Default` implementation for `{}`",
- self_ty
+ self_type_snip
),
|diag| {
diag.suggest_prepend_item(
cx,
item.span,
- "try this",
- &create_new_without_default_suggest_msg(self_ty, &generics_sugg),
+ "try adding this",
+ &create_new_without_default_suggest_msg(&self_type_snip, &generics_sugg),
Applicability::MaybeIncorrect,
);
},
}
}
-fn create_new_without_default_suggest_msg(ty: Ty<'_>, generics_sugg: &str) -> String {
+fn create_new_without_default_suggest_msg(self_type_snip: &str, generics_sugg: &str) -> String {
#[rustfmt::skip]
format!(
"impl{} Default for {} {{
fn default() -> Self {{
Self::new()
}}
-}}", generics_sugg, ty)
+}}", generics_sugg, self_type_snip)
}