Skip to content

Commit

Permalink
automate style fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
blaineam committed Apr 28, 2024
1 parent bad9f68 commit 4889621
Show file tree
Hide file tree
Showing 6 changed files with 125 additions and 1 deletion.
45 changes: 45 additions & 0 deletions .github/workflows/code-style.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Code Style

on: [push]

jobs:
php-cs-fixer:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v2

- name: Run PHP CS Fixer
uses: docker://oskarstark/php-cs-fixer-ga
with:
args: --config=.php-cs-fixer.dist.php --allow-risky=yes

- name: Commit changes
uses: stefanzweifel/[email protected]
with:
commit_message: Fix styling
branch: main
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

prettier:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v2

- name: Install NPM dependencies
run: npm ci

- name: Run Prettier
run: npm run format

- name: Commit changes
uses: stefanzweifel/[email protected]
with:
commit_message: Apply Prettier changes
branch: main
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@ bios/**
saves/**
screenshots/**
.DS_Store
.env
.env
node_modules
42 changes: 42 additions & 0 deletions .php-cs-fixer.dist.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
<?php

// php-cs-fixer 3.0 distributed config file

$config = new PhpCsFixer\Config();
$config
->setRules([
'@PSR2' => true,
'concat_space' => ['spacing' => 'one'],
'no_unused_imports' => true,
'whitespace_after_comma_in_array' => true,
'method_argument_space' => [
'keep_multiple_spaces_after_comma' => true,
'on_multiline' => 'ignore'
],
'return_type_declaration' => [
'space_before' => 'none'
],
// only converts simple strings in double quotes to single quotes
// ignores strings using variables, escape characters or single quotes inside
'single_quote' => true,
// there should be a single space b/w the cast and it's operand
'cast_spaces' => ['space' => 'single'],
// there shouldn't be any trailing whitespace at the end of a non-blank line
'no_trailing_whitespace' => true,
// there shouldn't be any trailing whitespace at the end of a blank line
'no_whitespace_in_blank_line' => true,
// there should be a space around binary operators like (=, => etc)
'binary_operator_spaces' => ['default' => 'single_space'],
// deals with rogue empty blank lines
'no_extra_blank_lines' => ['tokens' => ['extra']],
// reduces multi blank lines b/w phpdoc description and @param to a single line
// NOTE: Doesn't add a blank line if none exist
'phpdoc_trim_consecutive_blank_line_separation' => true,
])
->setFinder(
PhpCsFixer\Finder::create()
->in(__DIR__)
)
;

return $config;
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
emu
27 changes: 27 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"devDependencies": {
"prettier": "3.2.5"
},
"scripts": {
"format": "prettier . --write --ignore-unknown"
}
}

0 comments on commit 4889621

Please sign in to comment.