Skip to content

ghostwriter/phormat

Repository files navigation

Phormat

Automation Supported PHP Version GitHub Sponsors Code Coverage Type Coverage Psalm Level Latest Version on Packagist Downloads

PHP code formatter.

Warning

This project is not finished yet, work in progress.

Installation

You can install the package via composer:

composer require ghostwriter/phormat

Star ⭐️ this repo if you find it useful

You can also star (🌟) this repo to find it easier later.

Usage

vendor/bin/phormat <path> --dry-run

Configuration

<?php

declare(strict_types=1);

use Ghostwriter\Phormat\NodeVisitor\PERCSNodeVisitor;
use Ghostwriter\Phormat\PhormatConfig;

/** @var non-empty-string $workingDirectory */
$workingDirectory = \getcwd() ?: __DIR__;

/** @psalm-suppress UncaughtThrowInGlobalScope */
return PhormatConfig::new()
    ->paths($workingDirectory . '/bin', $workingDirectory . '/src', $workingDirectory . '/tests')
    ->skip($workingDirectory . '/.cache', $workingDirectory . '/docs', $workingDirectory . '/vendor')
    ->skipVisitors([
        PERCSNodeVisitor::class => [$workingDirectory . '/tests/Fixture'],
    ]);

Credits

Changelog

Please see CHANGELOG.md for more information on what has changed recently.

License

Please see LICENSE for more information on the license that applies to this project.

Security

Please see SECURITY.md for more information on security disclosure process.

Releases

No releases published

Sponsor this project

 

Packages

No packages published

Languages