Skip to content

Commit

Permalink
[FEATURE] add phpcs, phpmd and phpcbf qa tests
Browse files Browse the repository at this point in the history
  • Loading branch information
sebastianstein committed Oct 28, 2022
1 parent 093091d commit 00962f4
Show file tree
Hide file tree
Showing 4 changed files with 79 additions and 4 deletions.
17 changes: 17 additions & 0 deletions .phpcs.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<?xml version="1.0"?>
<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
name="PHPCS ruleset"
xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/squizlabs/PHP_CodeSniffer/master/phpcs.xsd"
>
<description>Test Classes and Tests. Config optimized for local CLO and CI/CD.</description>

<rule ref="PSR12"/>

<file>Classes</file>

<arg name="extensions" value="php" />
<arg name="basepath" value="."/>
<arg name="colors"/>
<arg name="parallel" value="75"/>
<arg value="nps"/>
</ruleset>
35 changes: 35 additions & 0 deletions .phpmd.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<?xml version="1.0"?>
<ruleset name="PHPMD ruleset"
xmlns="http://pmd.sf.net/ruleset/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 http://pmd.sf.net/ruleset_xml_schema.xsd"
xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd"
>
<description>
Adapted the phpmd default config.
* Import all rule sets
* Allow variables as long as 25 chars
</description>

<rule ref="rulesets/codesize.xml"/>
<rule ref="rulesets/controversial.xml">
<exclude name="Superglobals"/>
</rule>
<rule ref="rulesets/design.xml"/>
<rule ref="rulesets/naming.xml">
<exclude name="LongVariable"/>
</rule>
<rule ref="rulesets/naming.xml/LongVariable">
<properties>
<property name="maximum" value="26"/>
</properties>
</rule>
<rule ref="rulesets/unusedcode.xml">
<exclude name="UnusedFormalParameter"/>
</rule>
<rule ref="rulesets/cleancode.xml">
<exclude name="StaticAccess"/>
<exclude name="ElseExpression"/>
<exclude name="LongVariable"/>
</rule>
</ruleset>
11 changes: 7 additions & 4 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,10 @@
],
"license": "GPL-2.0+",
"require": {
"php": "^8.0",
"php": "^7.4 || ^8.0",
"ext-json": "*",
"typo3/cms-core": "^11.5"
}
,
},
"require-dev": {
"helhum/typo3-console": "^7.0",
"roave/security-advisories": "dev-latest",
Expand All @@ -42,8 +41,12 @@
"typo3/cms-recordlist": "^11.5",
"typo3/cms-rte-ckeditor": "^11.5",
"typo3/cms-tstemplate": "^11.5",
"typo3/cms-lowlevel": "^11.5"
"typo3/cms-lowlevel": "^11.5",
"typo3/testing-framework": "^6.12",
"phpmd/phpmd": "^2",
"phpcompatibility/php-compatibility": "*"
},
"prefer-stable" : true,
"autoload": {
"psr-4": {
"In2code\\In2studyfinder\\": "Classes"
Expand Down
20 changes: 20 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,26 @@ npm install
#### Frontend
```npm run build:frontend```

### Testing (phpcs, phpmd)

PHPCS:
```
ddev ssh
./.build/bin/phpcs
```

PHPMD:
```
ddev ssh
./.build/bin/phpmd Classes/ ansi .phpmd.xml
```

PHPCBF:
```
ddev ssh
./.build/bin/phpcbf
```

## FAQ

* Q1: Can I use fe_users or tt_address for the persons?
Expand Down

0 comments on commit 00962f4

Please sign in to comment.