Note
Codestyler 5 is the last version that runs on its own code and includes a mechanism for publishing files via command
parameters. It is also the last version installed globally via Composer.
Starting with Codestyler 6, the project will contain pint.json and .editorconfig files, and adding them to the
project will be done by calling a console command.
You can install the package using Composer:
composer require dragon-code/codestyler --dev
composer config scripts.style "vendor/bin/rector && vendor/bin/pint --parallel"It is also possible to establish dependence in the global area of visibility:
composer global require dragon-code/codestyler
After installing the dependency, add a file copy command to the scripts.post-update-cmd section.
This will automatically copy the pint.json file to the project root.
When adding the command, replace 8.5 with the minimum PHP version your application works with.
Available presets: 8.2, 8.3, 8.4 and `8.5.
You can also add copying the .editorconfig file to help the IDE and calling normalize the composer.json file
and biome.json file for Biome Linter:
{
"scripts": {
"post-update-cmd": [
"vendor/bin/codestyle pint 8.5",
"vendor/bin/codestyle rector laravel",
"vendor/bin/codestyle editorconfig",
"vendor/bin/codestyle npm",
"composer normalize"
]
}
}When using a globally established dependence, the call must be replaced with the following:
{
"scripts": {
"post-update-cmd": [
"codestyle pint 8.5",
"codestyle rector laravel",
"codestyle editorconfig",
"codestyle npm",
"composer normalize"
]
}
}If it is necessary to correct the code style for JS, CSS and JSON, you need to separately set the dependence through the NPM package manager (or any other):
npm i -D @biomejs/biome
After that, write the commands in the package.json file:
{
"scripts": {
"lint": "npx @biomejs/biome lint --write",
"format": "npx @biomejs/biome format --write",
"style": "npm run lint && npm run format"
}
}Laravel Pint is used as the linter for PHP.
The linter is invoked by a console command:
composer style
Rector is uses as the code rector for PHP.
The Rector is invoked by a console command:
composer style
To do this, make sure the file is in the root of the project.
You can also automate this process by adding a call to the file copy function in the scripts.post-update-cmd
section of the composer.json file.
{
"scripts": {
"post-update-cmd": [
"vendor/bin/codestyle rector laravel"
]
}
}Available presets:
laraveldefault
Biome is used as the linter for JS, CSS and JSON.
Make sure the biome.json file is in the root of the project.
You can also automate this process by adding a call to the file copy function in the scripts.post-update-cmd
section of the composer.json file:
{
"scripts": {
"post-update-cmd": [
"vendor/bin/codestyle npm"
]
}
}The .editorconfig file helps your IDE to work according to certain rules.
To do this, make sure the file is in the root of the project.
You can also automate this process by adding a call to the file copy function in the scripts.post-update-cmd
section of the composer.json file.
{
"scripts": {
"post-update-cmd": [
"vendor/bin/codestyle editorconfig"
]
}
}We recommend using the Composer Normalize plugin,
which normalizes the composer.json file appearance to match its schema.
This will keep each project's file consistent, making it much easier to read.
To activate the plugin, call the console command:
composer config allow-plugins.ergebnis/composer-normalize trueTo use this feature, add a call parameter to the post-update-cmd block of the composer.json file:
{
"scripts": {
"post-update-cmd": [
"composer normalize"
]
}
}Now you can just a run console command:
composer update
After completing all the steps, the composer.json file will have the following changes:
{
"require-dev": {
"dragon-code/codestyler": "^6.0"
},
"config": {
"allow-plugins": {
"ergebnis/composer-normalize": true
}
},
"scripts": {
"post-update-cmd": [
"vendor/bin/codestyle pint 8.5",
"vendor/bin/codestyle rector laravel",
"vendor/bin/codestyle editorconfig",
"vendor/bin/codestyle npm",
"composer normalize"
],
"style": [
"vendor/bin/rector",
"vendor/bin/pint --parallel"
]
}
}After completing all the steps, the package.json file will have the following changes:
{
"scripts": {
"lint": "npx @biomejs/biome lint --write",
"format": "npx @biomejs/biome format --write",
"style": "npm run lint && npm run format"
},
"devDependencies": {
"@biomejs/biome": "^2.2.2"
}
}To use the Linter with GitHub Actions, just create a file .github/workflows/code-style.yml and insert this content
into it:
name: Code Style on: push: pull_request: permissions: write-all jobs: Checks: uses: TheDragonCode/.github/.github/workflows/code-style.yml@main with: php: true node: true
Defaults:
- php: true
- node: true
After executing the composer update 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:
This package is licensed under the MIT License.