Download the PHP package spryker/architecture-sniffer without Composer
On this page you can find all versions of the php package spryker/architecture-sniffer. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download spryker/architecture-sniffer
More information about spryker/architecture-sniffer
Files in spryker/architecture-sniffer
Package architecture-sniffer
Short Description Spryker Architecture Sniffer
License MIT
Homepage https://spryker.com
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package architecture-sniffer
Architecture Sniffer
Architecture Sniffer for Spryker core, eco-system and applications.
Priority Levels
1: API and critical2: Non critical (nice to have)3: Experimental (inspected code needs further fixing)
We use and recommend minimum priority 2 by default for local and CI checks.
Note: Lower priorities (higher numbers) always include the higher priorities (lower numbers).
Usage
Make sure you include the sniffer as require-dev dependency:
Spryker Usage
When using Spryker you can use the Spryker CLI console command for it:
Verbose output is recommended here.
Manual Usage
You can also manually run the Architecture Sniffer from console by using:
Note: Lower priorities always include the higher priorities in the validation process.
Including the sniffer in PHPStorm
Add a new custom ruleset under Editor -> Inspections -> PHP -> PHP Mess Detector validation.
Name it Architecture Sniffer for example.
The customer ruleset is defined in vendor/spryker/architecture-sniffer/src/ruleset.xml
Check Mess Detector Settings
Under Framework & Languages -> PHP -> Mess Detector you need to define the configuration and set the path to your phpmd (vendor/bin/phpmd). Use local and run Validate to see if it works.
Writing new sniffs
Add them to inside src folder and add tests in tests with the same folder structure.
Don't forget to update ruleset.xml.
Every sniff needs a description as full sentence:
Every sniff needs to implement either the ClassAware, FunctionAware, InterfaceAware, or MethodAware interface to be recognised.
To validate that sniffer recognises your rule, check if your rule is listed in Zed UI > Maintenance > Architecture sniffer.
Also note:
- The rule names must be unique across the rulesets.
- Each rule should contain only one "check".
- Each rule always outputs also the reason (violation), not just the occurrence.
Setup
Run
and
Testing
Don't forget to test your changes:
Running code-sniffer on this project
Make sure this repository is Spryker coding standard conform:
If you want to fix the fixable errors, use
Once everything is green you can make a PR with your changes.
All versions of architecture-sniffer with dependencies
laminas/laminas-config Version ^2.5.1 || ^3.1.0
laminas/laminas-filter Version ^2.5.1
phpdocumentor/reflection-docblock Version ^5.3.0
phpmd/phpmd Version ^2.10.0
symfony/finder Version ^4.0.0 || ^5.0.0 || ^6.0.0