Download the PHP package spryker/project-architecture-sniffer without Composer
On this page you can find all versions of the php package spryker/project-architecture-sniffer. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download spryker/project-architecture-sniffer
More information about spryker/project-architecture-sniffer
Files in spryker/project-architecture-sniffer
Package project-architecture-sniffer
Short Description Spryker Project Architecture Sniffer
License MIT
Homepage https://spryker.com
Informations about the package project-architecture-sniffer
Project Architecture Sniffer
Architecture Sniffer for Spryker Projects. Over 80
rules adapted for Spryker Projects.
Priority Levels
-
1
: Сritical -
2
: Major -
3
: Medium 4
: Minor
We recommend minimum priority 3
by default for local and CI checks.
Note: Lower priorities (higher numbers) always include the higher priorities (lower numbers).
Content
29
adapted PHPMD rules39
adapted Spryker Architecture sniffer rules13
new Project Architecture sniffer rules
Usage
Make sure you include the sniffer as require-dev
dependency:
Running
Find command line option.
You can run the Project Architecture Sniffer from console by using:
Baseline
Existing projectsand demo-shops may contain rule violations. The decision to refactor existing violations may be at the discretion of each project individually. It is recommended to approach this in a differentiated manner. To integrate rules into the project immediately, there recommended to generate a baseline and move forward. It is also permissible to suppress rules on a case-by-case basis.
Ruleset
Ruleset that contains all documented rules
Ruleset that contains Project Architecture sniffer rules
Ruleset that contains PHPMD rules
More
Find vendor/spryker/project-architecture-sniffer/src/
Local Code Review Usage
Debugging
Roadmap (expected rules)
feel free to suggest
Writing new sniffs
Add them to inside src/Project folder with the same folder structure.
Don't forget to update ruleset.xml
.
Every sniff needs to implement either the ClassAware
, FunctionAware
, InterfaceAware
, or MethodAware
interface to be recognised.
Setup
Run
Testing
no testing at this moment
Running code-sniffer on this project
Make sure this repository is Spryker coding standard conform:
If you want to fix the fixable errors, use
If you want to run phpstan
Once everything is green you can make a PR with your changes.