feat(parser)!: removed multiple flag aliases (#322)

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

Author: so1ve

docs/guide/flags.md

@@ -19,31 +19,31 @@ It's recommended to use camelCase for flag names as it will be interpreted as pa
 
 The flag type function can be any function that accepts a string and returns the parsed value. The default JavaScript constructors should cover most use cases: [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/String), [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/Number), [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean/Boolean), etc.
 
-The flag description object can be used to store additional information about the flag, such as `alias`, `default`, and `description`. To accept multiple values for a flag, wrap the type function in an array.
+The flag description object can be used to store additional information about the flag, such as `short`, `default`, and `description`. To accept multiple values for a flag, wrap the type function in an array.
 
 All provided information will be used to generate better help documentation.
 
-## Flag Aliases
+## Flag Short Names
 
-Flag aliases allow users to use shorter or alternative names for flags. This is useful for providing convenient shortcuts for commonly used flags.
+Flag short names allow users to use single-character shortcuts for flags. This is useful for providing convenient shortcuts for commonly used flags.
 
-### Single Alias
+### Defining Short Names
 
-You can define a single alias for a flag using a string:
+You can define a single-character short name for a flag using the `short` property:
 
 ```ts
 const cli = Cli()
 	.command("build", "Build the project", {
 		flags: {
 			output: {
 				type: String,
-				alias: "o",
+				short: "o",
 				description: "Output directory",
 			},
 
 			verbose: {
 				type: Boolean,
-				alias: "v",
+				short: "v",
 				description: "Enable verbose output",
 			},
 		},
@@ -59,62 +59,34 @@ const cli = Cli()
 	.parse();
 ```
 
-### Multiple Aliases
+### Validation Rules
 
-You can define multiple aliases for a flag using an array:
+- Flag names must be at least 2 characters long
+- The `short` property must be exactly 1 character
 
-```ts
-const cli = Cli()
-	.command("config", "Configure the application", {
-		flags: {
-			config: {
-				type: String,
-				alias: ["c", "cfg"],
-				description: "Configuration file path",
-			},
-
-			format: {
-				type: String,
-				alias: ["f", "fmt"],
-				description: "Output format",
-			},
-		},
-	})
-	.on("config", (ctx) => {
-		// All of these work:
-		// $ node cli.mjs config --config file.json
-		// $ node cli.mjs config -c file.json
-		// $ node cli.mjs config -cfg file.json
-		// $ node cli.mjs config --format json
-		// $ node cli.mjs config -f json
-		// $ node cli.mjs config -fmt json
-	})
-	.parse();
-```
-
-### Combined Short Aliases
+### Combined Short Names
 
-When using short aliases (single characters), they can be combined together:
+When using short names (single characters), they can be combined together:
 
 ```ts
 const cli = Cli()
 	.command("compress", "Compress files", {
 		flags: {
 			output: {
 				type: String,
-				alias: "o",
+				short: "o",
 				description: "Output file",
 			},
 
 			verbose: {
 				type: Boolean,
-				alias: "v",
+				short: "v",
 				description: "Verbose output",
 			},
 
 			recursive: {
 				type: Boolean,
-				alias: "r",
+				short: "r",
 				description: "Recursive mode",
 			},
 		},
@@ -153,7 +125,7 @@ const cli = Cli()
 			someNumber: {
 				// Wrap the type function in an array to allow multiple values
 				type: [Number],
-				alias: "n",
+				short: "n",
 				description: "Array of numbers. (e.g. -n 1 -n 2 -n 3)",
 			},
 

docs/guide/types.md

@@ -33,7 +33,7 @@ const cli = Cli()
 
 			message: {
 				type: String,
-				alias: "m",
+				short: "m",
 				description: "Greeting message",
 			},
 		},
@@ -66,7 +66,7 @@ const cli = Cli()
 
 			watch: {
 				type: Boolean,
-				alias: "w",
+				short: "w",
 				description: "Enable watch mode",
 			},
 		},
@@ -135,14 +135,14 @@ const cli = Cli()
 			// Use [String] to accept multiple string values
 			include: {
 				type: [String],
-				alias: "i",
+				short: "i",
 				description: "File patterns to include",
 			},
 
 			// Use [Number] to accept multiple numeric values
 			ports: {
 				type: [Number],
-				alias: "p",
+				short: "p",
 				description: "Ports to listen on",
 			},
 		},
@@ -172,7 +172,7 @@ const cli = Cli()
 			// [Boolean] type counts how many times the flag is used
 			verbose: {
 				type: [Boolean],
-				alias: "v",
+				short: "v",
 				description: "Verbosity level (-v, -vv, -vvv)",
 			},
 		},
@@ -205,7 +205,7 @@ const cli = Cli()
 		flags: {
 			define: {
 				type: Object,
-				alias: "d",
+				short: "d",
 				description: "Define environment variables",
 			},
 		},
@@ -467,7 +467,7 @@ const cli = Cli()
 			// Use [CommaSeparatedList] to accept multiple comma-separated lists
 			patterns: {
 				type: [CommaSeparatedList],
-				alias: "p",
+				short: "p",
 				description: "File patterns (comma-separated)",
 			},
 		},

docs/zh/guide/flags.md

@@ -19,31 +19,31 @@ _Clerc_ 的选项解析由 [`@clerc/parser`](https://github.com/clercjs/clerc/bl
 
 选项类型函数可以是任何接受字符串并返回解析后的值的函数。默认的 JavaScript 构造函数应该涵盖大多数用例：[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/String)、[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/Number)、[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean/Boolean) 等。
 
-选项描述对象可用于存储有关选项的其他信息，例如 `alias`、`default` 和 `description`。要接受选项的多个值，请将类型函数包装在数组中。
+选项描述对象可用于存储有关选项的其他信息，例如 `short`、`default` 和 `description`。要接受选项的多个值，请将类型函数包装在数组中。
 
 所有提供的信息将用于生成更好的帮助文档。
 
-## 选项别名
+## 选项短名称
 
-选项别名允许用户使用更短的或替代的名称来指定选项。这对于为常用的选项提供便捷的快捷方式很有用。
+选项短名称允许用户使用单个字符来指定选项。这对于为常用的选项提供便捷的快捷方式很有用。
 
-### 单个别名
+### 定义短名称
 
-你可以使用字符串为选项定义单个别名：
+你可以使用`short`属性为选项定义一个单字符的短名称：
 
 ```ts
 const cli = Cli()
 	.command("build", "构建项目", {
 		flags: {
 			output: {
 				type: String,
-				alias: "o",
+				short: "o",
 				description: "输出目录",
 			},
 
 			verbose: {
 				type: Boolean,
-				alias: "v",
+				short: "v",
 				description: "启用详细输出",
 			},
 		},
@@ -59,62 +59,34 @@ const cli = Cli()
 	.parse();
 ```
 
-### 多个别名
+### 验证规则
 
-你可以使用数组为选项定义多个别名：
+- flag名称必须至少包含2个字符
+- `short`属性必须恰好为1个字符
 
-```ts
-const cli = Cli()
-	.command("config", "配置应用", {
-		flags: {
-			config: {
-				type: String,
-				alias: ["c", "cfg"],
-				description: "配置文件路径",
-			},
-
-			format: {
-				type: String,
-				alias: ["f", "fmt"],
-				description: "输出格式",
-			},
-		},
-	})
-	.on("config", (ctx) => {
-		// 所有这些都可以工作：
-		// $ node cli.mjs config --config file.json
-		// $ node cli.mjs config -c file.json
-		// $ node cli.mjs config -cfg file.json
-		// $ node cli.mjs config --format json
-		// $ node cli.mjs config -f json
-		// $ node cli.mjs config -fmt json
-	})
-	.parse();
-```
-
-### 组合短别名
+### 组合短名称
 
-使用短别名（单个字符）时，它们可以组合在一起：
+使用短名称（单个字符）时，它们可以组合在一起：
 
 ```ts
 const cli = Cli()
 	.command("compress", "压缩文件", {
 		flags: {
 			output: {
 				type: String,
-				alias: "o",
+				short: "o",
 				description: "输出文件",
 			},
 
 			verbose: {
 				type: Boolean,
-				alias: "v",
+				short: "v",
 				description: "详细输出",
 			},
 
 			recursive: {
 				type: Boolean,
-				alias: "r",
+				short: "r",
 				description: "递归模式",
 			},
 		},

docs/zh/guide/types.md

@@ -33,7 +33,7 @@ const cli = Cli()
 
 			message: {
 				type: String,
-				alias: "m",
+				short: "m",
 				description: "问候信息",
 			},
 		},
@@ -66,7 +66,7 @@ const cli = Cli()
 
 			watch: {
 				type: Boolean,
-				alias: "w",
+				short: "w",
 				description: "启用监视模式",
 			},
 		},
@@ -135,14 +135,14 @@ const cli = Cli()
 			// 使用 [String] 来接受多个字符串值
 			include: {
 				type: [String],
-				alias: "i",
+				short: "i",
 				description: "包含的文件模式",
 			},
 
 			// 使用 [Number] 来接受多个数字值
 			ports: {
 				type: [Number],
-				alias: "p",
+				short: "p",
 				description: "要监听的端口",
 			},
 		},
@@ -172,7 +172,7 @@ const cli = Cli()
 			// [Boolean] 类型会计数选项被使用的次数
 			verbose: {
 				type: [Boolean],
-				alias: "v",
+				short: "v",
 				description: "详细日志级别（-v, -vv, -vvv）",
 			},
 		},
@@ -205,7 +205,7 @@ const cli = Cli()
 		flags: {
 			define: {
 				type: Object,
-				alias: "d",
+				short: "d",
 				description: "定义环境变量",
 			},
 		},
@@ -467,7 +467,7 @@ const cli = Cli()
 			// 使用 [CommaSeparatedList] 来接受多个逗号分隔的列表
 			patterns: {
 				type: [CommaSeparatedList],
-				alias: "p",
+				short: "p",
 				description: "文件模式（逗号分隔）",
 			},
 		},