{"id":17606306,"url":"https://github.com/noamt/sequelize-migsplainer","last_synced_at":"2025-03-29T23:16:05.487Z","repository":{"id":49242120,"uuid":"309377238","full_name":"noamt/sequelize-migsplainer","owner":"noamt","description":"Translate DB migrations into human speak","archived":false,"fork":false,"pushed_at":"2021-06-22T08:33:29.000Z","size":859,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-03-08T20:02:35.845Z","etag":null,"topics":["reporting","sequelize","sequelize-migrations"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/noamt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-11-02T13:24:08.000Z","updated_at":"2021-06-22T08:33:29.000Z","dependencies_parsed_at":"2022-07-25T22:33:06.238Z","dependency_job_id":null,"html_url":"https://github.com/noamt/sequelize-migsplainer","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noamt%2Fsequelize-migsplainer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noamt%2Fsequelize-migsplainer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noamt%2Fsequelize-migsplainer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noamt%2Fsequelize-migsplainer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/noamt","download_url":"https://codeload.github.com/noamt/sequelize-migsplainer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246254146,"owners_count":20747949,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["reporting","sequelize","sequelize-migrations"],"created_at":"2024-10-22T15:44:12.738Z","updated_at":"2025-03-29T23:16:05.464Z","avatar_url":"https://github.com/noamt.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sequelize Migration Explainer\n\nTranslates database migration files into human speak.\n\n![build](https://github.com/noamt/sequelize-migsplainer/workflows/test-and-lint/badge.svg)\n![build](https://img.shields.io/badge/npm-v0.0.2-blue)\n[![codecov](https://codecov.io/gh/noamt/sequelize-migsplainer/branch/main/graph/badge.svg?token=3e3jFHsQRr)](https://codecov.io/gh/noamt/sequelize-migsplainer)\n\n## About\nWhile managing migration-as-code using [sequelize-auto-migrations](https://www.npmjs.com/package/sequelize-auto-migrations), I wanted to also be able to describe the evolution of the database in a more natural language.\n\nThis tool reads migration files and produces an HTML report where each migration operation is converted to an explanation in English.\n\n## Installation\n```bash\nnpm i sequelize-migsplainer -g\n```\n\n## Usage\n\nFrom your project's root directory run:\n```bash\nmigsplain --migrations relative/path/to/migrations/\n```\n\nThis will produce a report based on the migration files found in `relative/path/to/migrations/` and save it to `output/migrations.html`.\n\nThe location of the output file can be controlled using the `--output` switch:\n\n```bash\nmigsplain --migrations relative/path/to/migrations/ --output /some/other/path.html\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnoamt%2Fsequelize-migsplainer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnoamt%2Fsequelize-migsplainer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnoamt%2Fsequelize-migsplainer/lists"}