Skip to content

Latest commit

 

History

History
95 lines (63 loc) · 4.43 KB

README.md

File metadata and controls

95 lines (63 loc) · 4.43 KB

VarDump

Chevere

Build Code size Apache-2.0 PHPStan Mutation testing badge

Quality Gate Status Maintainability Rating Reliability Rating Security Rating Coverage Technical Debt CodeFactor

Summary

Multi-purpose colorful modern alternative to var_dump. It's a PHP library that provides an alternative to var_dump and dump functions. It's designed to be used in development environments to help you debug your code.

Features

  • Colorful output with automatic light/dark modes
  • HTML, Console, and Plain text output
  • No JavaScript required
  • Displays modifiers, types, values, references, and more
  • Recursive detection
  • Foldable arrays and objects with indentation display
  • Lightweight codebase

Installing

VarDump is available through Packagist and the repository source is at chevere/var-dump.

Run the following command to install VarDump as a development dependency of your project:

composer require --dev chevere/var-dump

Global installation

To make the vd() function available globally in any PHP code, install VarDump globally:

composer global require chevere/var-dump

If not already configured, add the global Composer dependencies to your php.ini:

auto_prepend_file = ${HOME}/.composer/vendor/autoload.php

Run the following command to select and update the auto_prepend_file directive in your php.ini:

bash <(curl -sL chevere.org/bin/composer/global-prepend.sh)

You can now use VarDump in any PHP script without requiring the library for each project.

Quick start

  • Use vd to dump information about any variable (replaces var_dump and dump)
  • Use vdd to do the same as vd and die(0) (replaces dd)
vd($myVar); // var dump
vdd($myVar); // var dump and die

Demo

HTML demo dark

HTML demo light

Documentation

Documentation is available at chevere.org.

License

Copyright Rodolfo Berrios A.

Chevere is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.