Download the PHP package dragon-code/codestyler without Composer

The Dragon Code Styler

Introduction

The Dragon Code Styler is an opinionated PHP code style fixer for minimalists. Codestyler is built on top of Laravel Pint and PHP-CS-Fixer, and makes it simple to ensure that your code style stays clean and consistent.

By default, Codestyler does not require any configuration and will fix code style issues in your code by following the opinionated coding style of The Dragon Code based on the PER rule set.

The easiest and free way to say “thank you” to the developers whose packages you use is to “star” the GitHub repository.

See more at https://github.com/symfony/thanks

Installation

Required

• PHP: ^8.1
• Composer: ^2.0

Locally

Usage

When you run the commands in the base path of the project, the composer.json file will be automatically read, from which the minimum PHP version for your project will be taken.

This is necessary to draw up rules for applying the Codestyler.

For example, if your project supports PHP 8.0 and above, and you use the mkdir($path, 0755) function in it, then applying the rules for PHP 8.0 will break your code because it will replace 0755 with 0o755 (mkdir($path, 0o755)).

To prevent this from happening, we check the minimum PHP version.

Please note that the composer.json file is only read if the script execution is started in the folder with it.

CLI

Options

Path

The path to fix

Test

Test for code style errors without fixing them

Config

The configuration that should be used. The target directory will read the pint.json file from Laravel Pint, minus the style set.

Risky

Allows to set whether risky rules may run:

Dirty

Only fix files that have uncommitted changes.

Bail

Test for code style errors without fixing them and stop on first error

Output Format

The output format that should be used.

List of available formats:

• checkstyle
• gitlab
• json
• junit
• txt
• xml

Help Commands

To view the list of available commands, you can call the console command:

To view extended information on a command, you can use the help option. For example,

GitHub Action

ATTENTION

Starting with code styler version 4.2.0, we will no longer support a container for GitHub Actions.

Instead, use direct dependency installation using the examples below.

Create a new .github/workflows/code-style.yml file and add the content to it:

You can also use a simplified version of the configuration by linking to our settings.

In this case, the following settings will be applied:

• Always checks if the event is not equal to push or the branch is not equal to main
• Correcting the code style will take the following steps:
  • Will add the following plugins to the list of allowed plugins in your composer.json file:
    • dragon-code/codestyler
    • ergebnis/composer-normalize
  • Updates the .github/dependabot.yml file
  • Updates the .editorconfig file
  • Will correct the order of elements in the composer.json file to match the official schema.
  • Corrects the code style of your project.

Other CI/CD

IDE

After executing the codestyle editorconfig console command, a .editorconfig file will be added to your application. If the file already exists, it will be replaced.

In order for your IDE to read the code style settings from it, make sure its support is enabled in the settings.

For example, in phpStorm the setting is in the File | Settings | Editor | Code Style:

You can also use the codestyle phpstorm console command to publish the schema xml file to phpStorm. You can import this file into the IDE.

License

This package is licensed under the MIT License.