fix(W-16338640): Backward compatibility for CLI commands (#137)

Author: justinwilaby

.gitignore

@@ -6,3 +6,4 @@
 lib/
 node_modules/
 package-lock.json
+.idea/

package.json

@@ -28,6 +28,8 @@
     "@types/sinon": "^10.0.13",
     "@types/supports-color": "^5.3.0",
     "@types/uuid": "^8.3.0",
+    "@types/yargs-parser": "^21.0.3",
+    "@types/yargs-unparser": "^2.0.3",
     "@typescript-eslint/eslint-plugin": "6.21.0",
     "@typescript-eslint/parser": "6.21.0",
     "chai": "^4.4.1",
@@ -48,6 +50,10 @@
     "tslint": "^6.1.3",
     "typescript": "^4.8.4"
   },
+  "peerDependencies": {
+    "yargs-parser": ">=18.x",
+    "yargs-unparser": "^2.0.0"
+  },
   "engines": {
     "node": ">= 16.20.0"
   },

src/command.ts

@@ -1,5 +1,9 @@
 import {Command as Base} from '@oclif/core'
+import {ArgOutput, FlagOutput, Input, ParserOutput} from '@oclif/core/lib/interfaces/parser'
+import {NonExistentFlagsError} from '@oclif/core/lib/parser/errors'
 import {deprecate} from 'util'
+import parser from 'yargs-parser'
+import unparser from 'yargs-unparser'
 
 const pjson = require('../package.json')
 
@@ -14,6 +18,7 @@ export abstract class Command extends Base {
   base = `${pjson.name}@${pjson.version}`
   _heroku!: APIClient
   _legacyHerokuClient: any
+  allowArbitraryFlags: boolean = false;
 
   get heroku(): APIClient {
     if (this._heroku) return this._heroku
@@ -43,4 +48,34 @@ export abstract class Command extends Base {
   get out(): any {
     return deprecatedCLI()
   }
+
+  protected async parse<F extends FlagOutput, B extends FlagOutput, A extends ArgOutput>(options?: Input<F, B, A>, argv?: string[]): Promise<ParserOutput<F, B, A>> {
+    if (this.allowArbitraryFlags) {
+      try {
+        return await super.parse(options, argv)
+      } catch (error) {
+        const {flags: nonExistentFlags} = error as NonExistentFlagsError
+        const parsed = parser(this.argv)
+        const nonExistentFlagsWithValues = {...parsed}
+
+        for (const flag of nonExistentFlags) {
+          const key = flag.replace('--', '')
+          delete parsed[key]
+        }
+
+        for (const key in parsed) {
+          if (Reflect.has(parsed, key)) {
+            delete nonExistentFlagsWithValues[key]
+          }
+        }
+
+        this.argv = unparser(parsed as unparser.Arguments)
+        const result = await super.parse(options, argv)
+        result.nonExistentFlags = unparser(nonExistentFlagsWithValues as unparser.Arguments)
+        return result
+      }
+    }
+
+    return super.parse(options, argv)
+  }
 }