Skip to content

Commit

Permalink
add(qa) php-cs-fixer config and github action
Browse files Browse the repository at this point in the history
  • Loading branch information
connorhu committed Jan 24, 2024
1 parent 1d68711 commit f99bfbc
Show file tree
Hide file tree
Showing 3 changed files with 79 additions and 0 deletions.
31 changes: 31 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: "Code Linting"
on:
push:
branches:
- master
pull_request:

jobs:
php-cs-fixer:
name: 'PHP-CS-Fixer'
runs-on: 'ubuntu-latest'
steps:
- uses: actions/checkout@v3

- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: 8.2
tools: php-cs-fixer:3.45, cs2pr

- uses: actions/cache@v3
with:
path: '.php-cs-fixer.cache'
key: ${{ github.repository }}-8.2-phpcsfixer-${{ github.ref_name }}
restore-keys: |
${{ github.repository }}-8.2-phpcsfixer-master
${{ github.repository }}-8.2-phpcsfixer-
- name: Run PHP-CS-Fixer
# Using cs2pr settings, see: https://github.com/shivammathur/setup-php#tools-with-checkstyle-support
run: 'php-cs-fixer fix --dry-run --format checkstyle | cs2pr'
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ tests/DoctrineTest/doctrine_tests/*
/tests/tmp
/tests/foo.sq3
/vendor/
.php-cs-fixer.cache
47 changes: 47 additions & 0 deletions .php-cs-fixer.dist.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
<?php

$finder = PhpCsFixer\Finder::create()
->ignoreVCSIgnored(true)
->in(__DIR__.'/lib')
->in(__DIR__.'/tests')
->append(array(__FILE__))
// Exclude generated files (single files)
->notPath('should-be-ignored.php')
;

$config = new PhpCsFixer\Config();
$config->setRules(array(
'@PhpCsFixer' => true,
'@Symfony' => true,
'array_syntax' => array(
'syntax' => 'long',
),
'method_argument_space' => array(
'on_multiline' => 'ensure_fully_multiline',
),
'general_phpdoc_annotation_remove' => array(
'annotations' => array('version', 'license', 'since'),
),
'phpdoc_no_package' => true,
'phpdoc_separation' => array(
'groups' => array(
array(
'author',
),
array(
'deprecated',
'see',
),
array(
'param',
'return',
'throws',
),
),
),
))
->setCacheFile('.php-cs-fixer.cache')
->setFinder($finder)
;

return $config;

0 comments on commit f99bfbc

Please sign in to comment.