schickling / laravel-schema-summary by schickling

Creates a summary file of all migrations
25
2
2
Package Data
Maintainer Username: schickling
Maintainer Contact: schickling.j@gmail.com (Johannes Schickling)
Package Create Date: 2014-05-14
Package Last Update: 2014-05-15
License: MIT
Last Refreshed: 2024-11-23 03:15:56
Package Statistics
Total Downloads: 25
Monthly Downloads: 0
Daily Downloads: 0
Total Stars: 2
Total Watchers: 2
Total Forks: 0
Total Open Issues: 1

laravel-schema-summary

Creates a summary file of all migrations. This package is inspired by the schema.rb file of Active Record Migrations.

Installation

  1. Add the following to your composer.json and run composer update

    {
        "require": {
            "schickling/laravel-schema-summary": "dev-master"
        }
    }
    
  2. Add Schickling\SchemaSummary\SchemaSummaryServiceProvider to your config/app.php

Usage

The following command creates a Schema.md file in your app/database directory which contains a summary of all migrations. This summary can be understood as one big migration for documentation purposes.

$ php artisan migrate:schema

Example Output

users

Field | Type | Length | Unsigned | Default --- | --- | --- | --- | --- id | INT | 10 | yes | name | VARCHAR | 128 (default) | |

photos

Field | Type | Length | Unsigned | Default --- | --- | --- | --- | --- id | INT | 10 | yes | user_id | INT | 10 | yes | 0 url | VARCHAR | 128 (default) | |