feat: migrate oclif/core to V3 (asyncapi#1228)

bin/dev

@@ -15,4 +15,3 @@ oclif.settings.debug = true;
 
 // Start the CLI
 oclif.run().then(oclif.flush).catch(oclif.Errors.handle)
-

bin/run

@@ -10,4 +10,3 @@ oclif.run()
     const oclifHandler = require('@oclif/core/handle');
     return oclifHandler(err.message);
   });
-

bin/run_bin

@@ -11,4 +11,3 @@ oclif.run()
     const oclifHandler = require('@oclif/core/handle');
     return oclifHandler(err.message);
   });
-

package.json

@@ -21,7 +21,7 @@
     "@asyncapi/raml-dt-schema-parser": "^4.0.22",
     "@asyncapi/studio": "^0.20.0",
     "@clack/prompts": "^0.7.0",
-    "@oclif/core": "^1.26.2",
+    "@oclif/core": "^3",
     "@oclif/errors": "^1.3.6",
     "@oclif/plugin-not-found": "^2.3.22",
     "@smoya/asyncapi-adoption-metrics": "^2.4.7",
@@ -168,6 +168,7 @@
     "release": "semantic-release",
     "test": "npm run test:unit",
     "test:unit": "cross-env NODE_ENV=development TEST=1 CUSTOM_CONTEXT_FILENAME=\"test.asyncapi-cli\" CUSTOM_CONTEXT_FILE_LOCATION=\"\" nyc --extension .ts mocha --require ts-node/register --require test/helpers/init.js --reporter spec --timeout 100000 \"test/**/*.test.ts\"",
+    "test:one": "cross-env NODE_ENV=development TEST=1 CUSTOM_CONTEXT_FILENAME=\"test.asyncapi-cli\" CUSTOM_CONTEXT_FILE_LOCATION=\"\" nyc --extension .ts mocha --require ts-node/register --require test/helpers/init.js --reporter spec --timeout 100000",
     "get-version": "echo $npm_package_version",
     "createhook": "oclif generate hook myhook --event=command_not_found",
     "createhookinit": "oclif generate hook inithook --event=init"

src/commands/bundle.ts

@@ -1,5 +1,4 @@
 import { Flags } from '@oclif/core';
-import { Example } from '@oclif/core/lib/interfaces';
 import Command from '../base';
 import bundle from '@asyncapi/bundler';
 import { promises } from 'fs';
@@ -13,7 +12,8 @@ export default class Bundle extends Command {
   static readonly description = 'Bundle one or multiple AsyncAPI Documents and their references together.';
   static strict = false;
 
-  static examples: Example[] = [
+  static examples = [
+    'asyncapi bundle ./asyncapi.yaml > final-asyncapi.yaml',
     'asyncapi bundle ./asyncapi.yaml --output final-asyncapi.yaml',
     'asyncapi bundle ./asyncapi.yaml ./features.yaml',
     'asyncapi bundle ./asyncapi.yaml ./features.yaml --base ./main.yaml',
@@ -32,8 +32,8 @@ export default class Bundle extends Command {
   async run() {
     const { argv, flags } = await this.parse(Bundle);
     const output = flags.output;
-    const outputFormat = path.extname(argv[0]);
-    const AsyncAPIFiles = argv;
+    const outputFormat = path.extname(argv[0] as string);
+    const AsyncAPIFiles = argv as string[];
 
     this.metricsMetadata.files = AsyncAPIFiles.length;
 
@@ -44,7 +44,7 @@ export default class Bundle extends Command {
         xOrigin: flags.xOrigin,
       }
     );
-    
+
     await this.collectMetricsData(document);
 
     if (!output) {

src/commands/config/context/add.ts

@@ -1,4 +1,4 @@
-import { Flags } from '@oclif/core';
+import { Flags, Args } from '@oclif/core';
 import Command from '../../../base';
 import { addContext, setCurrentContext } from '../../../models/Context';
 import {
@@ -18,14 +18,10 @@ export default class ContextAdd extends Command {
     })
   };
 
-  static args = [
-    { name: 'context-name', description: 'context name', required: true },
-    {
-      name: 'spec-file-path',
-      description: 'file path of the spec file',
-      required: true,
-    },
-  ];
+  static args = {
+    'context-name': Args.string({description: 'context name', required: true}),
+    'spec-file-path': Args.string({description: 'file path of the spec file', required: true}),
+  };
 
   async run() {
     const { args, flags } = await this.parse(ContextAdd);

src/commands/config/context/edit.ts

@@ -1,4 +1,4 @@
-import { Flags } from '@oclif/core';
+import { Flags, Args } from '@oclif/core';
 import Command from '../../../base';
 import { editContext, CONTEXT_FILE_PATH } from '../../../models/Context';
 import {
@@ -13,15 +13,10 @@ export default class ContextEdit extends Command {
     help: Flags.help({ char: 'h' }),
   };
 
-  static args = [
-    { name: 'context-name', description: 'context name', required: true },
-    {
-      name: 'new-spec-file-path',
-      description: 'new file path of the spec file',
-      required: true,
-    },
-  ];
-
+  static args = {
+    'context-name': Args.string({description: 'context name', required: true}),
+    'new-spec-file-path': Args.string({description: 'file path of the spec file', required: true}),
+  };
   async run() {
     const { args } = await this.parse(ContextEdit);
     const contextName = args['context-name'];

src/commands/config/context/init.ts

@@ -1,4 +1,4 @@
-import { Flags } from '@oclif/core';
+import { Flags, Args } from '@oclif/core';
 import Command from '../../../base';
 import { initContext } from '../../../models/Context';
 
@@ -13,19 +13,15 @@ export default class ContextInit extends Command {
     - root of current repository : asyncapi config context init ./
     - user's home directory      : asyncapi config context init ~`;
 
-  static args = [
-    {
-      name: 'context-file-path',
-      description: `${ContextInit.contextFilePathMessage}`,
-      required: false,
-    },
-  ];
+  static args = {
+    'context-file-path': Args.string({description: `${ContextInit.contextFilePathMessage}`, required: false})
+  };
 
   async run() {
     const { args } = await this.parse(ContextInit);
     const contextFilePath = args['context-file-path'];
 
-    const contextWritePath = await initContext(contextFilePath);
+    const contextWritePath = await initContext(contextFilePath as string);
     this.log(`Initialized context ${contextWritePath}`);
   }
 }

src/commands/config/context/remove.ts

@@ -1,4 +1,4 @@
-import { Flags } from '@oclif/core';
+import { Flags, Args } from '@oclif/core';
 import Command from '../../../base';
 import { removeContext, CONTEXT_FILE_PATH } from '../../../models/Context';
 import {
@@ -13,13 +13,9 @@ export default class ContextRemove extends Command {
     help: Flags.help({ char: 'h' }),
   };
 
-  static args = [
-    {
-      name: 'context-name',
-      description: 'Name of the context to delete',
-      required: true,
-    },
-  ];
+  static args = {
+    'context-name': Args.string({description: 'Name of the context to delete', required: true}),
+  };
 
   async run() {
     const { args } = await this.parse(ContextRemove);

src/commands/config/context/use.ts

@@ -1,4 +1,4 @@
-import { Flags } from '@oclif/core';
+import { Flags, Args } from '@oclif/core';
 import Command from '../../../base';
 import { setCurrentContext, CONTEXT_FILE_PATH } from '../../../models/Context';
 import {
@@ -13,13 +13,9 @@ export default class ContextUse extends Command {
     help: Flags.help({ char: 'h' }),
   };
 
-  static args = [
-    {
-      name: 'context-name',
-      description: 'name of the saved context',
-      required: true,
-    },
-  ];
+  static args = {
+    'context-name': Args.string({description: 'name of the saved context', required: true}),
+  };
 
   async run() {
     const { args } = await this.parse(ContextUse);

src/commands/convert.ts

@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/ban-ts-comment */
 import { promises as fPromises } from 'fs';
-import { Flags } from '@oclif/core';
+import { Flags, Args } from '@oclif/core';
 import Command from '../base';
 import { ValidationError } from '../errors/validation-error';
 import { load } from '../models/SpecificationFile';
@@ -23,9 +23,9 @@ export default class Convert extends Command {
     'target-version': Flags.string({ char: 't', description: 'asyncapi version to convert to', default: latestVersion })
   };
 
-  static args = [
-    { name: 'spec-file', description: 'spec path, url, or context-name', required: false },
-  ];
+  static args = {
+    'spec-file': Args.string({description: 'spec path, url, or context-name', required: false}),
+  };
 
   async run() {
     const { args, flags } = await this.parse(Convert);

src/commands/diff.ts

@@ -1,5 +1,5 @@
 /* eslint-disable sonarjs/no-duplicate-string */
-import { Flags } from '@oclif/core';
+import { Flags, Args } from '@oclif/core';
 import * as diff from '@asyncapi/diff';
 import AsyncAPIDiff from '@asyncapi/diff/lib/asyncapidiff';
 import { promises as fs } from 'fs';
@@ -54,18 +54,10 @@ export default class Diff extends Command {
     ...validationFlags({ logDiagnostics: false }),
   };
 
-  static args = [
-    {
-      name: 'old',
-      description: 'old spec path, URL or context-name',
-      required: true,
-    },
-    {
-      name: 'new',
-      description: 'new spec path, URL or context-name',
-      required: true,
-    },
-  ];
+  static args = {
+    old: Args.string({description: 'old spec path, URL or context-name', required: true}),
+    new: Args.string({description: 'new spec path, URL or context-name', required: true}),
+  };
 
   /* eslint-disable sonarjs/cognitive-complexity */
   async run() {
@@ -82,7 +74,7 @@ export default class Diff extends Command {
     let firstDocument: Specification, secondDocument: Specification;
 
     checkAndWarnFalseFlag(outputFormat, markdownSubtype);
-    markdownSubtype = setDefaultMarkdownSubtype(outputFormat, markdownSubtype);
+    markdownSubtype = setDefaultMarkdownSubtype(outputFormat, markdownSubtype) as string;
 
     try {
       firstDocument = await load(firstDocumentPath);

src/commands/generate/fromTemplate.ts

@@ -1,4 +1,4 @@
-import { Flags } from '@oclif/core';
+import { Flags, Args } from '@oclif/core';
 import Command from '../../base';
 // eslint-disable-next-line
 // @ts-ignore
@@ -12,7 +12,6 @@ import { isLocalTemplate, Watcher } from '../../utils/generator';
 import { ValidationError } from '../../errors/validation-error';
 import { GeneratorError } from '../../errors/generator-error';
 import { Parser } from '@asyncapi/parser';
-import type { Example } from '@oclif/core/lib/interfaces';
 import { intro, isCancel, spinner, text } from '@clack/prompts';
 import { inverse, yellow, magenta, green, red } from 'picocolors';
 import fetch from 'node-fetch';
@@ -53,7 +52,7 @@ function verifyTemplateSupportForV3(template: string) {
 export default class Template extends Command {
   static description = 'Generates whatever you want using templates compatible with AsyncAPI Generator.';
 
-  static examples: Example[] = [
+  static examples = [
     'asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template --param version=1.0.0 singleFile=true --output ./docs --force-write'
   ];
 
@@ -112,10 +111,11 @@ export default class Template extends Command {
       description: 'The npm registry authentication token, that can be passed instead of base64 encoded username and password'
     })
   };
-  static args = [
-    { name: 'asyncapi', description: '- Local path, url or context-name pointing to AsyncAPI file' },
-    { name: 'template', description: '- Name of the generator template like for example @asyncapi/html-template or https://github.com/asyncapi/html-template' },
-  ];
+
+  static args = {
+    asyncapi: Args.string({description: '- Local path, url or context-name pointing to AsyncAPI file', required: true}),
+    template: Args.string({description: '- Name of the generator template like for example @asyncapi/html-template or https://github.com/asyncapi/html-template', required: true}),
+  };
 
   parser = new Parser();
 
@@ -150,7 +150,7 @@ export default class Template extends Command {
       }
     };
     const asyncapiInput = (await load(asyncapi)) || (await load());
-    
+
     this.specFile = asyncapiInput;
     this.metricsMetadata.template = template;
 
@@ -193,7 +193,7 @@ export default class Template extends Command {
       });
     }
 
-    if (isCancel(asyncapi)) { 
+    if (isCancel(asyncapi)) {
       this.error(cancellationMessage, { exit: 1 });
     }
 
@@ -233,7 +233,7 @@ export default class Template extends Command {
       mapBaseUrlToFolder: this.mapBaseURLParser(mapBaseUrl),
       registryURLValidation: this.registryURLParser(registryUrl),
       registryAuthentication: this.registryValidation(registryUrl, registryAuth, registryToken)
-      
+
     } as ParsedFlags;
   }
 

src/commands/generate/models.ts

@@ -1,9 +1,9 @@
 import { CSharpFileGenerator, JavaFileGenerator, JavaScriptFileGenerator, TypeScriptFileGenerator, GoFileGenerator, Logger, DartFileGenerator, PythonFileGenerator, RustFileGenerator, TS_COMMON_PRESET, TS_JSONBINPACK_PRESET, CSHARP_DEFAULT_PRESET, CSHARP_NEWTONSOFT_SERIALIZER_PRESET, CSHARP_COMMON_PRESET, CSHARP_JSON_SERIALIZER_PRESET, KotlinFileGenerator, TS_DESCRIPTION_PRESET, PhpFileGenerator, CplusplusFileGenerator, JAVA_CONSTRAINTS_PRESET, JAVA_JACKSON_PRESET, JAVA_COMMON_PRESET, JAVA_DESCRIPTION_PRESET } from '@asyncapi/modelina';
-import { Flags } from '@oclif/core';
+import { Flags, Args } from '@oclif/core';
 import { ConvertDocumentParserAPIVersion } from '@smoya/multi-parser';
 import Command from '../../base';
 import { load } from '../../models/SpecificationFile';
-import { formatOutput, parse, validationFlags } from '../../parser';
+import { formatOutput, parse, validationFlags, ValidateOptions } from '../../parser';
 
 import { select, text, spinner, isCancel, cancel, intro } from '@clack/prompts';
 import { green, inverse } from 'picocolors';
@@ -27,14 +27,11 @@ const possibleLanguageValues = Object.values(Languages).join(', ');
 
 export default class Models extends Command {
   static description = 'Generates typed models';
-  static args = [
-    {
-      name: 'language',
-      description: 'The language you want the typed models generated for.',
-      options: Object.keys(Languages),
-    },
-    { name: 'file', description: 'Path or URL to the AsyncAPI document, or context-name' },
-  ];
+
+  static args = {
+    language: Args.string({description: 'The language you want the typed models generated for.', options: Object.keys(Languages), required: true}),
+    file: Args.string({description: 'Path or URL to the AsyncAPI document, or context-name', required: true}),
+  };
 
   static flags = {
     help: Flags.help({ char: 'h' }),
@@ -194,14 +191,14 @@ export default class Models extends Command {
     if (inputFile.isAsyncAPI3()) {
       this.error('Generate Models command does not support AsyncAPI v3 yet, please checkout https://github.com/asyncapi/modelina/issues/1376');
     }
-    const { document, diagnostics ,status } = await parse(this, inputFile, flags);
+    const { document, diagnostics ,status } = await parse(this, inputFile, flags as ValidateOptions);
     if (!document || status === 'invalid') {
       const severityErrors = diagnostics.filter((obj) => obj.severity === 0);
       this.log(`Input is not a correct AsyncAPI document so it cannot be processed.${formatOutput(severityErrors,'stylish','error')}`);
       return;
     }
-    
-    // Modelina, atm, is not using @asyncapi/[email protected] but @asyncapi/[email protected], so it still uses Parser-API v1.0.0. 
+
+    // Modelina, atm, is not using @asyncapi/[email protected] but @asyncapi/[email protected], so it still uses Parser-API v1.0.0.
     // This call converts the parsed document object using @asyncapi/[email protected] (Parser-API v2) to a document compatible with the Parser-API version in use in @asyncapi/[email protected]  (v1)
     // This is needed until https://github.com/asyncapi/modelina/issues/1493 gets fixed.
     const convertedDoc = ConvertDocumentParserAPIVersion(document.json(), 1);
@@ -394,7 +391,7 @@ export default class Models extends Command {
     if (!language) {
       language = await select({
         message: 'Select the language you want to generate models for',
-        options: Object.keys(Languages).map((key) => 
+        options: Object.keys(Languages).map((key) =>
           ({ value: key, label: key, hint: Languages[key as keyof typeof Languages] })
         ),
       });
@@ -434,7 +431,7 @@ export default class Models extends Command {
       cancel(operationCancelled);
       this.exit();
     }
-      
+
     return { language, file, output: output || 'stdout' };
   }
 }