fix: issue with not reading spec file in working directory when no global context is created

[Souvikns]

…obal context is set.

Description

• Fixed issue with not reading spec file in the working directory when global context file is not created.

Related issue(s)

Fixes #35

[derberg]

Works like a charm mate, but we need to put more power into developer experience

[derberg]

We need to do better here. User, when running asyncapi validate most probably do not have an idea about all our options, defaults, and way we load files, priorities - we need to make it clear. Good help messages are a key for good developer experience.

how about? 👇🏼

Suggested change

export const NO_SPEC_PATH_FOUND = 'No spec path found in your working directory, please use flags or store a context';

export const NO_SPEC_FOUND = 'Unable to perform validation. Specify what AsyncAPI file should be validated.\n\nThese are your options to specify in the CLI what AsyncAPI file should be used:\n- You can use --file flag to provide a path to the AsyncAPI file: asyncapi validate --file path/to/file/asyncapi.yml\n- You can use --context flag to provide a name of the context that points to your AsyncAPI file: asyncapi validate --context mycontext\n- In case you did not specify a context that you want to use, the CLI checks if there is a default context and uses it. To set default context run: asyncapi context use mycontext\n- In case you did not provide any reference to AsyncAPI file and there is no default context, the CLI detects if in your current working directory you have files like asyncapi.json, asyncapi.yaml, asyncapi.yml. Just rename your file accordingly.';

Now, above is just a suggestion of how message should be printed, but from code perspective it should be splitted

Part Unable to perform validation. Specify what AsyncAPI file should be validated. should be only in context of asyncapi validation and the rest of the message should be reusable. Why reusable? because it will be always used in other commands when the same error will happen that there is no file specified, when we will have command asyncapi optimize it will be the same. So you need to make sure that examples that I provided in the message are customizable, in context of validation user see asyncapi validate --file path/to/file/asyncapi.yml, but in context of optimization user will see asyncapi optimize --file path/to/file/asyncapi.yml

[derberg]

@Souvikns please have a look at my comments again, I suggested that part of the message must be reusable and things like asyncapi validate cannot be hardcoded

[Souvikns]

@derberg I took an approach to make the message reusable, let me know if this works or if we should take a different approach.

Looking at the message I would see only the name of the command in the example is dynamic. Suppose I am using the validate command and this error is thrown then the message will have asyncapi validate --file path/to/file/asyncapi.yml, on the contrary if I am using the optimize command then asyncapi optimize --file path/to/file/asyncapi.yml will be printed.

So basically we could pass a command parameter to the NoSpecPathFoundError to be used in the NO_SPEC_FOUND message. But then we needed to somehow access the command in run time. For that, I created a class to access the command name being used.

import meow from 'meow';
import { injectable } from 'tsyringe';

injectable();
export class CLIService {
  private _cli = meow('', { argv: process.argv.slice(2), autoHelp: false })

  command(): string {
    return this._cli.input[0] || '';
  }

  args(): any {
    return this._cli.flags;
  }
}

[derberg]

NO_SPEC_FOUND has this part "hardcoded" to validation -> Unable to perform validation. Specify what AsyncAPI file should be validated

I won't be able to reuse it with optimize or other new commands, or? I think this part should be separated

[Souvikns]

maybe we can make an object which stores all these fallback messages and after we determine which command was used print them accordingly.

[derberg]

Can't we just split NO_SPEC_FOUND into NO_SPEC_FOUND and VALIDATION_NO_SPEC_FOUND and in context of validation, concat both and in case of optimization have OPTIMIZE_NO_SPEC_FOUND? later once more come and it gets cumbersome we refactor

[Souvikns]

If we divide the complete message then Unable to perform validation. Specify what AsyncAPI file should be validated. part will be different for every command.

- You can use --file flag to provide a path to the AsyncAPI file: asyncapi validate --file path/to/file/asyncapi.yml
- You can use --context flag to provide a name of the context that points to your AsyncAPI file: asyncapi validate --context mycontext
- In case you did not specify a context that you want to use, the CLI checks if there is a default context and uses it. To set default context run: asyncapi context 
use mycontext
- In case you did not provide any reference to AsyncAPI file and there is no default context, the CLI detects if in your current working directory you have files    
like asyncapi.json, asyncapi.yaml, asyncapi.yml. Just rename your file accordingly.

We can split them and then connect them in the error to use accordingly.

[derberg]

exactly, split and then reuse together or in different configurations

[derberg]

Great work!

[asyncapi-bot]

🎉 This PR is included in version 0.3.3 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀