nicoalbanese / kirimase

Build full-stack Next.js apps, incredibly fast
https://kirimase.dev
MIT License
2.37k stars 107 forks source link

Add option to load schemas from file in generate command #160

Open akmalmzamri opened 3 months ago

akmalmzamri commented 3 months ago

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 schemas

Sample usage

kirimase generate -f <path-to-schema.json>

Notable changes

Input sample

Here's a sample of a valid schema.json (basically the shape of Schema)

[
  {
    "tableName": "products",
    "fields": [
      { "name": "name", "type": "varchar", "notNull": true },
      { "name": "price", "type": "number", "notNull": true }
    ],
    "index": "name",
    "belongsToUser": false,
    "includeTimestamps": true,
    "children": []
  }
]

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

[
  {
    "message": "Field name must be in snake_case if more than one word.",
    "field": "fields.0.name",
    "tableName": "products.product_discounts.product_discount_analytics"
  },
  {
    "message": "Table name must be in snake_case if more than one word, and plural.",
    "field": "tableName",
    "tableName": "products.productReviews"
  }
]

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

flipvh commented 1 month ago

this is pretty great @akmalmzamri ! I am also interested in this for a project of mine, perhaps we can connect if you are also still interested in this? Can you send me a dm on twitter or an email flip[@]shareworks.nl? cheers Flip