https://github.com/ghostwriter/phormat

[WIP]PHP code formatter.
https://github.com/ghostwriter/phormat

coding-standard ghostwriter phormat

Last synced: about 1 month ago
JSON representation

[WIP]PHP code formatter.

• Host: GitHub
• URL: https://github.com/ghostwriter/phormat
• Owner: ghostwriter
• License: bsd-3-clause
• Created: 2024-01-29T21:17:15.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-09-30T19:53:07.000Z (about 2 months ago)
• Last Synced: 2024-10-03T10:57:04.249Z (about 2 months ago)
• Topics: coding-standard, ghostwriter, phormat
• Language: PHP
• Homepage: https://github.com/ghostwriter/phormat
• Size: 110 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Phormat

[![Automation](https://github.com/ghostwriter/phormat/actions/workflows/automation.yml/badge.svg)](https://github.com/ghostwriter/phormat/actions/workflows/automation.yml)

[![Supported PHP Version](https://badgen.net/packagist/php/ghostwriter/phormat?color=8892bf)](https://www.php.net/supported-versions)

[![GitHub Sponsors](https://img.shields.io/github/sponsors/ghostwriter?label=Sponsor+@ghostwriter/phormat&logo=GitHub+Sponsors)](https://github.com/sponsors/ghostwriter)

[![Code Coverage](https://codecov.io/gh/ghostwriter/phormat/branch/main/graph/badge.svg)](https://codecov.io/gh/ghostwriter/phormat)

[![Type Coverage](https://shepherd.dev/github/ghostwriter/phormat/coverage.svg)](https://shepherd.dev/github/ghostwriter/phormat)

[![Psalm Level](https://shepherd.dev/github/ghostwriter/phormat/level.svg)](https://psalm.dev/docs/running_psalm/error_levels)

[![Latest Version on Packagist](https://badgen.net/packagist/v/ghostwriter/phormat)](https://packagist.org/packages/ghostwriter/phormat)

[![Downloads](https://badgen.net/packagist/dt/ghostwriter/phormat?color=blue)](https://packagist.org/packages/ghostwriter/phormat)

PHP code formatter.

> [!WARNING]

>

> This project is not finished yet, work in progress.

## Installation

You can install the package via composer:

``` bash

composer require ghostwriter/phormat

```

### Star ⭐️ this repo if you find it useful

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

## Usage

```php

vendor/bin/phormat  --dry-run

```

## Configuration

```php

paths($workingDirectory . '/bin', $workingDirectory . '/src', $workingDirectory . '/tests')

    ->skip($workingDirectory . '/.cache', $workingDirectory . '/docs', $workingDirectory . '/vendor')

    ->skipVisitors([

        PERCSNodeVisitor::class => [$workingDirectory . '/tests/Fixture'],

    ]);

```

### Credits

- [Nathanael Esayeas](https://github.com/ghostwriter)

- [Nikita Popov `nikic/php-parser`](https://github.com/nikic/php-parser)

- [All Contributors](https://github.com/ghostwriter/phormat/contributors)

### Changelog

Please see [CHANGELOG.md](./CHANGELOG.md) for more information on what has changed recently.

### License

Please see [LICENSE](./LICENSE) for more information on the license that applies to this project.

### Security

Please see [SECURITY.md](./SECURITY.md) for more information on security disclosure process.