https://github.com/oncarrot/composer-summary

Automatically document your composer dependencies
https://github.com/oncarrot/composer-summary

composer

Last synced: about 1 month ago
JSON representation

Automatically document your composer dependencies

• Host: GitHub
• URL: https://github.com/oncarrot/composer-summary
• Owner: oncarrot
• License: mit
• Created: 2019-12-05T18:48:01.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-08-02T02:00:47.000Z (5 months ago)
• Last Synced: 2024-08-03T13:04:28.268Z (5 months ago)
• Topics: composer
• Language: Ruby
• Homepage:
• Size: 68.4 KB
• Stars: 9
• Watchers: 8
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# composer-summary

Zero-friction tool to document your composer dependencies. 

```json

{

  "require": {

    "laravel/framework": "5.2.*"

  },

  "require-dev": {

    "phpunit/phpunit": "~4.0"

  }

}

```

`composer-summary composer.json` ⬇️

![ayy](./demo/ayy.png)

* * *

**This is a prototype: please check [this milestone](https://github.com/oncarrot/composer-summary/milestone/1)**

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+).

```bash

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

cd composer-summary

make install

```

```bash

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`