feat(testing): add test for optionDescriptions

[jsjoeio]

This PR adds a test for optionDescriptions.

Fixes #4915

[codecov]

Codecov Report

Merging #4970 (6afc87b) into main (77296c7) will increase coverage by 0.89%.
The diff coverage is 100.00%.

❗ Current head 6afc87b differs from pull request most recent head 64e5bb0. Consider uploading reports for the commit 64e5bb0 to get more accurate results

@@            Coverage Diff             @@
##             main    #4970      +/-   ##
==========================================
+ Coverage   70.56%   71.45%   +0.89%     
==========================================
  Files          29       29              
  Lines        1678     1678              
  Branches      372      373       +1     
==========================================
+ Hits         1184     1199      +15     
+ Misses        420      408      -12     
+ Partials       74       71       -3     

Impacted Files	Coverage Δ
src/node/cli.ts	91.60% <100.00%> (+5.72%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 77296c7...64e5bb0. Read the comment docs.

[github-actions]

✨ code-server docs for PR #4970 is ready! It will be updated on every commit.

• Host: https://coder.com/docs/code-server/6afc87b
• Last deploy status: success
• Commit: 64e5bb0
• Workflow status: https://github.com/coder/code-server/actions/runs/1970581127

[jsjoeio]

🙈 Not proud of this line here but we replace line breaks with spaces, then remove spaces.

[code-asher]

What do you think about making optionDescriptions take an argument so we can test specific expectations? And possibly adding optionDescription so we can test a single option without having to wrap it in an array. nvm it needs to take an array of options otherwise it cannot align them so a single-option function is pretty much useless

For example:

it("should display option flag and description", () => {
  expect(optionDescriptions([{ type: "boolean": long: "foo", short: "f", description: "a foo flag")}]).toStrictEqual("-f --foo a foo flag")
})

it("should visually align multiple options", () => {
  const options = [
    { type: "boolean": long: "foo", short: "f", description: "a foo flag"}
    { type: "string": short: "r", description: "an r flag"}
    { type: "string[]": long: "somethingquitelong"}
  ]
  expect(optionDescriptions(options)).toStrictEqual([
    "-f --foo                a foo flag",
    "-r                      an r flag"
    "   --somethingquitelong"
  ].join("\n")
})

it("should add all valid options for enumerated types", () => {
  expect(optionDescriptions([{ type: AuthType: long: "auth", description: "some auth")}]).toStrictEqual("   --foo some auth [password, none]")
})

it("should show if an option is deprecated")

it("should show newlines in description")

[jsjoeio]

@code-asher okay to be extra clear, you're saying I should do this:

What do you think about making optionDescriptions take an argument so we can test specific expectations?

and not do this:

single-option function is pretty much useless

right?

[code-asher]

Yes!

[code-asher]

Nicely done!