Code Outliner
Generate outline images of your code
#Create a visual representation of your code
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.
#Support us
We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.
#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.
#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.
#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've found a bug regarding security please mail security@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, Kruikstraat 22, 2018 Antwerp, Belgium.
We publish all received postcards on our company website.
#Credits
#License
The MIT License (MIT). Please see License File for more information.