Skip to content

Commit

Permalink
Merge pull request #25 from donatj/phpstan
Browse files Browse the repository at this point in the history
Pretty major cleanup
  • Loading branch information
donatj authored Nov 3, 2023
2 parents d8c7708 + 7baa589 commit 5b40a5d
Show file tree
Hide file tree
Showing 13 changed files with 454 additions and 100 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
strategy:
matrix:
operating-system: [ubuntu-latest]
php-versions: ['5.5', '5.6', '7.0', '7.1', '7.2', '7.3', '7.4', '8.0', '8.1', '8.2']
php-versions: ['7.2', '7.3', '7.4', '8.0', '8.1', '8.2']

runs-on: ${{ matrix.operating-system }}

Expand All @@ -28,5 +28,5 @@ jobs:
- name: Install dependencies with composer
run: composer install

- name: Test with phpunit
run: vendor/bin/phpunit
- name: Test
run: make test
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
vendor/
/composer.lock
/clover.xml
*.cache
5 changes: 3 additions & 2 deletions .mddoc.xml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<mddoc>

<docpage target="README.md" autoloader="psr4" autoloader-root-namespace="donatj" autoloader-root="src">
<docpage target="README.md">
<autoloader type="psr4" namespace="donatj" root="src"/>

<section title="Simple Calendar">
<badge-poser type="version"/>
Expand All @@ -20,7 +21,7 @@
</section>

<section title="Documentation">
<recursivedirectory name="src"/>
<recursive-directory name="src"/>
</section>
</section>
</docpage>
Expand Down
171 changes: 171 additions & 0 deletions .php-cs-fixer.dist.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,171 @@
<?php

$finder = PhpCsFixer\Finder::create()
->files()
->in(__DIR__ . '/src')
->in(__DIR__ . '/test')
->in(__DIR__ . '/example')
->name('*.php');

return (new PhpCsFixer\Config)
->setUsingCache(true)
->setIndent("\t")
->setLineEnding("\n")
//->setUsingLinter(false)
->setRiskyAllowed(true)
->setRules(
[
'@PHPUnit60Migration:risky' => true,
'php_unit_test_case_static_method_calls' => [
'call_type' => 'this',
],

'concat_space' => [
'spacing' => 'one',
],

'visibility_required' => true,
'indentation_type' => true,
'no_useless_return' => true,

'switch_case_space' => true,
'switch_case_semicolon_to_colon' => true,

'array_syntax' => [ 'syntax' => 'short' ],
'list_syntax' => [ 'syntax' => 'short' ],

'no_leading_import_slash' => true,
'no_leading_namespace_whitespace' => true,

'no_whitespace_in_blank_line' => true,

'phpdoc_add_missing_param_annotation' => [ 'only_untyped' => true, ],
'phpdoc_indent' => true,

'phpdoc_no_alias_tag' => true,
'phpdoc_no_package' => true,
'phpdoc_no_useless_inheritdoc' => true,

'phpdoc_order' => true,
'phpdoc_scalar' => true,
'phpdoc_single_line_var_spacing' => true,

'phpdoc_var_annotation_correct_order' => true,

'phpdoc_trim' => true,
'phpdoc_trim_consecutive_blank_line_separation' => true,

'phpdoc_types' => true,
'phpdoc_types_order' => [
'null_adjustment' => 'always_last',
'sort_algorithm' => 'alpha',
],

'phpdoc_align' => [
'align' => 'vertical',
'tags' => [ 'param' ],
],

'phpdoc_line_span' => [
'const' => 'single',
'method' => 'multi',
'property' => 'single',
],

'short_scalar_cast' => true,

'standardize_not_equals' => true,
'ternary_operator_spaces' => true,
'no_spaces_after_function_name' => true,
'no_unneeded_control_parentheses' => true,

'return_type_declaration' => [
'space_before' => 'one',
],

'single_line_after_imports' => true,
'single_blank_line_before_namespace' => true,
'blank_line_after_namespace' => true,
'single_blank_line_at_eof' => true,
'ternary_to_null_coalescing' => true,
'whitespace_after_comma_in_array' => true,

'cast_spaces' => [ 'space' => 'none' ],

'encoding' => true,

'space_after_semicolon' => [
'remove_in_empty_for_expressions' => true,
],

'align_multiline_comment' => [
'comment_type' => 'phpdocs_like',
],

'blank_line_before_statement' => [
'statements' => [ 'continue', 'try', 'switch', 'exit', 'throw', 'return', 'do' ],
],

'no_superfluous_phpdoc_tags' => [
'remove_inheritdoc' => true,
],
'no_superfluous_elseif' => true,

'no_useless_else' => true,

'combine_consecutive_issets' => true,
'escape_implicit_backslashes' => true,
'explicit_indirect_variable' => true,
'heredoc_to_nowdoc' => true,


'no_singleline_whitespace_before_semicolons' => true,
'no_null_property_initialization' => true,
'no_whitespace_before_comma_in_array' => true,

'no_empty_phpdoc' => true,
'no_empty_statement' => true,
'no_empty_comment' => true,
'no_extra_blank_lines' => true,
'no_blank_lines_after_phpdoc' => true,

'no_spaces_around_offset' => [
'positions' => [ 'outside' ],
],

'return_assignment' => true,
'lowercase_static_reference' => true,

'method_chaining_indentation' => true,
'method_argument_space' => [
'on_multiline' => 'ignore', // at least until they fix it
'keep_multiple_spaces_after_comma' => true,
],

'multiline_comment_opening_closing' => true,

'include' => true,
'elseif' => true,

'simple_to_complex_string_variable' => true,

'global_namespace_import' => [
'import_classes' => false,
'import_constants' => false,
'import_functions' => false,
],

'trailing_comma_in_multiline' => true,
'single_line_comment_style' => true,

'is_null' => true,
'yoda_style' => [
'equal' => false,
'identical' => false,
'less_and_greater' => null,
],
]
)
->setFinder($finder);


117 changes: 117 additions & 0 deletions .php_cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
<?php

$finder = PhpCsFixer\Finder::create()
->files()
->in(__DIR__ . '/src')
->in(__DIR__ . '/test')
->in(__DIR__ . '/example')
->name('*.php');


return PhpCsFixer\Config::create()
->setUsingCache(true)
->setIndent("\t")
->setLineEnding("\n")
//->setUsingLinter(false)
//->setRiskyAllowed(true)
->setRules(
[
'concat_space' => [
'spacing' => 'one',
],

'visibility_required' => true,
'indentation_type' => true,
'no_useless_return' => true,

'switch_case_space' => true,
'switch_case_semicolon_to_colon' => true,

'array_syntax' => [ 'syntax' => 'short' ],
'list_syntax' => [ 'syntax' => 'short' ],

'no_leading_import_slash' => true,
'no_leading_namespace_whitespace' => true,

'no_whitespace_in_blank_line' => true,

'phpdoc_add_missing_param_annotation' => [ 'only_untyped' => true, ],
'phpdoc_indent' => true,

'phpdoc_no_alias_tag' => true,
'phpdoc_no_package' => true,
'phpdoc_no_useless_inheritdoc' => true,

'phpdoc_order' => true,
'phpdoc_scalar' => true,
'phpdoc_single_line_var_spacing' => true,

'phpdoc_trim' => true,
'phpdoc_trim_consecutive_blank_line_separation' => true,

'phpdoc_types' => true,
'phpdoc_types_order' => [
'null_adjustment' => 'always_last',
'sort_algorithm' => 'alpha',
],

'short_scalar_cast' => true,

'standardize_not_equals' => true,
'ternary_operator_spaces' => true,
'no_spaces_after_function_name' => true,
'no_unneeded_control_parentheses' => true,

'return_type_declaration' => [
'space_before' => 'one',
],

'single_line_after_imports' => true,
'single_blank_line_before_namespace' => true,
'blank_line_after_namespace' => true,
'single_blank_line_at_eof' => true,
'ternary_to_null_coalescing' => true,
'whitespace_after_comma_in_array' => true,

'cast_spaces' => [ 'space' => 'none' ],

'encoding' => true,

'space_after_semicolon' => [
'remove_in_empty_for_expressions' => true,
],

'align_multiline_comment' => [
'comment_type' => 'phpdocs_like',
],

'blank_line_before_statement' => [
'statements' => [ 'continue', 'try', 'switch', 'die', 'exit', 'throw', 'return' ],
],

'no_superfluous_phpdoc_tags' => true,
'no_superfluous_elseif' => true,

'no_useless_else' => true,

'combine_consecutive_issets' => true,
'escape_implicit_backslashes' => true,
'heredoc_to_nowdoc' => true,

'no_empty_phpdoc' => true,
'no_empty_statement' => true,
'no_empty_comment' => true,
'no_extra_blank_lines' => true,
'no_blank_lines_after_phpdoc' => true,

'return_assignment' => true,
'lowercase_static_reference' => true,

'method_chaining_indentation' => true,

'elseif' => true,
]
)
->setFinder($finder);


18 changes: 18 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
SRC_FILES = $(shell find example src -type f -name '*.php')

.PHONY: test
test: cs
vendor/bin/phpunit
vendor/bin/phpstan analyse --memory-limit 2g

.PHONY: cs
cs:
vendor/bin/phpcs

.PHONY: cbf
cbf:
vendor/bin/phpcbf

.PHONY: fix
fix: cbf
vendor/bin/php-cs-fixer fix
Loading

0 comments on commit 5b40a5d

Please sign in to comment.