composer-summary

Zero-friction tool to document your composer dependencies.

{ "require": { "laravel/framework": "5.2.*" }, "require-dev": { "phpunit/phpunit": "~4.0" } }

composer-summary composer.json ⬇️

---

This is a prototype: please check this milestone

This is currently just a quick sketch I did in Ruby. We probably have to rewrite this in PHP and make it installable via Composer as a require-dev dep.
—Austin

---

Usage

This isn't published on a package registry yet or anything so feel free to just clone the repo and install it as a gem. It requires a somewhat modern version of Ruby (2.5+).

git clone https://github.com/oncarrot/composer-summary.git
cd composer-summary
make install

composer-summary --help

# will generate path/to/your/composer.md
composer-summary path/to/your/composer.json

# generate a markdown file somewhere else
composer-summary path/to/your/composer.json path/to/your/docs/muh-composer-deps.md

If you hate it just uninstall it gem uninstall composer-summary

Development

Run the tests with make test