fix: adjust help text to new style guide (#259)

* fix: fix: adjust help text to new style guide

@W-9928119@

* chore: fix broken unit test

Author: peternhale

src/config/plugin.ts

@@ -135,11 +135,7 @@ export class Plugin implements IPlugin {
     this.manifest = await this._manifest(Boolean(this.options.ignoreManifest), Boolean(this.options.errorOnManifestCreate))
     this.commands = Object.entries(this.manifest.commands)
     .map(([id, c]) => ({...c, pluginAlias: this.alias, pluginType: this.type, load: async () => this.findCommand(id, {must: true})}))
-    this.commands.sort((a, b) => {
-      if (a.id < b.id) return -1
-      if (a.id > b.id) return 1
-      return 0
-    })
+    this.commands.sort((a, b) => a.id.localeCompare(b.id))
   }
 
   get topics(): Topic[] {

src/flags.ts

@@ -31,7 +31,7 @@ export {boolean, integer, url} from './parser'
 
 export const version = (opts: Partial<BooleanFlag<boolean>> = {}) => {
   return Parser.flags.boolean({
-    description: 'show CLI version',
+    description: 'Show CLI version.',
     ...opts,
     parse: async (_: any, cmd: Command) => {
       cmd.log(cmd.config.userAgent)
@@ -42,7 +42,7 @@ export const version = (opts: Partial<BooleanFlag<boolean>> = {}) => {
 
 export const help = (opts: Partial<BooleanFlag<boolean>> = {}) => {
   return Parser.flags.boolean({
-    description: 'show CLI help',
+    description: 'Show CLI help.',
     ...opts,
     parse: async (_: any, cmd: Command) => {
       (cmd as any)._help()

src/help/index.ts

@@ -116,7 +116,7 @@ export class Help extends HelpBase {
       return
     }
 
-    error(`command ${subject} not found`)
+    error(`Command ${subject} not found.`)
   }
 
   public async showCommandHelp(command: Interfaces.Command) {

src/main.ts

@@ -3,6 +3,7 @@ import {fileURLToPath} from 'url'
 import {format, inspect} from 'util'
 
 import * as Interfaces from './interfaces'
+import {URL} from 'url'
 import {Config} from './config'
 import {getHelpFlagAdditions, loadHelpClass, standardizeIDFromArgv} from './help'
 
@@ -33,7 +34,7 @@ export const versionAddition = (argv: string[], config?: Interfaces.Config): boo
 // eslint-disable-next-line default-param-last
 export async function run(argv = process.argv.slice(2), options?: Interfaces.LoadOptions) {
   // Handle the case when a file URL string or URL is passed in such as 'import.meta.url'; covert to file path.
-  if ((typeof options === 'string' && options.startsWith('file://')) || options instanceof URL) {
+  if (options && ((typeof options === 'string' && options.startsWith('file://')) || options instanceof URL)) {
     options = fileURLToPath(options)
   }
 

test/help/show-help.test.ts

@@ -360,7 +360,7 @@ describe('showHelp routing', () => {
     test
     .setupHelp()
     .it('shows an error when there is a subject but it does not match a topic or command', async ({help}) => {
-      await expect(help.showHelp(['meow'])).to.be.rejectedWith('command meow not found')
+      await expect(help.showHelp(['meow'])).to.be.rejectedWith('Command meow not found')
     })
   })
 })

test/parser/parse.test.ts

@@ -3,6 +3,8 @@ import {expect} from 'chai'
 
 import {flags, parse} from '../../src/parser'
 import {Interfaces} from '../../src'
+import {URL} from 'url'
+
 const stripAnsi = require('strip-ansi')
 
 describe('parse', () => {

tsconfig.json

@@ -9,7 +9,8 @@
       "./src"
     ],
     "strict": true,
-    "target": "es2017"
+    "target": "es2019",
+    "lib": ["es2019"]
   },
   "include": [
     "./src/**/*"