Rename function for clarity

Author: schaable

v-next/hardhat/src/internal/cli/helpers/utils.ts

@@ -17,7 +17,7 @@ export function parseGlobalOptions(
   globalOptionDefinitions: GlobalOptionDefinitions,
 ): ArgumentDescriptor[] {
   return [...globalOptionDefinitions].map(([, { option }]) => ({
-    name: formatOptionName(option.name),
+    name: toCommandLineOption(option.name),
     description: option.description,
   }));
 }
@@ -64,7 +64,7 @@ export function parseOptions(task: Task): {
 
   for (const [optionName, option] of task.options) {
     options.push({
-      name: formatOptionName(optionName),
+      name: toCommandLineOption(optionName),
       description: option.description,
       type: option.type,
     });
@@ -81,8 +81,8 @@ export function parseOptions(task: Task): {
   return { options, positionalArguments };
 }
 
-export function formatOptionName(str: string): string {
-  return `--${camelToKebabCase(str)}`;
+export function toCommandLineOption(optionName: string): string {
+  return `--${camelToKebabCase(optionName)}`;
 }
 
 export function getLongestNameLength(tasks: Array<{ name: string }>): number {

v-next/hardhat/test/internal/cli/helpers/utils.ts

@@ -9,7 +9,7 @@ import {
   parseTasks,
   parseSubtasks,
   parseOptions,
-  formatOptionName,
+  toCommandLineOption,
   getLongestNameLength,
   getSection,
   getUsageString,
@@ -179,10 +179,11 @@ describe("utils", function () {
     });
   });
 
-  describe("formatOptionName", function () {
-    it("should format option names", function () {
-      assert.equal(formatOptionName("option"), "--option");
-      assert.equal(formatOptionName("anotherOption"), "--another-option");
+  describe("toCommandLineOption", function () {
+    it("should convert a camelCase option name to a kebab-case command line option", function () {
+      assert.equal(toCommandLineOption("option"), "--option");
+      assert.equal(toCommandLineOption("anotherOption"), "--another-option");
+      assert.equal(toCommandLineOption("anotherOption1"), "--another-option-1");
     });
   });