feat: fixed data tags, description preset for Go, add goIncludeComments and goIncludeTags flags #2123
Conversation
TertiumOrganum1
requested review from
magicmatatjahu,
jonaslagoni,
kennethaasan and
asyncapi-bot-eve
as code owners
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide 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.
✅ Deploy Preview for modelina canceled.
|
jonaslagoni
changed the title
jonaslagoni
changed the title
There was a problem hiding this comment.
Remember to add the new feature to the Go documentation https://github.com/TertiumOrganum1/modelina/blob/next/docs/languages/Go.md you can just use this as guideline: https://github.com/TertiumOrganum1/modelina/blob/next/docs/languages/TypeScript.md#rendering-comments-from-description-and-example-fields
We also need a single test ensuring that the preset works as expected, just take the one from TypeScript and change it to use Go 🙂 https://github.com/TertiumOrganum1/modelina/blob/next/test/generators/typescript/preset/DescriptionPreset.spec.ts
| `${this.model.name} represents a ${this.model.name} model.` | ||
| ); | ||
|
|
||
| const doc = ''; |
There was a problem hiding this comment.
You can remove it completely if it's no longer in use 🙂
…est for go description, removed previously added -i flag, removed unused code and fixed formatting, added modelina_cli/test/fixtures/generate to linter exclusions
Sorry, I don't understand what it wants from me. What does it mean by duplication? Take a look at go examples - they have the same index.spec.ts! But my test is 'duplicated'? |
|
TertiumOrganum1
changed the title
|
/rtm |
|
|
/ptal @jonaslagoni Hi, please advise what to do with my PR here. It didn't pass tests as modelina-cli uses modelina as npm package, but I've fixed both. Locally it all works but not in your CI. So should we split it into two PRs? If fix to modelina will be merged, how long should we wait to make PR to modelina-cli? Or maybe there is a way to disable some checks on this particular PR? How do you make changes in modelina&cli anyways? npm dependency makes them impossible |
|
@kennethaasan @magicmatatjahu Please take a look at this PR. Thanks! 👋 |
Yea, you right, completely forgot about that... Split it up and as soon as it's released we can merge the CLI changes 🙂 |
Description
Anyway, I've managed to fix the Golang generator: I added comments from descriptions, enabled them in the Go helper, fixed the data tags by adding "required", added a flag to include comments in Go, and included the description preset in modelina-cli. I'm not sure why, but modelina-cli refused to accept the file parameter from the command line (even after packing it into a tarball), so I had to add an optional -i flag to specify the input path.
Related Issue
[FEATURE] Golang generator should include comments from parameter descriptions #2116
Checklist
npm run lint): yes, but two prettier issues are in conflict with default vscode ts formatter, so I left as is.npm run test): not yetAdditional Notes
I haven't been able to build the CLI correctly yet: it can't use the modelina library directly from the source (or via npm link). Therefore, I had to run npm run build:prod for modelina, copy its lib folder to the modelina-cli node_modules directory (after the initial npm install), and only then was I able to build modelina-cli and run it. Any advice on how to do this correctly would be appreciated. For now, I'll create a PR just for you to take a look.