-//! Provides validators for the item declarations.
+//! Provides validators for names of declarations.
//!
//! This includes the following items:
//!
mod case_conv;
+use std::fmt;
+
use base_db::CrateId;
use hir_def::{
adt::VariantData,
AdtId, AttrDefId, ConstId, EnumId, FunctionId, Lookup, ModuleDefId, StaticId, StructId,
};
use hir_expand::{
- diagnostics::DiagnosticSink,
name::{AsName, Name},
+ HirFileId,
};
use stdx::{always, never};
use syntax::{
- ast::{self, NameOwner},
+ ast::{self, HasName},
AstNode, AstPtr,
};
-use crate::{
- db::HirDatabase,
- diagnostics::{decl_check::case_conv::*, CaseType, IdentType, IncorrectCase},
-};
+use crate::db::HirDatabase;
+
+use self::case_conv::{to_camel_case, to_lower_snake_case, to_upper_snake_case};
mod allow {
+ pub(super) const BAD_STYLE: &str = "bad_style";
+ pub(super) const NONSTANDARD_STYLE: &str = "nonstandard_style";
pub(super) const NON_SNAKE_CASE: &str = "non_snake_case";
pub(super) const NON_UPPER_CASE_GLOBAL: &str = "non_upper_case_globals";
pub(super) const NON_CAMEL_CASE_TYPES: &str = "non_camel_case_types";
}
-pub(super) struct DeclValidator<'a, 'b> {
+pub fn incorrect_case(
+ db: &dyn HirDatabase,
+ krate: CrateId,
+ owner: ModuleDefId,
+) -> Vec<IncorrectCase> {
+ let _p = profile::span("validate_module_item");
+ let mut validator = DeclValidator::new(db, krate);
+ validator.validate_item(owner);
+ validator.sink
+}
+
+#[derive(Debug)]
+pub enum CaseType {
+ // `some_var`
+ LowerSnakeCase,
+ // `SOME_CONST`
+ UpperSnakeCase,
+ // `SomeStruct`
+ UpperCamelCase,
+}
+
+impl fmt::Display for CaseType {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ let repr = match self {
+ CaseType::LowerSnakeCase => "snake_case",
+ CaseType::UpperSnakeCase => "UPPER_SNAKE_CASE",
+ CaseType::UpperCamelCase => "CamelCase",
+ };
+
+ write!(f, "{}", repr)
+ }
+}
+
+#[derive(Debug)]
+pub enum IdentType {
+ Constant,
+ Enum,
+ Field,
+ Function,
+ Parameter,
+ StaticVariable,
+ Structure,
+ Variable,
+ Variant,
+}
+
+impl fmt::Display for IdentType {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ let repr = match self {
+ IdentType::Constant => "Constant",
+ IdentType::Enum => "Enum",
+ IdentType::Field => "Field",
+ IdentType::Function => "Function",
+ IdentType::Parameter => "Parameter",
+ IdentType::StaticVariable => "Static variable",
+ IdentType::Structure => "Structure",
+ IdentType::Variable => "Variable",
+ IdentType::Variant => "Variant",
+ };
+
+ write!(f, "{}", repr)
+ }
+}
+
+#[derive(Debug)]
+pub struct IncorrectCase {
+ pub file: HirFileId,
+ pub ident: AstPtr<ast::Name>,
+ pub expected_case: CaseType,
+ pub ident_type: IdentType,
+ pub ident_text: String,
+ pub suggested_text: String,
+}
+
+pub(super) struct DeclValidator<'a> {
db: &'a dyn HirDatabase,
krate: CrateId,
- sink: &'a mut DiagnosticSink<'b>,
+ pub(super) sink: Vec<IncorrectCase>,
}
#[derive(Debug)]
expected_case: CaseType,
}
-impl<'a, 'b> DeclValidator<'a, 'b> {
- pub(super) fn new(
- db: &'a dyn HirDatabase,
- krate: CrateId,
- sink: &'a mut DiagnosticSink<'b>,
- ) -> DeclValidator<'a, 'b> {
- DeclValidator { db, krate, sink }
+impl<'a> DeclValidator<'a> {
+ pub(super) fn new(db: &'a dyn HirDatabase, krate: CrateId) -> DeclValidator<'a> {
+ DeclValidator { db, krate, sink: Vec::new() }
}
pub(super) fn validate_item(&mut self, item: ModuleDefId) {
ModuleDefId::AdtId(adt) => self.validate_adt(adt),
ModuleDefId::ConstId(const_id) => self.validate_const(const_id),
ModuleDefId::StaticId(static_id) => self.validate_static(static_id),
- _ => return,
+ _ => (),
}
}
}
/// Checks whether not following the convention is allowed for this item.
- ///
- /// Currently this method doesn't check parent attributes.
- fn allowed(&self, id: AttrDefId, allow_name: &str) -> bool {
- self.db.attrs(id).by_key("allow").tt_values().any(|tt| tt.to_string().contains(allow_name))
+ fn allowed(&self, id: AttrDefId, allow_name: &str, recursing: bool) -> bool {
+ let is_allowed = |def_id| {
+ let attrs = self.db.attrs(def_id);
+ // don't bug the user about directly no_mangle annotated stuff, they can't do anything about it
+ (!recursing && attrs.by_key("no_mangle").exists())
+ || attrs.by_key("allow").tt_values().any(|tt| {
+ let allows = tt.to_string();
+ allows.contains(allow_name)
+ || allows.contains(allow::BAD_STYLE)
+ || allows.contains(allow::NONSTANDARD_STYLE)
+ })
+ };
+
+ is_allowed(id)
+ // go upwards one step or give up
+ || match id {
+ AttrDefId::ModuleId(m) => m.containing_module(self.db.upcast()).map(|v| v.into()),
+ AttrDefId::FunctionId(f) => Some(f.lookup(self.db.upcast()).container.into()),
+ AttrDefId::StaticId(sid) => Some(sid.lookup(self.db.upcast()).container.into()),
+ AttrDefId::ConstId(cid) => Some(cid.lookup(self.db.upcast()).container.into()),
+ AttrDefId::TraitId(tid) => Some(tid.lookup(self.db.upcast()).container.into()),
+ AttrDefId::ImplId(iid) => Some(iid.lookup(self.db.upcast()).container.into()),
+ // These warnings should not explore macro definitions at all
+ AttrDefId::MacroDefId(_) => None,
+ // Will never occur under an enum/struct/union/type alias
+ AttrDefId::AdtId(_) => None,
+ AttrDefId::FieldId(_) => None,
+ AttrDefId::EnumVariantId(_) => None,
+ AttrDefId::TypeAliasId(_) => None,
+ AttrDefId::GenericParamId(_) => None,
+ }
+ .map(|mid| self.allowed(mid, allow_name, true))
+ .unwrap_or(false)
}
fn validate_func(&mut self, func: FunctionId) {
let data = self.db.function_data(func);
- if data.is_extern {
+ if data.is_in_extern_block() {
cov_mark::hit!(extern_func_incorrect_case_ignored);
return;
}
let body = self.db.body(func.into());
// Recursively validate inner scope items, such as static variables and constants.
- for (item_id, _) in body.item_scope.values() {
- let mut validator = DeclValidator::new(self.db, self.krate, self.sink);
- validator.validate_item(item_id);
+ for (_, block_def_map) in body.blocks(self.db.upcast()) {
+ for (_, module) in block_def_map.modules() {
+ for def_id in module.scope.declarations() {
+ let mut validator = DeclValidator::new(self.db, self.krate);
+ validator.validate_item(def_id);
+ }
+ }
}
// Check whether non-snake case identifiers are allowed for this function.
- if self.allowed(func.into(), allow::NON_SNAKE_CASE) {
+ if self.allowed(func.into(), allow::NON_SNAKE_CASE, false) {
return;
}
expected_case: CaseType::LowerSnakeCase,
});
- // Check the param names.
- let fn_param_replacements = body
- .params
- .iter()
- .filter_map(|&id| match &body[id] {
- Pat::Bind { name, .. } => Some(name),
- _ => None,
- })
- .filter_map(|param_name| {
- Some(Replacement {
- current_name: param_name.clone(),
- suggested_text: to_lower_snake_case(¶m_name.to_string())?,
- expected_case: CaseType::LowerSnakeCase,
- })
- })
- .collect();
-
// Check the patterns inside the function body.
+ // This includes function parameters.
let pats_replacements = body
.pats
.iter()
- // We aren't interested in function parameters, we've processed them above.
- .filter(|(pat_idx, _)| !body.params.contains(&pat_idx))
.filter_map(|(id, pat)| match pat {
Pat::Bind { name, .. } => Some((id, name)),
_ => None,
.collect();
// If there is at least one element to spawn a warning on, go to the source map and generate a warning.
- self.create_incorrect_case_diagnostic_for_func(
- func,
- fn_name_replacement,
- fn_param_replacements,
- );
+ if let Some(fn_name_replacement) = fn_name_replacement {
+ self.create_incorrect_case_diagnostic_for_func(func, fn_name_replacement);
+ }
+
self.create_incorrect_case_diagnostic_for_variables(func, pats_replacements);
}
fn create_incorrect_case_diagnostic_for_func(
&mut self,
func: FunctionId,
- fn_name_replacement: Option<Replacement>,
- fn_param_replacements: Vec<Replacement>,
+ fn_name_replacement: Replacement,
) {
- // XXX: only look at sources if we do have incorrect names
- if fn_name_replacement.is_none() && fn_param_replacements.is_empty() {
- return;
- }
-
let fn_loc = func.lookup(self.db.upcast());
let fn_src = fn_loc.source(self.db.upcast());
// Diagnostic for function name.
- if let Some(replacement) = fn_name_replacement {
- let ast_ptr = match fn_src.value.name() {
- Some(name) => name,
- None => {
- never!(
- "Replacement ({:?}) was generated for a function without a name: {:?}",
- replacement,
- fn_src
- );
- return;
- }
- };
-
- let diagnostic = IncorrectCase {
- file: fn_src.file_id,
- ident_type: IdentType::Function,
- ident: AstPtr::new(&ast_ptr).into(),
- expected_case: replacement.expected_case,
- ident_text: replacement.current_name.to_string(),
- suggested_text: replacement.suggested_text,
- };
-
- self.sink.push(diagnostic);
- }
-
- // Diagnostics for function params.
- let fn_params_list = match fn_src.value.param_list() {
- Some(params) => params,
+ let ast_ptr = match fn_src.value.name() {
+ Some(name) => name,
None => {
- always!(
- fn_param_replacements.is_empty(),
- "Replacements ({:?}) were generated for a function parameters which had no parameters list: {:?}",
- fn_param_replacements,
+ never!(
+ "Replacement ({:?}) was generated for a function without a name: {:?}",
+ fn_name_replacement,
fn_src
);
return;
}
};
- let mut fn_params_iter = fn_params_list.params();
- for param_to_rename in fn_param_replacements {
- // We assume that parameters in replacement are in the same order as in the
- // actual params list, but just some of them (ones that named correctly) are skipped.
- let ast_ptr: ast::Name = loop {
- match fn_params_iter.next() {
- Some(element) => {
- if let Some(ast::Pat::IdentPat(pat)) = element.pat() {
- if pat.to_string() == param_to_rename.current_name.to_string() {
- if let Some(name) = pat.name() {
- break name;
- }
- // This is critical. If we consider this parameter the expected one,
- // it **must** have a name.
- never!(
- "Pattern {:?} equals to expected replacement {:?}, but has no name",
- element,
- param_to_rename
- );
- return;
- }
- }
- }
- None => {
- never!(
- "Replacement ({:?}) was generated for a function parameter which was not found: {:?}",
- param_to_rename, fn_src
- );
- return;
- }
- }
- };
- let diagnostic = IncorrectCase {
- file: fn_src.file_id,
- ident_type: IdentType::Argument,
- ident: AstPtr::new(&ast_ptr).into(),
- expected_case: param_to_rename.expected_case,
- ident_text: param_to_rename.current_name.to_string(),
- suggested_text: param_to_rename.suggested_text,
- };
+ let diagnostic = IncorrectCase {
+ file: fn_src.file_id,
+ ident_type: IdentType::Function,
+ ident: AstPtr::new(&ast_ptr),
+ expected_case: fn_name_replacement.expected_case,
+ ident_text: fn_name_replacement.current_name.to_string(),
+ suggested_text: fn_name_replacement.suggested_text,
+ };
- self.sink.push(diagnostic);
- }
+ self.sink.push(diagnostic);
}
/// Given the information about incorrect variable names, looks up into the source code
None => continue,
};
+ let is_param = ast::Param::can_cast(parent.kind());
+
// We have to check that it's either `let var = ...` or `var @ Variant(_)` statement,
// because e.g. match arms are patterns as well.
// In other words, we check that it's a named variable binding.
let is_binding = ast::LetStmt::can_cast(parent.kind())
|| (ast::MatchArm::can_cast(parent.kind())
&& ident_pat.at_token().is_some());
- if !is_binding {
+ if !(is_param || is_binding) {
// This pattern is not an actual variable declaration, e.g. `Some(val) => {..}` match arm.
continue;
}
+ let ident_type =
+ if is_param { IdentType::Parameter } else { IdentType::Variable };
+
let diagnostic = IncorrectCase {
file: source_ptr.file_id,
- ident_type: IdentType::Variable,
- ident: AstPtr::new(&name_ast).into(),
+ ident_type,
+ ident: AstPtr::new(&name_ast),
expected_case: replacement.expected_case,
ident_text: replacement.current_name.to_string(),
suggested_text: replacement.suggested_text,
fn validate_struct(&mut self, struct_id: StructId) {
let data = self.db.struct_data(struct_id);
- let non_camel_case_allowed = self.allowed(struct_id.into(), allow::NON_CAMEL_CASE_TYPES);
- let non_snake_case_allowed = self.allowed(struct_id.into(), allow::NON_SNAKE_CASE);
+ let non_camel_case_allowed =
+ self.allowed(struct_id.into(), allow::NON_CAMEL_CASE_TYPES, false);
+ let non_snake_case_allowed = self.allowed(struct_id.into(), allow::NON_SNAKE_CASE, false);
// Check the structure name.
let struct_name = data.name.to_string();
struct_name_replacement: Option<Replacement>,
struct_fields_replacements: Vec<Replacement>,
) {
- // XXX: only look at sources if we do have incorrect names
+ // XXX: Only look at sources if we do have incorrect names.
if struct_name_replacement.is_none() && struct_fields_replacements.is_empty() {
return;
}
let diagnostic = IncorrectCase {
file: struct_src.file_id,
ident_type: IdentType::Structure,
- ident: AstPtr::new(&ast_ptr).into(),
+ ident: AstPtr::new(&ast_ptr),
expected_case: replacement.expected_case,
ident_text: replacement.current_name.to_string(),
suggested_text: replacement.suggested_text,
let diagnostic = IncorrectCase {
file: struct_src.file_id,
ident_type: IdentType::Field,
- ident: AstPtr::new(&ast_ptr).into(),
+ ident: AstPtr::new(&ast_ptr),
expected_case: field_to_rename.expected_case,
ident_text: field_to_rename.current_name.to_string(),
suggested_text: field_to_rename.suggested_text,
let data = self.db.enum_data(enum_id);
// Check whether non-camel case names are allowed for this enum.
- if self.allowed(enum_id.into(), allow::NON_CAMEL_CASE_TYPES) {
+ if self.allowed(enum_id.into(), allow::NON_CAMEL_CASE_TYPES, false) {
return;
}
let diagnostic = IncorrectCase {
file: enum_src.file_id,
ident_type: IdentType::Enum,
- ident: AstPtr::new(&ast_ptr).into(),
+ ident: AstPtr::new(&ast_ptr),
expected_case: replacement.expected_case,
ident_text: replacement.current_name.to_string(),
suggested_text: replacement.suggested_text,
let diagnostic = IncorrectCase {
file: enum_src.file_id,
ident_type: IdentType::Variant,
- ident: AstPtr::new(&ast_ptr).into(),
+ ident: AstPtr::new(&ast_ptr),
expected_case: variant_to_rename.expected_case,
ident_text: variant_to_rename.current_name.to_string(),
suggested_text: variant_to_rename.suggested_text,
fn validate_const(&mut self, const_id: ConstId) {
let data = self.db.const_data(const_id);
- if self.allowed(const_id.into(), allow::NON_UPPER_CASE_GLOBAL) {
+ if self.allowed(const_id.into(), allow::NON_UPPER_CASE_GLOBAL, false) {
return;
}
let diagnostic = IncorrectCase {
file: const_src.file_id,
ident_type: IdentType::Constant,
- ident: AstPtr::new(&ast_ptr).into(),
+ ident: AstPtr::new(&ast_ptr),
expected_case: replacement.expected_case,
ident_text: replacement.current_name.to_string(),
suggested_text: replacement.suggested_text,
return;
}
- if self.allowed(static_id.into(), allow::NON_UPPER_CASE_GLOBAL) {
+ if self.allowed(static_id.into(), allow::NON_UPPER_CASE_GLOBAL, false) {
return;
}
- let name = match &data.name {
- Some(name) => name,
- None => return,
- };
+ let name = &data.name;
let static_name = name.to_string();
let replacement = if let Some(new_name) = to_upper_snake_case(&static_name) {
let diagnostic = IncorrectCase {
file: static_src.file_id,
ident_type: IdentType::StaticVariable,
- ident: AstPtr::new(&ast_ptr).into(),
+ ident: AstPtr::new(&ast_ptr),
expected_case: replacement.expected_case,
ident_text: replacement.current_name.to_string(),
suggested_text: replacement.suggested_text,
self.sink.push(diagnostic);
}
}
-
-#[cfg(test)]
-mod tests {
- use crate::diagnostics::tests::check_diagnostics;
-
- #[test]
- fn incorrect_function_name() {
- check_diagnostics(
- r#"
-fn NonSnakeCaseName() {}
-// ^^^^^^^^^^^^^^^^ Function `NonSnakeCaseName` should have snake_case name, e.g. `non_snake_case_name`
-"#,
- );
- }
-
- #[test]
- fn incorrect_function_params() {
- check_diagnostics(
- r#"
-fn foo(SomeParam: u8) {}
- // ^^^^^^^^^ Argument `SomeParam` should have snake_case name, e.g. `some_param`
-
-fn foo2(ok_param: &str, CAPS_PARAM: u8) {}
- // ^^^^^^^^^^ Argument `CAPS_PARAM` should have snake_case name, e.g. `caps_param`
-"#,
- );
- }
-
- #[test]
- fn incorrect_variable_names() {
- check_diagnostics(
- r#"
-fn foo() {
- let SOME_VALUE = 10;
- // ^^^^^^^^^^ Variable `SOME_VALUE` should have snake_case name, e.g. `some_value`
- let AnotherValue = 20;
- // ^^^^^^^^^^^^ Variable `AnotherValue` should have snake_case name, e.g. `another_value`
-}
-"#,
- );
- }
-
- #[test]
- fn incorrect_struct_names() {
- check_diagnostics(
- r#"
-struct non_camel_case_name {}
- // ^^^^^^^^^^^^^^^^^^^ Structure `non_camel_case_name` should have CamelCase name, e.g. `NonCamelCaseName`
-
-struct SCREAMING_CASE {}
- // ^^^^^^^^^^^^^^ Structure `SCREAMING_CASE` should have CamelCase name, e.g. `ScreamingCase`
-"#,
- );
- }
-
- #[test]
- fn no_diagnostic_for_camel_cased_acronyms_in_struct_name() {
- check_diagnostics(
- r#"
-struct AABB {}
-"#,
- );
- }
-
- #[test]
- fn incorrect_struct_field() {
- check_diagnostics(
- r#"
-struct SomeStruct { SomeField: u8 }
- // ^^^^^^^^^ Field `SomeField` should have snake_case name, e.g. `some_field`
-"#,
- );
- }
-
- #[test]
- fn incorrect_enum_names() {
- check_diagnostics(
- r#"
-enum some_enum { Val(u8) }
- // ^^^^^^^^^ Enum `some_enum` should have CamelCase name, e.g. `SomeEnum`
-
-enum SOME_ENUM
- // ^^^^^^^^^ Enum `SOME_ENUM` should have CamelCase name, e.g. `SomeEnum`
-"#,
- );
- }
-
- #[test]
- fn no_diagnostic_for_camel_cased_acronyms_in_enum_name() {
- check_diagnostics(
- r#"
-enum AABB {}
-"#,
- );
- }
-
- #[test]
- fn incorrect_enum_variant_name() {
- check_diagnostics(
- r#"
-enum SomeEnum { SOME_VARIANT(u8) }
- // ^^^^^^^^^^^^ Variant `SOME_VARIANT` should have CamelCase name, e.g. `SomeVariant`
-"#,
- );
- }
-
- #[test]
- fn incorrect_const_name() {
- check_diagnostics(
- r#"
-const some_weird_const: u8 = 10;
- // ^^^^^^^^^^^^^^^^ Constant `some_weird_const` should have UPPER_SNAKE_CASE name, e.g. `SOME_WEIRD_CONST`
-
-fn func() {
- const someConstInFunc: &str = "hi there";
- // ^^^^^^^^^^^^^^^ Constant `someConstInFunc` should have UPPER_SNAKE_CASE name, e.g. `SOME_CONST_IN_FUNC`
-
-}
-"#,
- );
- }
-
- #[test]
- fn incorrect_static_name() {
- check_diagnostics(
- r#"
-static some_weird_const: u8 = 10;
- // ^^^^^^^^^^^^^^^^ Static variable `some_weird_const` should have UPPER_SNAKE_CASE name, e.g. `SOME_WEIRD_CONST`
-
-fn func() {
- static someConstInFunc: &str = "hi there";
- // ^^^^^^^^^^^^^^^ Static variable `someConstInFunc` should have UPPER_SNAKE_CASE name, e.g. `SOME_CONST_IN_FUNC`
-}
-"#,
- );
- }
-
- #[test]
- fn fn_inside_impl_struct() {
- check_diagnostics(
- r#"
-struct someStruct;
- // ^^^^^^^^^^ Structure `someStruct` should have CamelCase name, e.g. `SomeStruct`
-
-impl someStruct {
- fn SomeFunc(&self) {
- // ^^^^^^^^ Function `SomeFunc` should have snake_case name, e.g. `some_func`
- static someConstInFunc: &str = "hi there";
- // ^^^^^^^^^^^^^^^ Static variable `someConstInFunc` should have UPPER_SNAKE_CASE name, e.g. `SOME_CONST_IN_FUNC`
- let WHY_VAR_IS_CAPS = 10;
- // ^^^^^^^^^^^^^^^ Variable `WHY_VAR_IS_CAPS` should have snake_case name, e.g. `why_var_is_caps`
- }
-}
-"#,
- );
- }
-
- #[test]
- fn no_diagnostic_for_enum_varinats() {
- check_diagnostics(
- r#"
-enum Option { Some, None }
-
-fn main() {
- match Option::None {
- None => (),
- Some => (),
- }
-}
-"#,
- );
- }
-
- #[test]
- fn non_let_bind() {
- check_diagnostics(
- r#"
-enum Option { Some, None }
-
-fn main() {
- match Option::None {
- SOME_VAR @ None => (),
- // ^^^^^^^^ Variable `SOME_VAR` should have snake_case name, e.g. `some_var`
- Some => (),
- }
-}
-"#,
- );
- }
-
- #[test]
- fn allow_attributes() {
- check_diagnostics(
- r#"
- #[allow(non_snake_case)]
- fn NonSnakeCaseName(SOME_VAR: u8) -> u8{
- let OtherVar = SOME_VAR + 1;
- OtherVar
- }
-
- #[allow(non_snake_case, non_camel_case_types)]
- pub struct some_type {
- SOME_FIELD: u8,
- SomeField: u16,
- }
-
- #[allow(non_upper_case_globals)]
- pub const some_const: u8 = 10;
-
- #[allow(non_upper_case_globals)]
- pub static SomeStatic: u8 = 10;
- "#,
- );
- }
-
- #[test]
- fn ignores_extern_items() {
- cov_mark::check!(extern_func_incorrect_case_ignored);
- cov_mark::check!(extern_static_incorrect_case_ignored);
- check_diagnostics(
- r#"
-extern {
- fn NonSnakeCaseName(SOME_VAR: u8) -> u8;
- pub static SomeStatic: u8 = 10;
-}
- "#,
- );
- }
-}
projects / rust.git / blobdiff