sequelize-migsplainer v0.0.2

Sequelize Migration Explainer

Translates database migration files into human speak.

About

While managing migration-as-code using sequelize-auto-migrations, I wanted to also be able to describe the evolution of the database in a more natural language.

This tool reads migration files and produces an HTML report where each migration operation is converted to an explanation in English.

Installation

npm i sequelize-migsplainer -g

Usage

From your project's root directory run:

migsplain --migrations relative/path/to/migrations/

This will produce a report based on the migration files found in relative/path/to/migrations/ and save it to output/migrations.html.

The location of the output file can be controlled using the --output switch:

migsplain --migrations relative/path/to/migrations/ --output /some/other/path.html