Merge branch 'main' into mdonnalley/support-deprecations

.github/workflows/notify-slack-on-pr-open.yml

@@ -0,0 +1,23 @@
+name: Pull Request Slack Notification
+
+on:
+  pull_request:
+    types: [opened, reopened]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Notify Slack on PR open
+      env: 
+        WEBHOOK_URL : ${{ secrets.CLI_TEAM_SLACK_WEBHOOK_URL }}
+        PULL_REQUEST_AUTHOR_ICON_URL : ${{ github.event.pull_request.user.avatar_url }}
+        PULL_REQUEST_AUTHOR_NAME : ${{ github.event.pull_request.user.login }}
+        PULL_REQUEST_AUTHOR_PROFILE_URL: ${{ github.event.pull_request.user.html_url }}
+        PULL_REQUEST_BASE_BRANCH_NAME : ${{ github.event.pull_request.base.ref }}
+        PULL_REQUEST_COMPARE_BRANCH_NAME : ${{ github.event.pull_request.head.ref }}
+        PULL_REQUEST_NUMBER : ${{ github.event.pull_request.number }}
+        PULL_REQUEST_REPO: ${{ github.event.pull_request.head.repo.name }}
+        PULL_REQUEST_TITLE : ${{ github.event.pull_request.title }}
+        PULL_REQUEST_URL : ${{ github.event.pull_request.html_url }}
+      uses: salesforcecli/github-workflows/.github/actions/prNotification@main

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/core",
   "description": "base library for oclif CLIs",
-  "version": "1.16.4",
+  "version": "1.16.7",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {
@@ -114,4 +114,4 @@
     "pretest": "yarn build --noEmit && tsc -p test --noEmit --skipLibCheck"
   },
   "types": "lib/index.d.ts"
-}
+}

src/command.ts

@@ -267,6 +267,7 @@ export default abstract class Command {
     const opts = {context: this, ...options}
     // the spread operator doesn't work with getters so we have to manually add it here
     opts.flags = options?.flags
+    opts.args = options?.args
     return Parser.parse(argv, opts)
   }
 

src/config/config.ts

@@ -753,6 +753,7 @@ export async function toCached(c: Command.Class, plugin?: IPlugin): Promise<Comm
         dependsOn: flag.dependsOn,
         exclusive: flag.exclusive,
         deprecated: flag.deprecated,
+        aliases: flag.aliases,
       }
     } else {
       flags[name] = {
@@ -773,6 +774,7 @@ export async function toCached(c: Command.Class, plugin?: IPlugin): Promise<Comm
         exclusive: flag.exclusive,
         default: await defaultToCached(flag),
         deprecated: flag.deprecated,
+        aliases: flag.aliases,
       }
       // a command-level placeholder in the manifest so that oclif knows it should regenerate the command during help-time
       if (typeof flag.defaultHelp === 'function') {

src/help/command.ts

@@ -156,20 +156,18 @@ export class CommandHelp extends HelpFormatter {
     const cmd = this.command
 
     let description: string[] | undefined
-
     if (this.opts.hideCommandSummaryInDescription) {
       description = (cmd.description || '').split(POSSIBLE_LINE_FEED).slice(1)
     } else if (cmd.description) {
-      description = [
-        ...(cmd.summary || '').split(POSSIBLE_LINE_FEED),
+      const summary = cmd.summary ? `${cmd.summary}\n` : null
+      description = summary ? [
+        ...summary.split(POSSIBLE_LINE_FEED),
         ...(cmd.description || '').split(POSSIBLE_LINE_FEED),
-      ]
+      ] : (cmd.description || '').split(POSSIBLE_LINE_FEED)
     }
 
     if (description) {
-      // Lines separated with only one newline or more than 2 can be hard to read in the terminal.
-      // Always separate by two newlines.
-      return this.wrap(compact(description).join('\n\n'))
+      return this.wrap(description.join('\n'))
     }
   }
 

src/interfaces/parser.ts

@@ -153,6 +153,10 @@ export type FlagProps = {
    * Make the flag as deprecated.
    */
   deprecated?: true | Deprecation;
+  /**
+   * Alternate names that can be used for this flag.
+   */
+  aliases?: string[];
 }
 
 export type BooleanFlagProps = FlagProps & {

src/parser/parse.ts

@@ -39,6 +39,7 @@ export class Parser<T extends ParserInput, TFlags extends OutputFlags<T['flags']
   private readonly raw: ParsingToken[] = []
 
   private readonly booleanFlags: { [k: string]: BooleanFlag<any> }
+  private readonly flagAliases: { [k: string]: BooleanFlag<any> | OptionFlag<any> }
 
   private readonly context: any
 
@@ -52,6 +53,10 @@ export class Parser<T extends ParserInput, TFlags extends OutputFlags<T['flags']
     this.argv = [...input.argv]
     this._setNames()
     this.booleanFlags = pickBy(input.flags, f => f.type === 'boolean') as any
+    this.flagAliases = Object.fromEntries(Object.values(input.flags).flatMap(flag => {
+      return (flag.aliases ?? []).map(a => [a, flag])
+    }))
+
     this.metaData = {}
   }
 
@@ -64,6 +69,10 @@ export class Parser<T extends ParserInput, TFlags extends OutputFlags<T['flags']
         return name
       }
 
+      if (this.flagAliases[name]) {
+        return this.flagAliases[name].name
+      }
+
       if (arg.startsWith('--no-')) {
         const flag = this.booleanFlags[arg.slice(5)]
         if (flag && flag.allowNo) return flag.name

test/help/format-command.test.ts

@@ -25,6 +25,7 @@ describe('formatCommand', () => {
       static aliases = ['app:init', 'create']
 
       static description = `first line
+
 multiline help`
 
       static enableJsonFlag = true
@@ -222,7 +223,7 @@ DESCRIPTION
     .commandHelp(class extends Command {
         static id = 'apps:create'
 
-        static description = 'description of apps:create\nthese values are after and will show up in the command description'
+        static description = 'description of apps:create\n\nthese values are after and will show up in the command description'
 
         static aliases = ['app:init', 'create']
 
@@ -259,7 +260,7 @@ ALIASES
     .commandHelp(class extends Command {
         static id = 'apps:create'
 
-        static description = 'root part of the description\nThe <%= config.bin %> CLI has <%= command.id %>'
+        static description = 'root part of the description\n\nThe <%= config.bin %> CLI has <%= command.id %>'
 
         static disableJsonFlag = true
     })
@@ -275,7 +276,7 @@ DESCRIPTION
     .commandHelp(class extends Command {
         static id = 'apps:create'
 
-        static description = 'root part of the description\r\nusing both carriage \nreturn and new line'
+        static description = 'root part of the description\r\n\nusing both carriage \n\nreturn and new line'
 
         static disableJsonFlag = true
     })

test/parser/parse.test.ts

@@ -1338,4 +1338,28 @@ See more help with --help`)
       })
     })
   })
+
+  describe('flag aliases', () => {
+    it('works with defined name', async () => {
+      const out = await parse(['--foo'], {
+        flags: {
+          foo: flags.boolean({
+            aliases: ['bar'],
+          }),
+        },
+      })
+      expect(out.flags.foo).to.equal(true)
+    })
+
+    it('works with aliased name', async () => {
+      const out = await parse(['--bar'], {
+        flags: {
+          foo: flags.boolean({
+            aliases: ['bar'],
+          }),
+        },
+      })
+      expect(out.flags.foo).to.equal(true)
+    })
+  })
 })

yarn.lock

@@ -2460,9 +2460,9 @@ minimist-options@4.1.0:
     kind-of "^6.0.3"
 
 minimist@^1.2.3, minimist@^1.2.5:
-  version "1.2.5"
-  resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.5.tgz#67d66014b66a6a8aaa0c083c5fd58df4e4e97602"
-  integrity sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==
+  version "1.2.7"
+  resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.7.tgz#daa1c4d91f507390437c6a8bc01078e7000c4d18"
+  integrity sha512-bzfL1YUZsP41gmu/qjrEk0Q6i2ix/cVeAhbCbqH9u3zYutS1cLg00qhrD0M2MVdCcx4Sc0UpP2eBWo9rotpq6g==
 
 mocha@^8.4.0:
   version "8.4.0"