generators

Psychic provides several generators for quickly building scaffolding for your app.

# generate migration
yarn psy g:migration add-deleted-at-to-posts

# generate a model, serializer, and migration
yarn psy g:model User email:string

# generate an STI child model, serializer, and migration
yarn psy g:sti-child Foo/Bar extends Foo/Base hello:string

# generate a controller
yarn psy g:controller api/v1/users  create update destroy

# generate a serializer
yarn psy g:serializer User email:string id:string

# generate a model, serializer, migration, and controller and,
# provided your app is not api-only, a client api module
yarn psy g:resource api/v1/users User email:string

Supported model generator data types

integers, strings, and text

yarn psy g:model Post rating:integer title:string body:text

dates and datetimes

yarn psy g:model Post publish_at:datetime last_updated_on:date

decimals

The format for decimal is <column>:decimal:<total-digits>,<digits-after-decimal-point>

yarn psy g:model Weight grams:decimal:9,2
# "grams" can have up to 9 digits, with two digits to the right of the decimal point, e.g. 1234567.89

enums

The format for enum is <column>:enum:<enum-name>:<comma-separated-list-of-enum-values>

yarn psy g:model Weight unit:enum:weight_units:gram,kilogram,ounce,pound
# this will create a WeightUnits TypeScript type = 'gram' | 'kilogram' | 'ounce' | 'pound'
# and will create restrict what can be stored in "unit" to one of these values

While values cannot be removed once added to an enum, values can easily be added to an enum in a migration like this:

await sql`
    ALTER TYPE weight_units ADD VALUE IF NOT EXISTS 'stone';
  `.execute(db)

BelongsTo associations

The belongs_to type creates a column with a foreign key reference based on Dream conventions (e.g. user_id pointing to the id column of the users table). You can change this manually in the migration file. The generator also adds the BelongsTo decorator to the resulting model file.

yarn psy g:model Post user:belongs_to

// the optional modifier alters both the migration and the BelongsTo association in the model
yarn psy g:model Post user:belongs_to:optional