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

[TASK] Rename the PHPCS configuration file #891

Merged
merged 1 commit into from
Jun 14, 2020
Merged

Conversation

oliverklee
Copy link
Contributor

There are two possible file names for the PHP_CodeSniffer configuration
file:

  • phpcs.xml.dist
  • phpcs.xml

The intention of the first file name is: "This is a template. Please copy
it, modify it and then save it under the corresponding file name without
the .dist` suffix."

As our configuration file is not a template, we now use the non-template
variant.

As an additional benefit, IDEs usually recognize the .xml suffix
without any additional configuration.

There are two possible file names for the PHP_CodeSniffer configuration
file:

- `phpcs.xml.dist`
- `phpcs.xml`

The intention of the first file name is: "This is a template. Please copy
it, modify it and then save it under the corresponding file name without
the .dist` suffix."

As our configuration file is not a template, we now use the non-template
variant.

As an additional benefit, IDEs usually recognize the `.xml` suffix
without any additional configuration.
@oliverklee oliverklee added this to the 5.0.0 milestone Jun 14, 2020
@oliverklee oliverklee self-assigned this Jun 14, 2020
Copy link
Contributor

@JakeQZ JakeQZ left a comment

Choose a reason for hiding this comment

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

Ah, I see, this would have been a bit like having wp-config-sample.php as the actual configuration file.

@JakeQZ JakeQZ merged commit 6af7f60 into master Jun 14, 2020
@JakeQZ JakeQZ deleted the task/phpcs-config-file branch June 14, 2020 12:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants