npalmGH-240 update name header shorthand to nh

larmitage-bjss · Feb 15, 2024 · 239a0f4 · 239a0f4
1 parent b193369
commit 239a0f4
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -63,7 +63,7 @@ Options:
   -u, --update-readme         Update readme file.                              [string]
   -l, --line-breaks           Used line breaks in the generated docs.
                                  [string] [choices: "CR", "LF", "CRLF"] [default: "LF"]
-  -h, --include-name-header   Include a header with the action/workflow name.
+ -nh, --include-name-header   Include a header with the action/workflow name.
 ```
 
 ### Update the README

diff --git a/__tests__/cli.test.ts b/__tests__/cli.test.ts
@@ -41,7 +41,7 @@ describe("CLI tests", () => {
 
   test("Console output including name header and no banner.", async () => {
     const result = await cli(
-      `-a ${path.join(fixtureDir, "action.yml")} -h true --no-banner`,
+      `-a ${path.join(fixtureDir, "action.yml")} -nh true --no-banner`,
     );
 
     const expected = <string>(

diff --git a/src/cli.ts b/src/cli.ts
@@ -43,7 +43,7 @@ const args = await yargs(process.argv.slice(2))
     "include-name-header": {
       description: "Include a header with the action/workflow name",
       type: "boolean",
-      alias: "h",
+      alias: "nh",
     },
   })
   .help().argv;