命名风格诊断信息更具可读性

Author: CppCXY

CodeService/src/LuaCodeStyleOptions.cpp

@@ -30,14 +30,14 @@ LuaCodeStyleOptions::LuaCodeStyleOptions()
 	keep_line_after_local_or_assign_statement(std::make_shared<KeepLineElement>()),
 	keep_line_after_function_define_statement(std::make_shared<KeepLineElement>(1)),
 
-	local_name_define_style(std::make_shared<NameStyleRuleMatcher>()),
-	function_param_name_style(std::make_shared<NameStyleRuleMatcher>()),
-	function_name_define_style(std::make_shared<NameStyleRuleMatcher>()),
-	local_function_name_define_style(std::make_shared<NameStyleRuleMatcher>()),
-	table_field_name_define_style(std::make_shared<NameStyleRuleMatcher>()),
-	global_variable_name_define_style(std::make_shared<NameStyleRuleMatcher>()),
-	module_name_define_style(std::make_shared<NameStyleRuleMatcher>()),
-	require_module_name_style(std::make_shared<NameStyleRuleMatcher>()),
-	class_name_define_style(std::make_shared<NameStyleRuleMatcher>())
+	local_name_define_style(std::make_shared<NameStyleRuleMatcher>("Local")),
+	function_param_name_style(std::make_shared<NameStyleRuleMatcher>("Parameters")),
+	function_name_define_style(std::make_shared<NameStyleRuleMatcher>("Class method")),
+	local_function_name_define_style(std::make_shared<NameStyleRuleMatcher>("Local method")),
+	table_field_name_define_style(std::make_shared<NameStyleRuleMatcher>("Table field")),
+	global_variable_name_define_style(std::make_shared<NameStyleRuleMatcher>("Global")),
+	module_name_define_style(std::make_shared<NameStyleRuleMatcher>("Module")),
+	require_module_name_style(std::make_shared<NameStyleRuleMatcher>("Require module")),
+	class_name_define_style(std::make_shared<NameStyleRuleMatcher>("Class"))
 {
 }

CodeService/src/LuaEditorConfig.cpp

@@ -395,7 +395,7 @@ void LuaEditorConfig::ParseFromSection(std::shared_ptr<LuaCodeStyleOptions> opti
 		if (configMap.count(styleOption.first))
 		{
 			std::string value = configMap.at(styleOption.first);
-			styleOption.second = NameStyleRuleMatcher::ParseFrom(value);
+			styleOption.second->ParseRule(value);
 		}
 	}
 

CodeService/src/NameStyle/NameStyleRuleMatcher.cpp

@@ -16,14 +16,8 @@ NameStyleRuleMatcher::NameStyleRule::NameStyleRule(NameStyleType type, std::vect
 {
 }
 
-std::shared_ptr<NameStyleRuleMatcher> NameStyleRuleMatcher::ParseFrom(std::string_view rule)
-{
-	auto matcher = std::make_shared<NameStyleRuleMatcher>();
-	matcher->ParseRule(rule);
-	return matcher;
-}
-
-NameStyleRuleMatcher::NameStyleRuleMatcher()
+NameStyleRuleMatcher::NameStyleRuleMatcher(std::string_view name)
+	: _name(name)
 {
 }
 
@@ -129,7 +123,7 @@ void NameStyleRuleMatcher::Diagnosis(DiagnosisContext& ctx, std::shared_ptr<Chec
 		}
 	}
 
-	ctx.PushDiagnosis(format(LText("{} not match name rule {}"), checkElement->Node->GetText(), ruleMessage),
+	ctx.PushDiagnosis(format(LText("Name '{}' does not match rule '{}', which require '{}'"), checkElement->Node->GetText(), _name, ruleMessage),
 	                  checkElement->Node->GetTextRange());
 }
 

include/CodeService/LuaCodeStyleEnum.h

@@ -12,3 +12,11 @@ enum class QuoteStyle
 	Single,
 	Double
 };
+
+enum class CallArgParentheses
+{
+	Keep,
+	Remove,
+	Always
+};
+

include/CodeService/LuaCodeStyleOptions.h

@@ -33,6 +33,7 @@ class LuaCodeStyleOptions
 
 	QuoteStyle quote_style = QuoteStyle::None;
 
+	CallArgParentheses call_arg_parentheses = CallArgParentheses::Keep;
 	/*
 	 * 延续行缩进
 	 */
@@ -108,8 +109,6 @@ class LuaCodeStyleOptions
 
 	bool long_chain_expression_allow_one_space_after_colon = false;
 
-	bool call_expression_no_parentheses_when_only_one_string_or_table_arg = false;
-
 	std::string end_of_line = "\r\n";
 
 	bool insert_final_newline = true;

include/CodeService/NameStyle/NameStyleRuleMatcher.h

@@ -29,9 +29,7 @@ class NameStyleRuleMatcher
 		std::vector<std::string> Param;
 	};
 
-	static std::shared_ptr<NameStyleRuleMatcher> ParseFrom(std::string_view rule);
-
-	NameStyleRuleMatcher();
+	NameStyleRuleMatcher(std::string_view name);
 
 	void Diagnosis(DiagnosisContext& ctx, std::shared_ptr<CheckElement> checkElement);
 
@@ -53,4 +51,5 @@ class NameStyleRuleMatcher
 	static std::vector<std::string_view> SplitPart(std::string_view source);
 
 	std::vector<NameStyleRule> _rulers;
+	std::string _name;
 };