Update @oclif/core to v2 (#486)

* Remove CLA github action

* Bump @oclif/core

* Migrate CLI args

* Migrate CliUx class

* Migrate oclif types

* Remove unnecessary flag name

Author: nglgzz

.github/workflows/cla-check.yml

@@ -27,8 +27,8 @@
         "@nestjs/common": "9.4.0",
         "@nestjs/config": "2.3.1",
         "@nestjs/core": "9.4.0",
-        "@oclif/core": "1.26.2",
-        "@oclif/plugin-autocomplete": "1.4.6",
+        "@oclif/core": "2.8.4",
+        "@oclif/plugin-autocomplete": "2.1.9",
         "@oclif/plugin-help": "5.2.9",
         "@relate/common": "workspace:*",
         "@relate/types": "workspace:*",
@@ -39,12 +39,12 @@
         "graphql": "16.6.0",
         "lodash": "4.17.21",
         "node-fetch": "2.6.9",
+        "open": "9.1.0",
         "rxjs": "7.8.1",
         "semver": "7.5.0",
         "tslib": "2.5.0"
     },
     "devDependencies": {
-        "oclif": "3.9.0",
         "@oclif/test": "2.3.17",
         "@types/fs-extra": "9.0.13",
         "@types/jest": "29.5.1",
@@ -56,6 +56,7 @@
         "globby": "10.0.2",
         "jest": "29.5.0",
         "npm-run-all": "4.1.5",
+        "oclif": "3.9.0",
         "ts-jest": "29.1.0",
         "ts-node": "10.9.1",
         "typescript": "4.9.5"

packages/cli/package.json

@@ -1,4 +1,4 @@
-import {Command, Interfaces, Errors} from '@oclif/core';
+import {Command, Errors, Parser} from '@oclif/core';
 import {INestApplicationContext, Type} from '@nestjs/common';
 import {NestFactory} from '@nestjs/core';
 import {ISystemModuleConfig, SystemModule, registerHookListener, HOOK_EVENTS} from '@relate/common';
@@ -7,17 +7,18 @@ import {ConfigModule} from '@nestjs/config';
 import {IS_DEVELOPMENT_ENV, IS_TEST_ENV} from './constants';
 
 export default abstract class BaseCommand extends Command {
-    protected abstract commandClass: Interfaces.Input<Interfaces.FlagOutput, Interfaces.FlagOutput>;
+    protected abstract commandClass: Parameters<typeof Parser.parse>[1];
 
     // Any nestjs module should be a valid command module.
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     protected abstract commandModule: Type<any>;
 
     static flags = {};
 
-    static globalFlags = {};
+    static baseFlags = {};
 
     async run(): Promise<INestApplicationContext> {
+        this.parse();
         const parsed = await this.parse(this.commandClass);
         const utils = {
             debug: this.debug.bind(this),

packages/cli/src/base.command.ts

@@ -1,5 +1,4 @@
-import {Flags} from '@oclif/core';
-import {ENTITY_TYPES} from '@relate/common';
+import {Args, Flags} from '@oclif/core';
 
 import BaseCommand from '../../base.command';
 import {FLAGS, REQUIRED_FOR_SCRIPTS, VALID_BACKUP_TYPES} from '../../constants';
@@ -18,17 +17,16 @@ export default class CreateCommand extends BaseCommand {
         '$ relate backup:create <entity-id> -t dbms',
     ];
 
-    static args = [
-        {
-            name: 'entityNameOrId',
+    static args = {
+        entityNameOrId: Args.string({
             description: 'Entity id',
             required: REQUIRED_FOR_SCRIPTS,
-        },
-    ];
+        }),
+    };
 
     static flags = {
         ...FLAGS.ENVIRONMENT,
-        type: Flags.enum<ENTITY_TYPES>({
+        type: Flags.string({
             char: 't',
             options: VALID_BACKUP_TYPES,
             description: 'The relate entity type',

packages/cli/src/commands/backup/create.ts

@@ -1,5 +1,4 @@
-import {CliUx, Flags} from '@oclif/core';
-import {ENTITY_TYPES} from '@relate/common';
+import {ux, Flags} from '@oclif/core';
 
 import BaseCommand from '../../base.command';
 import {FLAGS, VALID_BACKUP_TYPES} from '../../constants';
@@ -21,8 +20,8 @@ export default class ListCommand extends BaseCommand {
 
     static flags = {
         ...FLAGS.ENVIRONMENT,
-        ...CliUx.ux.table.flags({except: ['extended', 'csv']}),
-        type: Flags.enum<ENTITY_TYPES>({
+        ...ux.table.flags({except: ['extended', 'csv']}),
+        type: Flags.string({
             char: 't',
             options: VALID_BACKUP_TYPES,
             description: 'The relate entity type',

packages/cli/src/commands/backup/list.ts

@@ -1,3 +1,4 @@
+import {Args} from '@oclif/core';
 import BaseCommand from '../../base.command';
 import {FLAGS} from '../../constants';
 import {RemoveModule} from '../../modules/backup/remove.module';
@@ -11,13 +12,12 @@ export default class RemoveCommand extends BaseCommand {
 
     static examples = ['$ relate backup:remove <backup-id-or-path>', '$ relate backup:remove -e environment-name'];
 
-    static args = [
-        {
-            name: 'backupId',
+    static args = {
+        backupId: Args.string({
             description: 'Backup ID',
             required: true,
-        },
-    ];
+        }),
+    };
 
     static flags = {
         ...FLAGS.ENVIRONMENT,

packages/cli/src/commands/backup/remove.ts

@@ -1,3 +1,4 @@
+import {Args} from '@oclif/core';
 import BaseCommand from '../../base.command';
 import {FLAGS} from '../../constants';
 import {RestoreModule} from '../../modules/backup/restore.module';
@@ -15,17 +16,15 @@ export default class RestoreCommand extends BaseCommand {
         '$ relate backup:restore <backup-id-or-path> <output-path>',
     ];
 
-    static args = [
-        {
-            name: 'backupIdOrPath',
+    static args = {
+        backupIdOrPath: Args.string({
             description: 'Backup ID or path',
             required: true,
-        },
-        {
-            name: 'outputPath',
+        }),
+        outputPath: Args.string({
             description: 'destination of backup',
-        },
-    ];
+        }),
+    };
 
     static flags = {
         ...FLAGS.ENVIRONMENT,

packages/cli/src/commands/backup/restore.ts

@@ -1,4 +1,4 @@
-import {Flags} from '@oclif/core';
+import {Args, Flags} from '@oclif/core';
 
 import BaseCommand from '../../base.command';
 import {FLAGS, REQUIRED_FOR_SCRIPTS} from '../../constants';
@@ -18,13 +18,12 @@ export default class CreateCommand extends BaseCommand {
         '$ relate db:create my-new-db -D started-dbms -u dbms-user-with-system-db-access',
     ];
 
-    static args = [
-        {
-            name: 'name',
+    static args = {
+        name: Args.string({
             description: 'database name',
-            required: REQUIRED_FOR_SCRIPTS,
-        },
-    ];
+            reuqired: REQUIRED_FOR_SCRIPTS,
+        }),
+    };
 
     static flags = {
         ...FLAGS.ENVIRONMENT,

packages/cli/src/commands/db/create.ts

@@ -1,4 +1,4 @@
-import {Flags} from '@oclif/core';
+import {Args, Flags} from '@oclif/core';
 
 import BaseCommand from '../../base.command';
 import {FLAGS, REQUIRED_FOR_SCRIPTS} from '../../constants';
@@ -18,13 +18,12 @@ export default class DropCommand extends BaseCommand {
         '$ relate db:drop my-new-db -D started-dbms -u dbms-user-with-system-db-access',
     ];
 
-    static args = [
-        {
-            name: 'name',
+    static args = {
+        name: Args.string({
             description: 'database name',
             reuqired: REQUIRED_FOR_SCRIPTS,
-        },
-    ];
+        }),
+    };
 
     static flags = {
         ...FLAGS.ENVIRONMENT,

packages/cli/src/commands/db/drop.ts

@@ -18,7 +18,7 @@ export default class DumpCommand extends BaseCommand {
         '$ relate db:dump dbms-containing-db-to-dump -d db-to-dump -t /path/to/save/dump/file/to',
     ];
 
-    static args = [ARGS.DBMS];
+    static args = {...ARGS.DBMS};
 
     static strict = false;
 

packages/cli/src/commands/db/dump.ts

@@ -18,7 +18,7 @@ export default class ExecCommand extends BaseCommand {
         '$ relate db:exec dbms-containing-db-to-query -f /path/to/cypher/file -d db-to-query --force',
     ];
 
-    static args = [ARGS.DBMS];
+    static args = {...ARGS.DBMS};
 
     static strict = false;
 

packages/cli/src/commands/db/exec.ts

@@ -1,4 +1,4 @@
-import {CliUx, Flags} from '@oclif/core';
+import {ux, Flags} from '@oclif/core';
 
 import BaseCommand from '../../base.command';
 import {FLAGS, REQUIRED_FOR_SCRIPTS} from '../../constants';
@@ -22,7 +22,7 @@ export default class ListCommand extends BaseCommand {
 
     static flags = {
         ...FLAGS.ENVIRONMENT,
-        ...CliUx.ux.table.flags({except: ['extended', 'csv']}),
+        ...ux.table.flags({except: ['extended', 'csv']}),
         user: Flags.string({
             char: 'u',
             description: 'The Neo4j DBMS user to list databases with (needs to have access to the system database)',

packages/cli/src/commands/db/list.ts

@@ -18,7 +18,7 @@ export default class LoadCommand extends BaseCommand {
         '$ relate db:load dbms-containing-db-to-load-into -f /path/to/dump/file -d db-to-load-into --force',
     ];
 
-    static args = [ARGS.DBMS];
+    static args = {...ARGS.DBMS};
 
     static strict = false;
 

packages/cli/src/commands/db/load.ts

@@ -1,4 +1,4 @@
-import {CliUx} from '@oclif/core';
+import {Args, ux} from '@oclif/core';
 
 import BaseCommand from '../../base.command';
 import {FLAGS} from '../../constants';
@@ -22,15 +22,14 @@ export default class AddSourcesCommand extends BaseCommand {
 
     static strict = false;
 
-    static args = [
-        {
-            name: 'sources',
+    static args = {
+        sources: Args.string({
             description: 'File path or URL to plugin sources',
-        },
-    ];
+        }),
+    };
 
     static flags = {
         ...FLAGS.ENVIRONMENT,
-        ...CliUx.ux.table.flags({except: ['csv']}),
+        ...ux.table.flags({except: ['csv']}),
     };
 }

packages/cli/src/commands/dbms-plugin/add-sources.ts

@@ -1,4 +1,4 @@
-import {CliUx, Flags} from '@oclif/core';
+import {ux, Flags} from '@oclif/core';
 import BaseCommand from '../../base.command';
 import {ARGS, FLAGS, REQUIRED_FOR_SCRIPTS} from '../../constants';
 import {InstallModule} from '../../modules/dbms-plugin/install.module';
@@ -21,11 +21,11 @@ export default class InstallCommand extends BaseCommand {
 
     static strict = false;
 
-    static args = [ARGS.DBMSS];
+    static args = {...ARGS.DBMSS};
 
     static flags = {
         ...FLAGS.ENVIRONMENT,
-        ...CliUx.ux.table.flags({except: ['csv']}),
+        ...ux.table.flags({except: ['csv']}),
         plugin: Flags.string({
             char: 'p',
             description: 'Name of the plugin to install',

packages/cli/src/commands/dbms-plugin/install.ts

@@ -1,4 +1,4 @@
-import {CliUx} from '@oclif/core';
+import {ux} from '@oclif/core';
 
 import BaseCommand from '../../base.command';
 import {FLAGS} from '../../constants';
@@ -23,6 +23,6 @@ export default class ListSourcesCommand extends BaseCommand {
 
     static flags = {
         ...FLAGS.ENVIRONMENT,
-        ...CliUx.ux.table.flags({except: ['csv']}),
+        ...ux.table.flags({except: ['csv']}),
     };
 }

packages/cli/src/commands/dbms-plugin/list-sources.ts

@@ -1,4 +1,4 @@
-import {CliUx} from '@oclif/core';
+import {ux} from '@oclif/core';
 
 import BaseCommand from '../../base.command';
 import {ARGS, FLAGS} from '../../constants';
@@ -21,10 +21,10 @@ export default class ListCommand extends BaseCommand {
         '$ relate dbms-plugin:list MyDbms --filter=name=my-dbms --output=json',
     ];
 
-    static args = [ARGS.DBMS];
+    static args = {...ARGS.DBMS};
 
     static flags = {
         ...FLAGS.ENVIRONMENT,
-        ...CliUx.ux.table.flags({except: ['csv']}),
+        ...ux.table.flags({except: ['csv']}),
     };
 }

packages/cli/src/commands/dbms-plugin/list.ts

@@ -1,3 +1,4 @@
+import {Args} from '@oclif/core';
 import BaseCommand from '../../base.command';
 import {FLAGS} from '../../constants';
 import {RemoveSourcesModule} from '../../modules/dbms-plugin/remove-sources.module';
@@ -20,12 +21,11 @@ export default class RemoveSourcesCommand extends BaseCommand {
 
     static strict = false;
 
-    static args = [
-        {
-            name: 'sources',
+    static args = {
+        sources: Args.string({
             description: 'Names of the plugin sources to remove',
-        },
-    ];
+        }),
+    };
 
     static flags = {
         ...FLAGS.ENVIRONMENT,

packages/cli/src/commands/dbms-plugin/remove-sources.ts

@@ -21,7 +21,7 @@ export default class UninstallCommand extends BaseCommand {
 
     static strict = false;
 
-    static args = [ARGS.DBMSS];
+    static args = {...ARGS.DBMSS};
 
     static flags = {
         ...FLAGS.ENVIRONMENT,