spatie/code-outliner

Generate outline images of your code

0.1.3 2018-08-06 07:08 UTC

README

Latest Version Quality Score StyleCI Total Downloads

You're reading code on a daily basis, code should be optimised for that. This tool helps you visualise how the code in your project looks, and might be a trigger to better structure your files.

More information about the visual perception of code here: https://www.stitcher.io/blog/visual-perception-of-code.

Installation

spatie/browsershot is required to generate images. Please refer to the Browsershot documentation for all details, most important is to install puppeteer.

npm install puppeteer --global

You can install the package via composer:

composer global require spatie/code-outliner

Usage

code-outliner <file> [--output=] [--extensions=]

Outlining a single file

Pass a single file to the command, and you'll get output like this.

Outline of a single file

Overlaying multiple files

Pass a directory path to the command, and it'll overlay all files on top of each other. The darker areas represent areas where there's more code across all files.

Outline of multiple files

Filtering extensions

By default, PHP files will be scanned. You're able to specify other and multiple extensions with the --extensions option.

code-outliner --extensions="html,twig"

Security

If you discover any security related issues, please email freek@spatie.be instead of using the issue tracker.

Postcardware

You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.

Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium.

We publish all received postcards on our company website.

Credits

Support us

Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.

Does your business depend on our contributions? Reach out and support us on Patreon. All pledges will be dedicated to allocating workforce on maintenance and new awesome stuff.

License

The MIT License (MIT). Please see License File for more information.