Skip to content

Commit 901bc94

Browse files
donatjdonatj
committed
Adds a handful of automated code quality tools
1 parent e1d6160 commit 901bc94

File tree

4 files changed

+192
-3
lines changed

4 files changed

+192
-3
lines changed

‎.php_cs

+165
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
<?php
2+
3+
$finder = PhpCsFixer\Finder::create()
4+
->files()
5+
->in(__DIR__ . '/src')
6+
->in(__DIR__ . '/test')
7+
->name('*.php');
8+
9+
10+
return PhpCsFixer\Config::create()
11+
->setUsingCache(true)
12+
->setIndent("\t")
13+
->setLineEnding("\n")
14+
//->setUsingLinter(false)
15+
->setRiskyAllowed(true)
16+
->setRules(
17+
[
18+
'@PHPUnit60Migration:risky' => true,
19+
'php_unit_test_case_static_method_calls' => [
20+
'call_type' => 'this',
21+
],
22+
23+
'concat_space' => [
24+
'spacing' => 'one',
25+
],
26+
27+
'visibility_required' => true,
28+
'indentation_type' => true,
29+
'no_useless_return' => true,
30+
31+
'switch_case_space' => true,
32+
'switch_case_semicolon_to_colon' => true,
33+
34+
'array_syntax' => [ 'syntax' => 'short' ],
35+
'list_syntax' => [ 'syntax' => 'short' ],
36+
37+
'no_leading_import_slash' => true,
38+
'no_leading_namespace_whitespace' => true,
39+
40+
'no_whitespace_in_blank_line' => true,
41+
42+
'phpdoc_add_missing_param_annotation' => [ 'only_untyped' => true, ],
43+
'phpdoc_indent' => true,
44+
45+
'phpdoc_no_alias_tag' => true,
46+
'phpdoc_no_package' => true,
47+
'phpdoc_no_useless_inheritdoc' => true,
48+
49+
'phpdoc_order' => true,
50+
'phpdoc_scalar' => true,
51+
'phpdoc_single_line_var_spacing' => true,
52+
53+
'phpdoc_var_annotation_correct_order' => true,
54+
55+
'phpdoc_trim' => true,
56+
'phpdoc_trim_consecutive_blank_line_separation' => true,
57+
58+
'phpdoc_types' => true,
59+
'phpdoc_types_order' => [
60+
'null_adjustment' => 'always_last',
61+
'sort_algorithm' => 'alpha',
62+
],
63+
64+
'phpdoc_align' => [
65+
'align' => 'vertical',
66+
'tags' => [ 'param' ],
67+
],
68+
69+
'phpdoc_line_span' => [
70+
'const' => 'single',
71+
'method' => 'multi',
72+
'property' => 'single',
73+
],
74+
75+
'short_scalar_cast' => true,
76+
77+
'standardize_not_equals' => true,
78+
'ternary_operator_spaces' => true,
79+
'no_spaces_after_function_name' => true,
80+
'no_unneeded_control_parentheses' => true,
81+
82+
'return_type_declaration' => [
83+
'space_before' => 'one',
84+
],
85+
86+
'single_line_after_imports' => true,
87+
'single_blank_line_before_namespace' => true,
88+
'blank_line_after_namespace' => true,
89+
'single_blank_line_at_eof' => true,
90+
'ternary_to_null_coalescing' => true,
91+
'whitespace_after_comma_in_array' => true,
92+
93+
'cast_spaces' => [ 'space' => 'none' ],
94+
95+
'encoding' => true,
96+
97+
'space_after_semicolon' => [
98+
'remove_in_empty_for_expressions' => true,
99+
],
100+
101+
'align_multiline_comment' => [
102+
'comment_type' => 'phpdocs_like',
103+
],
104+
105+
'blank_line_before_statement' => [
106+
'statements' => [ 'continue', 'try', 'switch', 'die', 'exit', 'throw', 'return', 'yield', 'do' ],
107+
],
108+
109+
'no_superfluous_phpdoc_tags' => [
110+
'remove_inheritdoc' => true,
111+
],
112+
'no_superfluous_elseif' => true,
113+
114+
'no_useless_else' => true,
115+
116+
'compact_nullable_typehint' => true,
117+
118+
'combine_consecutive_issets' => true,
119+
'escape_implicit_backslashes' => true,
120+
'explicit_indirect_variable' => true,
121+
'heredoc_to_nowdoc' => true,
122+
123+
124+
'no_singleline_whitespace_before_semicolons' => true,
125+
'no_null_property_initialization' => true,
126+
'no_whitespace_before_comma_in_array' => true,
127+
128+
'no_empty_phpdoc' => true,
129+
'no_empty_statement' => true,
130+
'no_empty_comment' => true,
131+
'no_extra_blank_lines' => true,
132+
'no_blank_lines_after_phpdoc' => true,
133+
134+
'no_spaces_around_offset' => [
135+
'positions' => [ 'outside' ],
136+
],
137+
138+
'return_assignment' => true,
139+
'lowercase_static_reference' => true,
140+
141+
'method_chaining_indentation' => true,
142+
'method_argument_space' => [
143+
'keep_multiple_spaces_after_comma' => true,
144+
],
145+
146+
'multiline_comment_opening_closing' => true,
147+
148+
'include' => true,
149+
'elseif' => true,
150+
151+
'simple_to_complex_string_variable' => true,
152+
153+
'global_namespace_import' => [
154+
'import_classes' => false,
155+
'import_constants' => false,
156+
'import_functions' => false,
157+
],
158+
159+
'trailing_comma_in_multiline_array' => true,
160+
'single_line_comment_style' => true,
161+
]
162+
)
163+
->setFinder($finder);
164+
165+

‎Makefile

+14-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,20 @@
1-
SRC_FILES = $(shell find example src -type f -name '*.php')
1+
SRC_FILES = $(shell find src -type f -name '*.php')
22

33
README.md: $(SRC_FILES)
44
vendor/bin/mddoc
55

6+
.PHONY: fix
7+
fix: cbf
8+
vendor/bin/php-cs-fixer fix
9+
610
.PHONY: test
7-
test:
11+
test: cs
812
vendor/bin/phpunit
13+
14+
.PHONY: cs
15+
cs:
16+
vendor/bin/phpcs
17+
18+
.PHONY: cbf
19+
cbf:
20+
vendor/bin/phpcbf

‎composer.json

+4-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@
66
"php": ">=7.1"
77
},
88
"require-dev": {
9-
"phpunit/phpunit": "~7.5 | ~9.5"
9+
"phpunit/phpunit": "~7.5 | ~9.5",
10+
"squizlabs/php_codesniffer": "^3.5",
11+
"corpus/coding-standard": "^0.1.0",
12+
"friendsofphp/php-cs-fixer": "^2.17"
1013
},
1114
"license": "MIT",
1215
"authors": [

‎phpcs.xml.dist

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<?xml version="1.0"?>
2+
<ruleset>
3+
4+
<file>src</file>
5+
<file>test</file>
6+
7+
<rule ref="Corpus"/>
8+
9+
</ruleset>

0 commit comments

Comments
 (0)