chore(tooling): generation script for all language and clients APIC-221 #32
Conversation
package.json Outdated
| "generate:recommend": "yarn generate:js:recommend", | ||
| "generate:search": "yarn generate:js:search", | ||
| "generate": "yarn generate:js && yarn format:specs", | ||
| "generate": "./scripts/generate.sh ${1:-all} ${2:-all} && yarn format:specs", |
There was a problem hiding this comment.
yarn format:specs could maybe be a post-gen/global.sh script or something? We might have other post gen script related to the specs etc. later.
It might also be a good thing to add a pre-gen like in the CI, to build and validate the specs before generating, wdyt?
package.json Outdated
| "generate:recommend": "yarn generate:js:recommend", | ||
| "generate:search": "yarn generate:js:search", | ||
| "generate": "yarn generate:js && yarn format:specs", | ||
| "lint:specs:fix": "yarn prettier --write specs", |
There was a problem hiding this comment.
Prettier is a formatter hence the format instead of lint but I don't have a strong opinion
scripts/generate.sh Outdated
| local lang=$1 | ||
| local client=$2 | ||
| echo "Generating code for ${lang}-${client}" | ||
| yarn openapi-generator-cli generate --generator-key "${lang}-${client}" |
There was a problem hiding this comment.
Can we maybe silence the output of the command? I wonder if it's possible to do it only if it succeed
There was a problem hiding this comment.
You want to silence the openapi-generator-cli part ?
There was a problem hiding this comment.
Mostly wondering if we can silent unless it fails 🤔
scripts/generate.sh Outdated
| echo "Generating code for ${lang}-${client}" | ||
| yarn openapi-generator-cli generate --generator-key "${lang}-${client}" | ||
| | ||
| # run the post generation script if it exists (linting and additional files) |
There was a problem hiding this comment.
We will need to mention this part in our contribution guide
2 participants
🧭 What and Why
🎟 JIRA Ticket: APIC-221
Generation script to ease tooling and not bloat the
package.json.Support multi-languages, multi-clients, and post-generation-script.
Changes included:
generate.shpackage.json, exceptgenerateformat:specfrom the generation🧪 Test
yarn generate