feat: create initial modelina cli

[devilkiller-ag]

Description

Create a CLI for Modelina and integrate it with AsyncAPI CLI

Related Issue

Related to issue #1724

Checklist

• The code follows the project's coding standards and is properly linted (npm run lint).
• Tests have been added or updated to cover the changes.
• Documentation has been updated to reflect the changes.
• All tests pass successfully locally.(npm run test).

[netlify]

✅ Deploy Preview for modelina canceled.

Name	Link
🔨 Latest commit	4a4ecad
🔍 Latest deploy log	https://app.netlify.com/sites/modelina/deploys/65df44e6f63640000829204b

[devilkiller-ag]

@jonaslagoni I have generated a CLI using OCLIF. I will be working next to add some basic commands.

[jonaslagoni]

@devilkiller-ag you could just copy paste the command from the AsyncAPI CLI as a baseline ✌️

[devilkiller-ag]

@devilkiller-ag you could just copy paste the command from the AsyncAPI CLI as a baseline ✌️

Okay Sure I will do that 👍🏼

[devilkiller-ag]

Hey @jonaslagoni, Do I need to install modelina as a dependency in modelina-cli or should I generate these generators from the build of modelina?

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 '@modelina/generators';

import type { AbstractGenerator, AbstractFileGenerator } from '@asyncapi/modelina';

[jonaslagoni]

@devilkiller-ag I would say use dependency and use file://../ to link to the root directory, assuming you are under /modelina-cli

[devilkiller-ag]

@jonaslagoni Okay I will do that.

[devilkiller-ag]

use file://../ to link to the root directory, assuming you are under /modelina-cli

Hey @jonaslagoni, can you elaborate a little more about it? I am sorry I couldn't understand it. If we install modelina as a dependency in the modelina-cli project folder, we can use it directly. Then what's the need to import from the Modelina project root folder? I am sorry I am a little bit blurry with my thoughts.

[jonaslagoni]

I think you are gonna run into problems when you have to pack and build the cli if you dont use dependency, but I might be wrong 🙂

So yea, do what ever is easiest and straight forward for you now, we can easily change it

[jonaslagoni]

Hey @devilkiller-ag are you stuck on anything? 🙂

[devilkiller-ag]

Hi @jonaslagoni, yeah I was stuck with some type errors that I can't find why they are happening. I got busy with my class assignments before I could further investigate. I will resume working on this tomorrow.

Here is the issues that I am currently facing:

• In the file modelina-cli/src/parser.ts,

export function formatOutput(diagnostics: Diagnostic[], format: `${OutputFormat}`, failSeverity: SeveritytKind) {
  const options = { failSeverity: getDiagnosticSeverity(failSeverity) };
  switch (format) {
  case 'stylish': return stylish(diagnostics, options);
  case 'json': return json(diagnostics, options);
  case 'junit': return junit(diagnostics, options);
  case 'html': return html(diagnostics, options);
  case 'text': return text(diagnostics, options);
  case 'teamcity': return teamcity(diagnostics, options);
  case 'pretty': return pretty(diagnostics, options);
  default: return stylish(diagnostics, options);
  }
}

In this function, when we are passing options to any FormatterOption I get the following error:

Argument of type '{ failSeverity: -1 | DiagnosticSeverity; }' is not assignable to parameter of type 'FormatterOptions'.ts(2345)
const options: {
    failSeverity: -1 | DiagnosticSeverity;
}

When I checked the original code from asyncapi-cli, I got the same error there too. Do you have any hint about it?

[devilkiller-ag]

I have pushed my latest code for your review

[jonaslagoni]

Left a few comments, hope it unblocks you ✌️

Looks like you are nearly there 💪

[devilkiller-ag]

Hey @jonaslagoni, I made the changes you suggested, can you please checkout the code?

[devilkiller-ag]

@jonaslagoni Do I need to add tests for cli?

[coveralls]

Pull Request Test Coverage Report for Build 8081649738

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

• For more information on this, see Tracking coverage changes with pull request builds.
• To avoid this issue with future PRs, see these Recommended CI Configurations.
• For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

• 0 of 0 changed or added relevant lines in 0 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage remained the same at 92.303%

---

Totals
Change from base Build 8061790627:	0.0%
Covered Lines:	5994
Relevant Lines:	6325

---

💛 - Coveralls

[devilkiller-ag]

I have disabled some eslit rules as they were asking unnecessary changes in existing code

[jonaslagoni]

I think you need to add the modelina-cli to the list in the root .eslintignore otherwise it will try to run it there without the proper plugins.

Otherwise it looks fine to me 👌 Lets focus on getting a bare minimum working CLI here first and then we can experiment with embedding it into the AsyncAPI CLI 🙂

[devilkiller-ag]

Hi @jonaslagoni, can you please review this PR?

[devilkiller-ag]

@jonaslagoni Do I need to resolve sonar cloud code duplication check fail?This check was passing before the merge from the master.

[jonaslagoni]

Got some small changes that is needed to set this up better for release and running it locally. Basically just grabbing all the good stuff from the AsyncAPI CLI, no need to reinvent the wheel ✌️

1. Grab all the files in https://github.com/asyncapi/cli/tree/master/bin
2. Grab the following script: https://github.com/asyncapi/cli/blob/master/scripts/releasePackagesRename.js
3. Grab the following script: https://github.com/asyncapi/cli/blob/master/scripts/updateUsageDocs.js
4. Adapt the files which has suggestions
5. Grab the AsyncAPI CLI testing setup: https://github.com/asyncapi/cli/blob/master/test/
6. Take the Modelina test which can be found here (make sure to grab all related testing files): https://github.com/asyncapi/cli/blob/master/test/integration/generate/models.test.ts

[jonaslagoni]

@jonaslagoni Do I need to resolve sonar cloud code duplication check fail?This check was passing before the merge from the master.

No, completely ignore the sonarcloud ✌️

[devilkiller-ag]

Hi @jonaslagoni,
What should I pass in place of document here (Line no. 387 & 396):

const models = await fileGenerator.generateToFiles(
        document,
        output,
        { ...fileOptions, });

In Async API CLI, document was generated by the parser as

// Ref: Line no. 177-187 -> https://github.com/asyncapi/cli/blob/master/src/commands/generate/models.ts 
const { document, diagnostics ,status } = await parse(this, inputFile, flags);
    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/parser@v3.x but @asyncapi/parser@v2.x, so it still uses Parser-API v1.0.0. 
    // This call converts the parsed document object using @asyncapi/parser@v3.x (Parser-API v2) to a document compatible with the Parser-API version in use in @asyncapi/parser@v2.x  (v1)
    // This is needed until https://github.com/asyncapi/modelina/issues/1493 gets fixed.
    const convertedDoc = ConvertDocumentParserAPIVersion(document.json(), 1);

And this convertedDoc was passed here in place of document:

const models = await fileGenerator.generateToFiles(
        convertedDoc as any,
        output,
        { ...fileOptions, });

But here we have removed the parser, so what should we use in place of this?

[jonaslagoni]

The content of the file in question as a string 🙂

[sonarcloud]

Quality Gate failed

Failed conditions
4.9% Duplication on New Code (required ≤ 3%)

See analysis details on SonarCloud

[jonaslagoni]

Nearly there 💪

[jonaslagoni]

You can add this to ignore list 🙂

[jonaslagoni]

You can remove the entire minitemplate directory 🙂

[jonaslagoni]

All of these non existing commands can just be removed completely 🙂 Only need the Modelina test and generic tests for context ✌️

[jonaslagoni]

@devilkiller-ag as we discussed, I created a specific branch we can slowly work on, a bunch of good stuff in this PR so let's merge what we have, and I can do a little bit of cleanup 💪

[jonaslagoni]

@devilkiller-ag do you mind creating a draft PR that targets master from the cli branch 🙂 ?

[devilkiller-ag]

@devilkiller-ag do you mind creating a draft PR that targets master from the cli branch 🙂 ?

Okay sure