generator

generator copied to clipboard

Reason/Context

I was just writing an article where I wanted to briefly explain generator and its templates - I failed again. I'm also failing with it always when tweet about it, some generator or template features.

It is ok for projects like https://github.com/OpenAPITools/openapi-generator to call generator a generator because all is contained in a single repo/project

This is the legacy of our generator, in the past is was also a single project. Now "templates" are standalone projects.

maybe simplest would be generator -> generator-core 🤔 html-template -> html-generator any-template -> any-generator

(as a result, yes, it means renaming packages in npm)

Description

I like how yeoman explains what it is, that what we call "templates" are "generators" and what we call "generator" is "yeoman"

I like this because I also many times talk about html-template as "HTML generator" or "Docs generator".

While it is not a problem to rename html-template to html-generator, obviously it won't be easy to find a name for the generator. There was a good name, but is already taken (fluffy-robot) 😞 😆

What do you think?

Hmm... I think I am too biased to answer this since it makes perfect sense to me 😆However for those that do not know the concept of templates (you would have to dig into how the generator work) I can understand if we want to change it.

Therefore I am neither for or against it. Just be aware of the rework that has to be done in order to rename something like this. We are talking documentation, source code variables and structure, npm packages, etc.

This issue has been automatically marked as stale because it has not had recent activity :sleeping: It will be closed in 60 days if no further activity occurs. To unstale this issue, add a comment with detailed explanation. Thank you for your contributions :heart:

maybe simplest would be generator -> generator-core 🤔 html-template -> html-generator any-template -> any-generator

We could name the templates as schematics and leave the generator name :)

and how are schematics different from template? how will this improve the wording and explanation?

@magicmatatjahu

I thought you needed a synonym :trollface:

To be honest I have no problem with the name of the generator and with terms such as html generation (from template, not generator) etc. For others people, naming may be a problem, but for me, it's not. Let the others emerge.

This issue has been automatically marked as stale because it has not had recent activity :sleeping: It will be closed in 60 days if no further activity occurs. To unstale this issue, add a comment with detailed explanation. Thank you for your contributions :heart:

generator -> generator-core 🤔 html-template -> html-generator any-template -> any-generator

I quite like the rename to generator I think, I guess the generator > template isn't too much of a hurdle, but I'm just used to generator wording.

The descriptions for each template say Generates which I guess generator would make more sense?

But as I said not the end of the world, just another hurdle I have to process to initially understand how generator > templates work, think for me anyway generators would make more sense...

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

@fmvilas only your opinion is missing. If all codeowners are fine, we could query community

I'd not call them "generators". The tool is also called Generator. Are we going to compose sentences like "Use this generator with Generator"? Or another option is that we change the name of tool as well.

they are not called generators, so you would write not Use this generator with Generator but use Node JS Generator either with AsyncAPI CLI or in case of a library, use generator-core library.

So you will say To generate the code in terminal or CI/CD use NodeJS Generator with AsyncAPI CLI. In case you want to do it in a runtime or integrate with your library, use generator-core library

Alrighty, sounds good 👍

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

yeah, I do not like the name but I do not think the final idea got much attention, we probably have to give it time