Add option to load schemas from file in generate command #160
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Background
This PR will allow users to load schemas from a JSON file when running
generate
command, hence skipping the manual data entry. This will make it easy to move from one project to another that has shared schemasSample usage
Notable changes
-f, --from-file
togenerate
commandsrc/types.d.ts
tosrc/utils.ts
so it can be reused in schema validationbuildSchema
will process array of schemas instead of a single one. ThegenerateResources
will process the schema array one by oneprintGenerateNextSteps
function now process schema array. The output is updated accordinglyInput sample
Here's a sample of a valid
schema.json
(basically the shape ofSchema
)Validation
This PR also comes with the necessary validation such as requiring the table name to be snakeCase. The validation is done by Zod. If errors are present in the schema, Kirimase will stop the execution and log the errors appropriately, such as
Note on using Zod
Since strict mode is not enabled in this project, we will not be able to fully utilize Zod, such as type inferring