The Dragon Code Styler
Installation
Required
- PHP: ^8.0
- Composer: ^2.0
Locally
composer global require dragon-code/codestyler
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 codestyle.
For example, if your project supports PHP 7.2 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
# Check code-style.
codestyle check
# Check and fix code-style.
codestyle fix
# Update `.editorconfig`.
codestyle editorconfig
# Update Dependabot rules.
codestyle dependabot
GitHub Action
Check
Create a new .github/workflows/lint-check.yml file and add the content to it:
name: "Code-Style Check"
on: [ push, pull_request ]
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Checking PHP Syntax
uses: TheDragonCode/[email protected]
Fixer
Create a new .github/workflows/lint-fixer.yml file and add the content to it:
name: "Code-Style Fixer"
on:
push:
branches: [ main ]
jobs:
fix:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Checking PHP Syntax
uses: TheDragonCode/[email protected]
with:
# This token uses GitHub Actions to execute code.
# Required when `fix` is `true`.
# The default value is `${{ secrets.GITHUB_TOKEN }}`.
github_token: ${{ secrets.YOUR_TOKEN }}
# Activates the mode of accepting changes with the creation
# of commits.
fix: true
# Activates the actualization of the `.editorconfig` file.
# Works only when the `fix` option is enabled.
# By default, true
editorconfig: true
# Activates Dependabot file processing.
# Works only when the `fix` option is enabled.
# By default, true
dependabot: true
# Normalizing `composer.json`.
# Works only when the `fix` option is enabled.
# By default, true
normalize: true
Since the changes are pushed to the master branch, GitHub can block this action with a security policy.
To solve this problem, you need to be create of your account token and specify it in the Actions secrets section of the repository or organization.
The name of the variable containing the token must be passed to the github_token key.
Other CI/CD
composer global require dragon-code/codestyler
codestyle <command>
Configuration
By default, the linter scans all files in the current launch folder, except for folders such as vendor, node_modules and .github.
- uses: TheDragonCode/[email protected]
By default, the linter only checks the code-style. If you want to apply the changes, then you need to activate this option:
- uses: TheDragonCode/[email protected]
with:
fix: true
By default, GitHub Action does not allow versioning, so our project will create a configuration file for it, which will check for new versions once a day.
When Dependabot detects new versions of containers, it will automatically create a PR to your repository. So you don't need to keep track of updates - Dependabot will do everything for you
If the .github/dependabot.yml file has already been created, we will check it and add the necessary rules. So don't be afraid, nothing will be deleted
Note
Files will be created only if you have specified
fix: true.Or you can manually run the Dependabot rule creation script by executing the
codestyle dependabotcommand.
License
This package is licensed under the MIT License.
3 Oct 9, 2022
921 Dec 18, 2022
3 Jun 8, 2022
955 Dec 25, 2022
68 Oct 21, 2022
3 Jun 13, 2022
6 Jul 26, 2021
85 Mar 19, 2022
16 Jul 17, 2022
2.2k Dec 28, 2022
90 Dec 29, 2022
5 Oct 19, 2022
1.4k Jan 1, 2023
2 Apr 4, 2022
197 Dec 30, 2022
2.4k Jan 5, 2023
938 Dec 24, 2022
2 Dec 17, 2021
73 Jun 1, 2022