2017 © Pedro Peláez
 

library code-outliner

Generate outline images of your code

image

spatie/code-outliner

Generate outline images of your code

  • Tuesday, July 24, 2018
  • by Spatie
  • Repository
  • 4 Watchers
  • 34 Stars
  • 10 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 1 Forks
  • 4 Open issues
  • 11 Versions
  • 0 % Grown

The README.md

, (*1)

Create a visual representation of your code

Latest Version Quality Score StyleCI Total Downloads, (*2)

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., (*3)

More information about the visual perception of code here: https://www.stitcher.io/blog/visual-perception-of-code., (*4)

Support us

, (*5)

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., (*6)

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., (*7)

Installation

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

npm install puppeteer --global

You can install the package via composer:, (*9)

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., (*10)

Outline of a single file, (*11)

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., (*12)

Outline of multiple files, (*13)

Filtering extensions

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

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., (*15)

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., (*16)

Our address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium., (*17)

We publish all received postcards on our company website., (*18)

Credits

License

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

The Versions

24/07 2018

dev-oo-refactor

dev-oo-refactor https://github.com/spatie/code-outliner

Generate outline images of your code

  Sources   Download

MIT

The Requires

 

The Development Requires

by Brent Roose

spatie code-outliner

24/07 2018

dev-analysis-zGZP7r

dev-analysis-zGZP7r https://github.com/spatie/code-outliner

Generate outline images of your code

  Sources   Download

MIT

The Requires

 

The Development Requires

by Brent Roose

spatie code-outliner

24/07 2018

dev-analysis-zel0DA

dev-analysis-zel0DA https://github.com/spatie/code-outliner

Generate outline images of your code

  Sources   Download

MIT

The Requires

 

The Development Requires

by Brent Roose

spatie code-outliner

23/07 2018

dev-analysis-X0xERW

dev-analysis-X0xERW https://github.com/spatie/code-outliner

Generate outline images of your code

  Sources   Download

MIT

The Requires

 

The Development Requires

by Brent Roose

spatie code-outliner

23/07 2018

dev-analysis-zelVEP

dev-analysis-zelVEP https://github.com/spatie/code-outliner

Generate outline images of your code

  Sources   Download

MIT

The Requires

 

The Development Requires

by Brent Roose

spatie code-outliner

23/07 2018

dev-analysis-zY5rn9

dev-analysis-zY5rn9 https://github.com/spatie/code-outliner

Generate outline images of your code

  Sources   Download

MIT

The Requires

 

The Development Requires

by Brent Roose

spatie code-outliner

23/07 2018

dev-analysis-XkN0Q9

dev-analysis-XkN0Q9 https://github.com/spatie/code-outliner

Generate outline images of your code

  Sources   Download

MIT

The Requires

 

The Development Requires

by Brent Roose

spatie code-outliner

20/07 2018

dev-master

9999999-dev https://github.com/spatie/code-outliner

Generate outline images of your code

  Sources   Download

MIT

The Requires

 

The Development Requires

by Brent Roose

spatie code-outliner

19/07 2018

0.1.2

0.1.2.0 https://github.com/spatie/code-outliner

Generate outline images of your code

  Sources   Download

MIT

The Requires

 

The Development Requires

by Brent Roose

spatie code-outliner

19/07 2018

0.1.1

0.1.1.0 https://github.com/spatie/code-outliner

Generate outline images of your code

  Sources   Download

MIT

The Requires

 

The Development Requires

by Brent Roose

spatie code-outliner

19/07 2018

0.1.0

0.1.0.0 https://github.com/spatie/code-outliner

Generate outline images of your code

  Sources   Download

MIT

The Requires

 

by Brent Roose

spatie code-outliner