chore: add phpcs, phpstan, psalm, phpunit, captainhook + CI #21
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,11 @@ | ||
| .idea/ | ||
| .vscode/ | ||
| .DS_Store | ||
| vendor/ | ||
| composer.lock | ||
| .phpunit.cache/ | ||
| .phpunit.result.cache | ||
| .phpcs-cache | ||
| .phpstan-cache/ | ||
| .psalm-cache/ | ||
| *.log |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| { | ||
| "config": { | ||
| "run-mode": "php" | ||
| }, | ||
| "pre-commit": { | ||
| "enabled": true, | ||
| "actions": [ | ||
| { | ||
| "action": "vendor/bin/phpcbf {$STAGED_FILES|of-type:php}", | ||
| "conditions": [ | ||
| { | ||
| "exec": "\\CaptainHook\\App\\Hook\\Condition\\FileStaged\\OfType", | ||
| "args": ["php"] | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "action": "vendor/bin/phpcs {$STAGED_FILES|of-type:php}", | ||
| "conditions": [ | ||
| { | ||
| "exec": "\\CaptainHook\\App\\Hook\\Condition\\FileStaged\\OfType", | ||
| "args": ["php"] | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "action": "vendor/bin/phpstan analyse {$STAGED_FILES|of-type:php}", | ||
| "conditions": [ | ||
| { | ||
| "exec": "\\CaptainHook\\App\\Hook\\Condition\\FileStaged\\OfType", | ||
| "args": ["php"] | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| }, | ||
| "commit-msg": { | ||
| "enabled": false, | ||
| "actions": [] | ||
| }, | ||
| "pre-push": { | ||
| "enabled": true, | ||
| "actions": [ | ||
| { "action": "composer psalm" } | ||
| ] | ||
| }, | ||
| "prepare-commit-msg": { | ||
| "enabled": false, | ||
| "actions": [] | ||
| }, | ||
| "post-commit": { | ||
| "enabled": false, | ||
| "actions": [] | ||
| }, | ||
| "post-merge": { | ||
| "enabled": false, | ||
| "actions": [] | ||
| }, | ||
| "post-checkout": { | ||
| "enabled": false, | ||
| "actions": [] | ||
| }, | ||
| "post-rewrite": { | ||
| "enabled": false, | ||
| "actions": [] | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -28,6 +28,22 @@ | |
| "magento/module-catalog-graph-ql": "*", | ||
| "magento/module-store-graph-ql": "*" | ||
| }, | ||
| "require-dev": { | ||
| "squizlabs/php_codesniffer": "^3.7", | ||
| "magento/magento-coding-standard": "*", | ||
| "dealerdirect/phpcodesniffer-composer-installer": "^1.0", | ||
| "phpstan/phpstan": "^1.10", | ||
| "vimeo/psalm": "^6.0 <6.5", | ||
| "phpunit/phpunit": "^9.6 || ^10.0", | ||
| "captainhook/captainhook": "^5.22", | ||
| "captainhook/plugin-composer": "^5.3" | ||
| }, | ||
| "repositories": { | ||
| "magento": { | ||
| "type": "composer", | ||
| "url": "https://repo.magento.com/" | ||
| } | ||
| }, | ||
| "autoload": { | ||
| "files": [ | ||
| "Analytics/registration.php", | ||
|
|
@@ -41,5 +57,28 @@ | |
| "BradSearch\\ProductFeatures\\": "ProductFeatures/", | ||
| "BradSearch\\SearchGraphQl\\": "SearchGraphQl/" | ||
| } | ||
| }, | ||
| "scripts": { | ||
| "post-install-cmd": "@register-phpcs-paths", | ||
| "post-update-cmd": "@register-phpcs-paths", | ||
| "register-phpcs-paths": "phpcs --config-set installed_paths vendor/magento/magento-coding-standard,vendor/phpcsstandards/phpcsutils,vendor/magento/php-compatibility-fork", | ||
|
Comment on lines
+62
to
+64
There was a problem hiding this comment. The manual registration of PHPCS paths via |
||
| "phpcs": "phpcs", | ||
| "phpcbf": "phpcbf", | ||
| "phpstan": "phpstan analyse --memory-limit=1G", | ||
| "psalm": "psalm", | ||
| "test": "phpunit", | ||
| "check": [ | ||
| "@phpcs", | ||
| "@phpstan", | ||
| "@psalm" | ||
| ] | ||
| }, | ||
| "config": { | ||
| "allow-plugins": { | ||
| "dealerdirect/phpcodesniffer-composer-installer": true, | ||
| "captainhook/plugin-composer": true, | ||
| "magento/composer-dependency-version-audit-plugin": true | ||
| }, | ||
| "sort-packages": true | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| <?xml version="1.0"?> | ||
| <ruleset name="BradSearch_MagentoExtension"> | ||
| <description>PHP_CodeSniffer ruleset for bradsearch/magento-extension. Extends Magento2.</description> | ||
|
|
||
| <arg name="basepath" value="."/> | ||
| <arg name="extensions" value="php,phtml"/> | ||
| <arg name="colors"/> | ||
| <arg name="severity" value="10"/> | ||
|
|
||
| <file>Analytics</file> | ||
| <file>Autocomplete</file> | ||
| <file>ProductFeatures</file> | ||
| <file>SearchGraphQl</file> | ||
|
|
||
| <exclude-pattern>*/Test/*</exclude-pattern> | ||
| <exclude-pattern>*/vendor/*</exclude-pattern> | ||
|
|
||
| <rule ref="Magento2"/> | ||
|
|
||
| <!-- Baselined existing violations. Remove each exclusion as the underlying | ||
| code is refactored. See issue tracker for per-file remediation plans. --> | ||
|
|
||
| <!-- SearchGraphQl plugins read raw query string params to honour | ||
| GraphQL nested filter semantics pre-routing. Refactor to use | ||
| Magento\Framework\App\RequestInterface when reworking these plugins. --> | ||
| <rule ref="Magento2.Security.Superglobal.SuperglobalUsageError"> | ||
| <exclude-pattern>SearchGraphQl/Plugin/CatalogGraphQl/Model/Resolver/Aggregations\.php</exclude-pattern> | ||
| <exclude-pattern>SearchGraphQl/Plugin/CatalogGraphQl/Model/Resolver/Products\.php</exclude-pattern> | ||
| </rule> | ||
|
|
||
| <!-- Immutable value objects in SearchGraphQl/Model/Data are intentionally | ||
| final (they hold BradSearch API response data; not meant to be | ||
| overridden by plugins). Allowed by exception. --> | ||
| <rule ref="Magento2.PHP.FinalImplementation.FoundFinal"> | ||
| <exclude-pattern>SearchGraphQl/Model/Data/*\.php</exclude-pattern> | ||
| </rule> | ||
| </ruleset> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
| xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.5/phpunit.xsd" | ||
| bootstrap="vendor/autoload.php" | ||
| colors="true" | ||
| cacheResultFile=".phpunit.cache/result"> | ||
| <testsuites> | ||
| <testsuite name="Unit"> | ||
| <directory>ProductFeatures/Test/Unit</directory> | ||
| <directory>SearchGraphQl/Test/Unit</directory> | ||
| </testsuite> | ||
| </testsuites> | ||
| <coverage> | ||
| <include> | ||
| <directory>Analytics</directory> | ||
| <directory>Autocomplete</directory> | ||
| <directory>ProductFeatures</directory> | ||
| <directory>SearchGraphQl</directory> | ||
| </include> | ||
| <exclude> | ||
| <directory>*/Test</directory> | ||
| <file>*/registration.php</file> | ||
| </exclude> | ||
| </coverage> | ||
| </phpunit> |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The README indicates that PHPStan runs at level 6, but the configuration in
phpstan.neon.distis set to level 5. This discrepancy should be resolved to provide accurate documentation for contributors.