yanzhen0610/laravel-schema-markdown

Make descriptions of schema with markdown for Laravel migrations.

1.4.5 2020-02-23 04:39 UTC

Requires

• doctrine/dbal: ^2.5.0
• laravel/framework: ^5.1

Requires (Dev)

• mockery/mockery: ^1.3
• phpunit/phpunit: ^9

MIT

• Yz.

• database
• migrations
• library
• mysql
• schema
• markdown
• sqlite
• command
• laravel
• artisan

README

Install

composer require --dev yanzhen0610/laravel-schema-markdown

Run

In your Laravel project root

php artisan make:schema-md

and the schema description will be generated at ./schema.md.

Usage

$ php artisan make:schema-md --help

Description:
  Make a markdown documentations of migration files

Usage:
  make:schema-md [options]

Options:
      --force                Force the operation to run when in production
      --database[=DATABASE]  The database connection to use [default: "schema-markdown"]
      --path[=PATH]          The path(s) to the migrations files to be executed (multiple values allowed)
      --realpath             Indicate any provided migration file paths are pre-resolved absolute paths
      --step                 Force the migrations to be run so they can be rolled back individually
  -o, --output[=OUTPUT]      The output path for the generated markdown [default: "./schema.md"]
  -h, --help                 Display this help message
  -q, --quiet                Do not output any message
  -V, --version              Display this application version
      --ansi                 Force ANSI output
      --no-ansi              Disable ANSI output
  -n, --no-interaction       Do not ask any interactive question
      --env[=ENV]            The environment the command should run under
  -v|vv|vvv, --verbose       Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Example

schema.example.md (From ladybirdweb/faveo-helpdesk)