README

This package is designed to automatically generate TypeScript interfaces from your Laravel models. It supports generating interfaces based on either model fillables or database migrations, it will also try to include relationships by analysing your model methods.

Note: This package has been primarily tested with MySQL. SQLite and other drivers are a work in progress.

Features

• Interface Generation: Automatically generate TypeScript interfaces from Laravel
  • Generates interfaces from your model's fillable attributes or from your model's database migration.
• Relationship Detection: Automatically includes relationships in your interfaces.
  • With the ability to disable this feature.
  • Currently working with:
    • HasOne
    • HasMany
    • BelongsTo
    • BelongsToMany
    • MorphMany
    • MorphTo
• Customisable Suffix: Ability to customise or remove a suffix to each interface.
• Model Targeting: Ability to generate interfaces on all or specific models.

Installation

Install the package via Composer:

composer require mpstr24/laravel-interface-typer

Usage/Examples

Basic usage. Run the following to generate interfaces from your migrations with the default suffix "Interface":

php artisan generate:interfaces

Mode Options

You can choose between generating interfaces from migrations or fillables using the --mode (or -M) option.

• Fillables Mode:

php artisan generate:interfaces --mode=fillables

• Migrations Mode:

php artisan generate:interfaces --mode=migrations

Suffix Options

Customise the suffix added to your generated interface names using the --suffix (or -S) option.

• Custom Suffix (default "Interface"):

php artisan generate:interfaces --suffix=Interface

• No Suffix:

php artisan generate:interfaces --suffix=

Model Selection

To generate an interface for a specific model, please use the --model option. If not used or set to all, all models within the "app/Models" directory will be generated.

• Specific Model

php artisan generate:interfaces --model=TestUser

• All Models

php artisan generate:interfaces --model=all

Or alternatively.

php artisan generate:interfaces

Relationship Toggling

You may not want to always generate relationships in your interfaces, to turn this off please use --relationships=False.

• Relationships enabled (leave blank or set "True")

php artisan generate:interfaces --relationships=True

• Relationships disabled

php artisan generate:interfaces --relationships=False

Or alternatively.

php artisan generate:interfaces

Roadmap

• Better Model discovery
• Better relationship discovery
• Finalising unknown types within mapping
• Adding of morphTo
• Configuration file for wider and customisable default settings
• Interface export options
• Testing to be implemented
• Testing to be improved
• SQLite testing
• Mapping separation for separate DB drivers
• Finish remaining relationship types
  • HasOneThrough
  • HasManyThrough
  • MorphOne
  • MorphToMany
  • MorphedByMany
• Larastan goals
  • 5
  • 6
  • 7
  • 8
  • 9

License

MIT