Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/clue/graph-composer

Dependency graph visualization for composer.json (PHP + Composer)
https://github.com/clue/graph-composer

Last synced: 9 days ago
JSON representation

Dependency graph visualization for composer.json (PHP + Composer)

Awesome Lists containing this project

README 

        
# clue/graph-composer



[![CI status](https://github.com/clue/graph-composer/workflows/CI/badge.svg)](https://github.com/clue/graph-composer/actions)

[![downloads on GitHub](https://img.shields.io/github/downloads/clue/graph-composer/total?color=blue&label=downloads%20on%20GitHub)](https://github.com/clue/graph-composer/releases)

[![installs on Packagist](https://img.shields.io/packagist/dt/clue/graph-composer?color=blue&label=installs%20on%20Packagist)](https://packagist.org/packages/clue/graph-composer)



Graph visualization for your project's `composer.json` and its dependencies:



![dependency graph for clue/graph-composer](https://cloud.githubusercontent.com/assets/776829/11199047/46dd4dd2-8cca-11e5-845f-cbe485764f56.png)



**Table of contents**



* [Usage](#usage)

  * [graph-composer show](#graph-composer-show)

  * [graph-composer export](#graph-composer-export)

* [Install](#install)

  * [As a phar (recommended)](#as-a-phar-recommended)

  * [Installation using Composer](#installation-using-composer)

* [Development](#development)

* [Tests](#tests)

* [License](#license)



## Usage



Once clue/graph-composer is [installed](#install), you can use it via command line like this.



### graph-composer show



The `show` command creates a dependency graph for the given project path and opens

the default desktop image viewer for you:



```bash

$ php graph-composer.phar show ~/path/to/your/project

```



*   It accepts an optional argument which is the path to your project directory or composer.json file

    (defaults to checking the current directory for a composer.json file).



*   You may optionally pass an `--format=[svg/svgz/png/jpeg/...]` option to set

    the image type (defaults to `svg`).



### graph-composer export



The `export` command works very much like the `show` command, but instead of opening your

default image viewer, it will write the resulting graph to STDOUT or into an image file:



```bash

$ php graph-composer.phar export ~/path/to/your/project

```



*   It accepts an optional argument which is the path to your project directory or composer.json file

    (defaults to checking the current directory for a composer.json file).



*   It accepts an additional optional argument which is the path to write the resulting image to.

    Its file extension

    also sets the image format (unless you also explicitly pass the `--format` option). Example call:



    ```bash

    $ php graph-composer.phar export ~/path/to/your/project export.png

    ```



    If this argument is not given, it defaults to writing to STDOUT, which may

    be useful for scripting purposes:



    ```bash

    $ php graph-composer.phar export ~/path/to/your/project | base64

    ```



*   You may optionally pass an `--format=[svg/svgz/png/jpeg/...]` option to set

    the image type (defaults to `svg`).



## Install



You can grab a copy of clue/graph-composer in either of the following ways.



This project aims to run on any platform and thus does not require any PHP

extensions and supports running on legacy PHP 5.3 through current PHP 8+.

It's *highly recommended to use the latest supported PHP version* for this project.



The graph drawing feature is powered by the excellent [GraphViz](https://www.graphviz.org)

software. This means you'll have to install GraphViz (`dot` executable).

The [Graphviz homepage](https://www.graphviz.org/download/) includes complete

installation instructions for most common platforms, users of Debian/Ubuntu-based

distributions may simply invoke:



```bash

$ sudo apt install graphviz

```



### As a phar (recommended)



Once you have PHP and GraphViz installed, you can simply download a pre-packaged

and ready-to-use version of this project as a Phar to any directory.

You can simply download the latest `graph-composer.phar` file from our

[releases page](https://github.com/clue/graph-composer/releases).

The [latest release](https://github.com/clue/graph-composer/releases/latest) can

always be downloaded like this:



```bash

$ curl -JOL https://clue.engineering/graph-composer-latest.phar

```



That's it already. Once downloaded, you can verify everything works by running this:



```bash

$ cd ~/Downloads

$ php graph-composer.phar --version

```



> If you prefer a global (system-wide) installation without having to type the `.phar` extension

each time, you may simply invoke:

> 

> ```bash

> $ chmod +x graph-composer.phar

> $ sudo mv graph-composer.phar /usr/local/bin/graph-composer

> ```

>

> You can verify everything works by running:

> 

> ```bash

> $ graph-composer --version

> ```



There's no separate `update` procedure, simply download the latest release again

and overwrite the existing phar.



### Installation using Composer



Alternatively, you can also install clue/graph-composer as part of your development dependencies.

You will likely want to use the `require-dev` section to exclude clue/graph-composer in your production environment.



This method also requires PHP 5.3+, GraphViz and, of course, Composer.



You can either modify your `composer.json` manually or run the following command to include the latest tagged release:



```bash

$ composer require --dev clue/graph-composer

```



Now you should be able to invoke the following command in your project root:



```bash

$ ./vendor/bin/graph-composer show

```



Alternatively, you can install this globally for your user by running:



```bash

$ composer global require clue/graph-composer

```



Now, assuming you have `~/.composer/vendor/bin` in your path, you can invoke the following command:



```bash

$ graph-composer show ~/path/to/your/project

```



> Note: You should only invoke and rely on the main graph-composer bin file.

Installing this project as a non-dev dependency in order to use its

source code as a library is *not supported*.



To update to the latest release, just run `composer update clue/graph-composer`.

If you installed it globally via composer you can run `composer global update clue/graph-composer` instead.



## Development



clue/graph-composer is an [open-source project](#license) and encourages everybody to

participate in its development.

You're interested in checking out how clue/graph-composer works under the hood and/or want

to contribute to the development of clue/graph-composer?

Then this section is for you!



The recommended way to install clue/graph-composer is to clone (or download) this repository

and use [Composer](https://getcomposer.org) to download its dependencies.

Therefore you'll need PHP, Composer, GraphViz, git and curl installed.

For example, on a recent Ubuntu/debian system, simply run:



```bash

$ sudo apt install php7.2-cli git curl graphviz



$ git clone https://github.com/clue/graph-composer.git

$ cd graph-composer



$ curl -s https://getcomposer.org/installer | php

$ sudo mv composer.phar /usr/local/bin/composer



$ composer install

```



You can now verify everything works by running clue/graph-composer like this:



```bash

$ php bin/graph-composer show

```



If you want to distribute clue/graph-composer as a single standalone release file, you may

compile the project into a single `graph-composer.phar` file like this:



```bash

$ composer build

```



> Note that compiling will temporarily install a copy of this project to the

  local `build/` directory and install all non-development dependencies

  for distribution. This should only take a second or two if you've previously

  installed its dependencies already.

  The build script optionally accepts the version number (`VERSION` env) and

  an output file name or will otherwise try to look up the last release tag,

  such as `graph-composer-1.0.0.phar`.



You can now verify the resulting `graph-composer.phar` file works by running it

like this:



```bash

$ ./graph-composer.phar --version

```



To update your development version to the latest version, just run this:



```bash

$ git pull

$ php composer.phar install

```



Made some changes to your local development version?



Make sure to let the world know! :shipit:

We welcome PRs and would love to hear from you!



Happy hacking!



## Tests



To run the test suite, you first need to clone this repo and then install all

dependencies [through Composer](https://getcomposer.org):



```bash

$ composer install

```



To run the test suite, go to the project root and run:



```bash

$ php vendor/bin/phpunit

```



## License



This project is released under the permissive [MIT license](LICENSE).



> Did you know that I offer custom development services and issuing invoices for

  sponsorships of releases and for contributions? Contact me (@clue) for details.