[Slim] Add PHP CodeSniffer to check coding style #897
Merged
Conversation
This file contains 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
We follow PSR-2 coding style guide in PHP generators. It might be convenient for users to specify own coding standard without modifying templates. That's why I've added this option. At first, I thought to add option validation and accept only standards from predefined list. But this option also can be a full path to the standard's root directory, I've changed my mind. User should use this option with caution. Ref to all PHP CodeSniffer CLI options: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Usage
wing328
approved these changes
Aug 26, 2018
|
@ybelenko thanks for the PR, which has been included in the v3.2.3 release: https://twitter.com/oas_generator/status/1035200785066254336 |
A-Joshi
pushed a commit
to ihsmarkitoss/openapi-generator
that referenced
this pull request
Feb 27, 2019
* [Slim] Add PHP CodeSniffer package * [Slim] Add phpcsStandard generator option We follow PSR-2 coding style guide in PHP generators. It might be convenient for users to specify own coding standard without modifying templates. That's why I've added this option. At first, I thought to add option validation and accept only standards from predefined list. But this option also can be a full path to the standard's root directory, I've changed my mind. User should use this option with caution. Ref to all PHP CodeSniffer CLI options: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Usage * [Slim] Extend readme with PHP CodeSniffer docs * [Slim] Format templates to meet PSR-2 * [Slim] Refresh samples
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
PR checklist
./bin/to update Petstore sample so that CIs can verify the change. (For instance, only need to run./bin/{LANG}-petstore.shand./bin/security/{LANG}-petstore.shif updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in.\bin\windows\.master,3.3.x,4.0.x. Default:master.Description of the PR
As defined in guide of contributing, PHP templates should meet PSR-2 coding style.
I've added PHP CodeSniffer package to check source code on violations against user defined standard. User can change coding standard with
phpcsStandardconfig option.'PSR12'is default(checks against PSR-1 and PSR-2)I think it's perfect time to add linters and code formatters while generator is small like Slim now. It will be easier to update templates and check them automatically every next PR. By this reason I suggest to merge this PR before #735.
cc @jebentier @dkarlovi @mandrean @jfastnacht @ackintosh