Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Slim] Add PHP CodeSniffer config template #1764

Merged
merged 5 commits into from
Dec 29, 2018

Conversation

ybelenko
Copy link
Contributor

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh and ./bin/security/{LANG}-petstore.sh if 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\.
  • Filed the PR against the correct branch: master, 3.4.x, 4.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

Recommended way to configure PHP CodeSniffer:

If you run PHP_CodeSniffer without specifying a coding standard, PHP_CodeSniffer will look in the current directory, and all parent directories, for a file called either .phpcs.xml, phpcs.xml, .phpcs.xml.dist, or phpcs.xml.dist. If found, configuration information will be read from this file, including the files to check, the coding standard to use, and any command line arguments to apply.

Note: If multiple default configuration files are found, PHP_CodeSniffer will select one using the following order: .phpcs.xml, phpcs.xml, .phpcs.xml.dist, phpcs.xml.dist

Ref: Using a Default Configuration File

Generator cli option phpcsStandard is deprecated as not necessary anymore.

Upgrade note

Do not use phpcsStandard cli option during server stubs generation.
Override phpcs.xml.dist in root folder with phpcs.xml to change config.

PHPUnit and PHP_CodeSniffer provides the same developing pattern when
user overrides global config with local one. In local config he can
set environment variables. Official doc recommends to not commit local
config files.
Now user have full freedom to override config file. This option is not
used and not necessary anymore.
Copy link
Member

@wing328 wing328 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ackintosh ackintosh merged commit 5400a7e into OpenAPITools:master Dec 29, 2018
@ybelenko ybelenko deleted the slim_advanced_codesniffer branch December 29, 2018 16:06
jimschubert added a commit to jimschubert/openapi-generator that referenced this pull request Dec 31, 2018
* master: (26 commits)
  Delete unused method (OpenAPITools#1744)
  Use JsonNullable wrapper on nullable/x-nullable fields (OpenAPITools#1762)
  Add an option to use reflection in equals, hashCode (Java client) (OpenAPITools#1767)
  [Slim] Encode path to support non-latin characters (OpenAPITools#1687)
  [elm] Add support for sending headers (OpenAPITools#1704)
  Add test case for InlineModelResolver: inline array response (OpenAPITools#1778)
  fix group parameter logic (OpenAPITools#1779)
  Add test case for InlineModelResolver: inline array request body (OpenAPITools#1777)
  Add test case for InlineModelResolver: inline array schema (OpenAPITools#1772)
  Fix type inference error (OpenAPITools#1773)
  skip default value for contaier in spring (OpenAPITools#1725)
  [Slim] Add PHP CodeSniffer config template (OpenAPITools#1764)
  Use CompareNetObject for object comparison in C# client (refactor) (OpenAPITools#1765)
  Add test case for InlineModelResolver (OpenAPITools#1771)
  Add online gen tests (OpenAPITools#1759)
  Resolve inline models before preprocess (OpenAPITools#1761)
  better handling of allOf (composition) (OpenAPITools#1757)
  Fix UUID support (OpenAPITools#1746)
  Use appInfo.version for podspec (OpenAPITools#1760)
  [Swift 4] Add `createURLRequest` method (OpenAPITools#1727)
  ...
A-Joshi pushed a commit to ihsmarkitoss/openapi-generator that referenced this pull request Feb 27, 2019
* [Slim] Add PHP_CodeSniffer config template

* [Slim] Update doc

* [Slim] Add local configs to gitignore

PHPUnit and PHP_CodeSniffer provides the same developing pattern when
user overrides global config with local one. In local config he can
set environment variables. Official doc recommends to not commit local
config files.

* [Slim] Remove phpcsStandard CLI option

Now user have full freedom to override config file. This option is not
used and not necessary anymore.

* [Slim] Refresh samples
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants