Have ideas to improve npm?Join in the discussion! »

    pg-generator-example
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.0 • Public • Published

    pg-generator-example

    Example plugin for pg-generator, that creates model files for several ORMs and other purposes.

    Installation

    npm install pg-generator-example

    Synopsis

    $ pgen example --out-dir models --clear --relation-name-functions optimal"
    $ pgen example:sequelize6 --out-dir models --clear --relation-name-functions optimal"
    $ pgen example:objection2 --out-dir models --clear --relation-name-functions optimal"
    $ pgen example:schwifty5 --out-dir models --clear --relation-name-functions optimal"
    $ pgen example:md --out-dir db-docs --clear --relation-name-functions optimal"

    Details

    This is a pg-generator plugin to provide example generators and templates for tutorial purposes. Use it via pg-generator.

    Available Examples

    As indicated following generators are just examples to help you to build yours. Besides personal opinions, every ORM requires careful practices. As a result, we can't maintain ORM codes we are not using. Therefore, see them as a good effort. Even they are not guaranteed to work with current versions of the respective ORM library.

    Name Description
    app Example of composability.
    md Example of how to create database documentation in markdown.
    objection2 Example of model files for objection ORM.
    report Example of a simple report of the database.
    schwifty Example of model files for schwifty ORM.
    sequelize6 Example of model files for sequelize ORM.
    tutorial Example of how to create your generators.

    Install

    npm i pg-generator-example

    DownloadsWeekly Downloads

    4

    Version

    1.0.0

    License

    MIT

    Unpacked Size

    258 kB

    Total Files

    113

    Last publish

    Collaborators

    • avatar