README

Xeed generates new model, seed, Nova resources, database seed, factory and migration files for Laravel & Nova based on data from the existing database table.

Why Xeed?

Laravel already has migrations and factories, but:

• It cannot reverse-engineer existing databases
• It is repetitive for legacy projects
• Nova resources are manual and slow to maintain

Xeed solves this by generating everything from your real schema.

Tip

It can function as both php artisan xeed:* commands for Laravel & Nova providing 100% identical functionality. Therefore, you can use it within your own Laravel & Nova project.

We have provided the API Documentation on the web. For more information, please visit https://www.palgle.com/xeed/ ❤️

Features

• Database testing is supported
• Generate models for Laravel
• Generate seed files for Laravel
• Generate Nova resources files for Laravel Nova
• Generate database seed files for Laravel
• Generate factories for Laravel
• Generate migrations for Laravel
• Generate belongsTo and hasMany relationships functions for Laravel
• Laravel multi & reserved columns supported
• Laravel integration
• MySQL, SQLite and PostgreSQL supported

Support & Tested

Preview

Installation

composer require cable8mm/xeed --dev

Usage

All commands use the current database connection to generate files automatically.

Global options:

-f Force overwrite existing files

Generators

Models:

# Generate all models from database in `app/Models` folder
php artisan xeed:model

php artisan xeed:model -f

Factories:

# Generate all factories from database in `database/factories' folder
php artisan xeed:factory

Seeders:

# Generate all seeds from database in `database/seeders` folder
php artisan xeed:seeder

# Generate all seeds from database in `database/seeders` folder
php artisan xeed:faker-seeder

Migrations:

# Generate a database seed from database in `database/seeders` folder
php artisan xeed:database

Migrations:

# Generate all migrations from database in `database/migrations' folder
php artisan xeed:migration

Relations:

xeed:relation updates existing models, so generate models first if they do not already exist.

# Add relation functions to existing models in `app/Models` folder
php artisan xeed:relation

# Force overwrite existing model files while adding relation functions
php artisan xeed:relation -f

Nova:

# Add the Laravel Nova resources to all tables in `app/Nova` folder
php artisan xeed:nova

Cleanup:

# Clean generated files, seeders, models, factories and migration files.
php artisan xeed:wipe

Formatting

# Modify all files to comply with the PSR-12.
composer lint

# Inspect all files to ensure compliance with PSR-12.
composer inspect

Testing

Xeed uses an isolated SQLite database during tests, ensuring your real database is never affected. The test bootstrap recreates tests/Generate/database.sqlite when needed and loads the xeeds table automatically from database/xeeds.sqlite.sql.

# Run `vendor/bin/testbench package:test tests`
composer testpack

# Run `vendor/bin/phpunit tests`
composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

The below can help you contribute.

The Xeed has a built-in SQLite database, allowing you to contribute easily without needing your own database. Simply create a new file for testing purposes and utilize it. You do not need to commit tests/Generate/database.sqlite; the test bootstrap recreates it automatically when you run the test suite.

# Create a new empty file for SQLite database
touch tests/Generate/database.sqlite

And then,

# Run tests
composer test

Database seeds

For migrations and factories, when you need to execute tests for all database field types, utilize the following command.

# Import an 'xeeds' Table into the Database
php artisan xeed

# Drop the 'xeeds' Table from the Database
php artisan xeed drop

Utilize migration files for all database field types by referring to the following location database/*.sql these files are saved in the specified folder.

Use testorchestral/testbench

You can utilize testorchestral/testbench to execute tests. When running Laravel commands, the generated files are saved in the vendor/orchestra/testbench-core/laravel/database folder.

Resources

Laravel columns description for mysql:

Code of Conduct

In order to ensure that the community is welcoming to all, please review and abide by the CODE OF CONDUCT.

Credits

• Samgu Lee

License

The Xeed project is open-sourced software licensed under the MIT license.