[BUG] Very out of date package JSON, breaking documentation example.

[ghost]

Describe the bug.

The documentation example https://www.asyncapi.com/tools/generator is to run using:

docker run --rm -it --user=root -v ${PWD}/example:/app/example -v ${PWD}/output:/app/output \
asyncapi/cli generate fromTemplate https://bit.ly/asyncapi @asyncapi/html-template -o example

However, the versions in the asyncapi/cli:2.8.0 (and many others) are out of date: package.json.

{
  "name": "@asyncapi/cli",
  "description": "All in one CLI for all AsyncAPI tools",
  "version": "2.8.0",
  "author": "@asyncapi",
  "bin": {
    "asyncapi": "./bin/run_bin"
  },
  "bugs": "https://github.com/asyncapi/cli/issues",
  "dependencies": {
    "@asyncapi/avro-schema-parser": "^3.0.23",
    "@asyncapi/bundler": "^0.6.3",
    "@asyncapi/converter": "^1.6.2",
    "@asyncapi/diff": "^0.4.1",
    "@asyncapi/generator": "^1.17.25",

resulting in the following errors:

◑  Generation in progress. Keep calm and wait a bit..Template @asyncapi/html-template successfully installed in /usr/local/lib/node_modules/@asyncapi/cli/node_modules/@asyncapi/generator/node_modules/@asyncapi/html-template.
Version of used template is 3.0.0.
◇  Generation failed
Generator Error: This template is not compatible with the current version of the generator (1.17.25). This template is compatible with the following version range: >=2.0.0 <3.0.0.

Expected behavior

Working example from homepage

Screenshots

How to Reproduce

Run the example from the homepage: https://www.asyncapi.com/tools/generator

🥦 Browser

None

👀 Have you checked for similar open issues?

• I checked and didn't find similar issue

🏢 Have you read the Contributing Guidelines?

• I have read the Contributing Guidelines

Are you willing to work on this issue ?

No, someone else can work on it

[github-actions]

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

[ghost]

For example, current generator version is: 2.4.1 https://github.com/asyncapi/generator/releases

Container for the CLI:2.8.0 is running the following versions:

@asyncapi/cli/2.8.0 linux-x64 node-v20.18.0
  ├@asyncapi/avro-schema-parser/3.0.24
  ├@asyncapi/bundler/0.6.4
  ├@asyncapi/converter/1.6.2
  ├@asyncapi/diff/0.4.1
  ├@asyncapi/generator/1.17.25
  ├@asyncapi/modelina-cli/4.0.0-next.62
  ├@asyncapi/openapi-schema-parser/3.0.24
  ├@asyncapi/optimizer/1.0.4
  ├@asyncapi/parser/3.3.0
  ├@asyncapi/protobuf-schema-parser/3.2.14
  ├@asyncapi/raml-dt-schema-parser/4.0.24
  └@asyncapi/studio/0.20.2

Repository: https://github.com/asyncapi/cli

[bernarth]

The error Generator Error: This template is not compatible with the current version of the generator (1.17.25). This template is compatible with the following version range: >=2.0.0 <3.0.0. is happening to me as well. I think the latest version of the generator should be used instead ( current version here ) which is 2.5.0 today

[abiola-deimos]

Does anyone know what the workaround is?

[bernarth]

I am using html-template so, I am using an specific version of it. -> 2.3.14
With the example above it could be something like: docker run --rm -it --user=root -v ${PWD}/example:/app/example -v ${PWD}/output:/app/output \ asyncapi/cli generate fromTemplate https://bit.ly/asyncapi @asyncapi/[email protected] -o example

You can use a compatible version (if you are using html-template here )

[yenidunya]

The error Generator Error: This template is not compatible with the current version of the generator (1.17.25). This template is compatible with the following version range: >=2.0.0 <3.0.0. is happening to me as well. I think the latest version of the generator should be used instead ( current version here ) which is 2.5.0 today

tried changing it in package.json and then installing cli. installed version of the generator seems OK but then I received following error while using generate:

    return oclifHandler(err.message);
           ^

TypeError: oclifHandler is not a function

[bernarth]

I tried the same. But, when installing the CLI it comes with an older version of the installed packages which causes conflicts.

[yenidunya]

using the option --use-new-generator with generate overcomes the problem

[alsofr]

I'm running into a similar issue when running asyncapi generate with the latest version (2.11.1) of asyncapi install.
No docker involved, just a simple command line argument. I've tried install via brew or via pkg, with the current or with an older version, and I'm still getting the same error:

asyncapi generate golang -packageName=model my-asynapi-file.json -o model.go

/opt/homebrew/Cellar/asyncapi/2.11.1/libexec/lib/node_modules/@asyncapi/cli/bin/run_bin:12
    return oclifHandler(err.message);
           ^

TypeError: oclifHandler is not a function
    at /opt/homebrew/Cellar/asyncapi/2.11.1/libexec/lib/node_modules/@asyncapi/cli/bin/run_bin:12:12

Looking at the code, the problem seems to be linked to a problem loading @oclif/core/handle.

const oclif = require('@oclif/core');

oclif.run()
  .then(require('@oclif/core/flush'))
  .catch((err) => {
    const oclifHandler = require('@oclif/core/handle');
    return oclifHandler(err.message);
  });

However, things look consistent in the package.json:

[Shurtu-gal]

Hello people,
Just to put some context here to keep backward compatibility we are currently maintaining two versions of generator currently:- 2.4.1 and 1.7.25.

So, to use templates requiring newer version please use the flag --use-new-generator as mentioned here

Edit: For more context #1513 and #1388

[alsofr]

Hi @Shurtu-gal , could you please explain how to use this flag with the asyncapi generate golang command? The flag doesn't seem to have any effect there

[Shurtu-gal]

Hi @Shurtu-gal , could you please explain how to use this flag with the asyncapi generate golang command? The flag doesn't seem to have any effect there

This command is there for generating models and uses modelina under the hood. So this flag doesn't make sense there.

Could you specify your problem?

[alsofr]

I mentioned it a bit earlier
#1562 (comment)

Sorry for piggy-backing on this issue, the error message was the same so I assumed the issues must be related.

If the --use-new-generator flag is only for the fromTemplate mode, how do I fix the generate problem?

[Shurtu-gal]

I mentioned it a bit earlier #1562 (comment)

Sorry for piggy-backing on this issue, the error message was the same so I assumed the issues must be related.

If the --use-new-generator flag is only for the fromTemplate mode, how do I fix the generate problem?

The command should be asyncapi generate models golang --packageName=model my-asynapi-file.json -o model.go

[alsofr]

Thanks!, I was missing the "models" keyword! :)

[Shurtu-gal]

Closing this issue then. Feel free to open it and comment in case any thing is still unresolved.