move to cli

sokra · sokra · commit 8c6077c24606 · 2022-01-14T13:19:48.000+01:00
add resetDescription
diff --git a/lib/cli.js b/lib/cli.js
@@ -97,8 +97,10 @@ const getArguments = (schema = webpackSchema) => {
 	 */
 	const getDescription = path => {
 		for (const { schema } of path) {
-			if (schema.cli && schema.cli.helper) continue;
-			if (schema.cliDescription) return schema.cliDescription;
+			if (schema.cli) {
+				if (schema.cli.helper) continue;
+				if (schema.cli.description) return schema.cli.description;
+			}
 			if (schema.description) return schema.description;
 		}
 	};
@@ -110,8 +112,24 @@ const getArguments = (schema = webpackSchema) => {
 	 */
 	const getNegatedDescription = path => {
 		for (const { schema } of path) {
-			if (schema.cli && schema.cli.helper) continue;
-			if (schema.negatedDescription) return schema.negatedDescription;
+			if (schema.cli) {
+				if (schema.cli.helper) continue;
+				if (schema.cli.negatedDescription) return schema.cli.negatedDescription;
+			}
+		}
+	};
+
+	/**
+	 *
+	 * @param {PathItem[]} path path in the schema
+	 * @returns {string | undefined} reset description
+	 */
+	const getResetDescription = path => {
+		for (const { schema } of path) {
+			if (schema.cli) {
+				if (schema.cli.helper) continue;
+				if (schema.cli.resetDescription) return schema.cli.resetDescription;
+			}
 		}
 	};
 
@@ -156,13 +174,17 @@ const getArguments = (schema = webpackSchema) => {
 	const addResetFlag = path => {
 		const schemaPath = path[0].path;
 		const name = pathToArgumentName(`${schemaPath}.reset`);
-		const description = getDescription(path);
+		const description =
+			getResetDescription(path) ||
+			`Clear all items provided in '${schemaPath}' configuration. ${getDescription(
+				path
+			)}`;
 		flags[name] = {
 			configs: [
 				{
 					type: "reset",
 					multiple: false,
-					description: `Clear all items provided in '${schemaPath}' configuration. ${description}`,
+					description,
 					path: schemaPath
 				}
 			],
diff --git a/test/Cli.basictest.js b/test/Cli.basictest.js
@@ -11,21 +11,37 @@ describe("Cli", () => {
 			type: "object",
 			additionalProperties: false,
 			properties: {
+				"with-reset-description": {
+					type: "array",
+					items: {
+						type: "string"
+					},
+					description: "original description",
+					cli: {
+						resetDescription: "custom reset"
+					}
+				},
 				"with-cli-description": {
 					type: "string",
 					description: "original description",
-					cliDescription: "description for CLI option"
+					cli: {
+						description: "description for CLI option"
+					}
 				},
 				"with-negative-description": {
 					type: "boolean",
 					description: "original description",
-					negatedDescription: "custom negative description"
+					cli: {
+						negatedDescription: "custom negative description"
+					}
 				},
 				"with-both-cli-and-negative-description": {
 					type: "boolean",
 					description: "original description",
-					cliDescription: "description for CLI option",
-					negatedDescription: "custom negative description"
+					cli: {
+						description: "description for CLI option",
+						negatedDescription: "custom negative description"
+					}
 				}
 			}
 		};
diff --git a/test/__snapshots__/Cli.basictest.js.snap b/test/__snapshots__/Cli.basictest.js.snap
@@ -8975,5 +8975,31 @@ Object {
     "multiple": false,
     "simpleType": "boolean",
   },
+  "with-reset-description": Object {
+    "configs": Array [
+      Object {
+        "description": "original description",
+        "multiple": true,
+        "path": "with-reset-description[]",
+        "type": "string",
+      },
+    ],
+    "description": "original description",
+    "multiple": true,
+    "simpleType": "string",
+  },
+  "with-reset-description-reset": Object {
+    "configs": Array [
+      Object {
+        "description": "custom reset",
+        "multiple": false,
+        "path": "with-reset-description",
+        "type": "reset",
+      },
+    ],
+    "description": "custom reset",
+    "multiple": false,
+    "simpleType": "boolean",
+  },
 }
 `;
