Generating docs failes if project is a git repository.

[Souvikns]

Describe the bug

Generating docs is automatic in Glee, but it fails when the project is a git repository. Also, I would want to have no errors right after I create a glee project.

x "/Users/postman/Documents/Programs/Learning/greet-bot/docs" is in a git repository with unstaged changes. Please commit your changes before proceeding or add proper directory to .gitignore file. You can also use the --force-write flag to skip this rule (not recommended).
    at Generator.verifyTargetDir (/Users/postman/Documents/Programs/Learning/greet-bot/node_modules/@asyncapi/generator/lib/generator.js:846:71)
    at async Generator.generate (/Users/postman/Documents/Programs/Learning/greet-bot/node_modules/@asyncapi/generator/lib/generator.js:173:29)

How to Reproduce

To reproduce the bug make sure the project is a glee repository, and just run

npm run start

Expected behavior

It should create the docs even if my project is a Git repository, and by default I should not see any error logs when I create a new project.

[rukundob451]

@Souvikns, I have taken note of the issue when generating the documentation fails when the project is a Git repository with unstaged changes in the /Users/postman/Documents/Programs/Learning/greet-bot/docs directory and currently looking into it.

[Souvikns]

@rukundob451 do you need any help with this issue, according to the generator docs we can pass forcreWrite as true in

glee/src/lib/docs.ts

Line 10 in 69e5b90

const generator = new Generator(

I think this flag was done so that generator does not accidentally rewrite the code, but in our case, we are generating docs which is not a problem if it is re-written.

[rukundob451]

Hey @Souvikns, yes needed some help with this!

[Souvikns]

Let me know, how I can help you.

[Souvikns]

@rukundob451 are you working on this, or should I put this issue up for hacktoberfest?

[Souvikns]

I think no one is working on this currently so this Issue is open for hacktoberfest.

[ankur0904]

@Souvikns I want to work on this issue.

[Souvikns]

sure @ankur0904 go ahead.

[freakfan15]

hey @Souvikns, I think no one is working on this, and I understand what to do here. Can I take this up?

[asyncapi-bot]

🎉 This issue has been resolved in version 0.28.1 🎉

The release is available on:

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

Your semantic-release bot 📦🚀