sanmai/linter

PHP Linter

v0.2 2021-01-01 15:27 UTC

This package is auto-updated.

Last update: 2021-11-29 17:22:10 UTC


README

Build Status Coverage Status

Simple PHP source code linter with zero dependencies

This is a very bare (really just 20 lines of code, comments included) yet very thoroughly tested (100% MSI) programmatic source code linter. Give it a piece of source code from a file or as a string, and it will tell you if this is a valid PHP or not. But do not forget to include the opening <?php tag.

The linter uses the default PHP executable found in PATH. If you want to test your code with a different, non-default, PHP executable, consider other libraries out there, careful PATH manipulation, or, provided you have a convincing argument, you can send a pull request.

Install

composer require sanmai/linter

Use

$linter = new \Linter\StringLinter('<?php return 1;');
$result = $linter->foundErrors();

var_dump($result);
// bool(false)
$linter = new \Linter\StringLinter('<?php obviously invalid PHP code;');
$result = $linter->foundErrors();

var_dump($result);
// bool(true)

That's it!