规范打印

Author: CppCXY

CHANGELOG.md

@@ -1,5 +1,7 @@
 # Change Log
+## 0.9.6
 
+命令行工具帮助打印更规范
 ## 0.9.5
 
 命令行工具在指定单输入文件时可以指定工作区，这可以帮助detect config。

CodeFormat/src/CodeFormat.cpp

@@ -24,7 +24,13 @@
 int main(int argc, char** argv)
 {
 	CommandLine cmd;
-
+	cmd.SetUsage(
+		"Usage:\n"
+		"CodeFormat [check/format] [options]\n"
+		"for example:\n"
+		"\tCodeFormat check -w . -d\n"
+		"\tCodeFormat format -f test.lua -d\n"
+		);
 	cmd.AddTarget("format")
 	   .Add<std::string>("file", "f", "Specify the input file")
 	   .Add<std::string>("workspace", "w",
@@ -34,7 +40,7 @@ int main(int argc, char** argv)
 	                     "Specify .editorconfig file, it decides on the effect of formatting")
 	   .Add<bool>("detect-config", "d",
 	              "Configuration will be automatically detected,\n"
-	              "    If this option is set, the config option has no effect ")
+	              "\t\tIf this option is set, the config option has no effect ")
 	   .Add<std::string>("outfile", "o",
 	                     "Specify output file")
 	   .EnableKeyValueArgs();
@@ -46,7 +52,7 @@ int main(int argc, char** argv)
 	                     "Specify editorconfig file, it decides on the effect of formatting or diagnosis")
 	   .Add<bool>("detect-config", "d",
 	              "Configuration will be automatically detected,\n"
-	              "    If this option is set, the config option has no effect")
+	              "\t\tIf this option is set, the config option has no effect")
 	   .Add<bool>("diagnosis-as-error", "DAE", "if exist error or diagnosis info , return -1")
 	   .EnableKeyValueArgs();
 

Util/src/CommandLine.cpp

@@ -177,6 +177,11 @@ bool CommandLine::Parse(int argc, char** argv)
 	return true;
 }
 
+void CommandLine::SetUsage(std::string_view usage)
+{
+	_usage = std::string(usage);
+}
+
 void CommandLine::PrintUsage()
 {
 	for (auto& error : _errors)
@@ -185,7 +190,7 @@ void CommandLine::PrintUsage()
 	}
 	std::cerr << std::endl;
 
-	std::cerr << "first param must be target:" << std::endl;
+	std::cerr << _usage << std::endl;
 	for (auto& target : _targets)
 	{
 		std::cerr << format("{}:", target.first) << std::endl;
@@ -196,7 +201,7 @@ void CommandLine::PrintUsage()
 			auto& name = it.second;
 			auto& option = options._args[name];
 
-			std::cerr << format("    -{} --{} {}",
+			std::cerr << format("\t-{} --{}\n\t\t{}",
 				shortName, name, option.Description) << std::endl;
 			std::cerr << std::endl;
 		}

include/Util/CommandLine.h

@@ -130,11 +130,14 @@ class CommandLine
 
 	bool Parse(int argc, char** argv);
 
+	void SetUsage(std::string_view usage);
+
 	void PrintUsage();
 private:
 	std::vector<std::string> _argvs;
 	std::map<std::string, CommandLineTargetOptions, std::less<>> _targets;
 	CommandLineTargetOptions* _options;
 	std::string _currentTarget;
 	std::vector<std::string> _errors;
+	std::string _usage;
 };