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.

Sign up for GitHub

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

Allow standard to be selected in composer.json #1

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Allow standard to be selected in composer.json #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
/vendor/
/.idea/
Copy link
Member

Choose a reason for hiding this comment

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

This ignore should go into your global gitignore list, as it is not a direct artifact of the project, but rather a detail of your personal environment.

14 changes: 11 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,17 @@ It should just work when you `git commit`.

## Internals

By default, of the 5 different WordPress coding standards (`WordPress-VIP`, `WordPress`, `WordPress-Extra`, `WordPress-Docs` and `WordPress-Core`), this one uses the `WordPress-Extra` one.

If you need to change it, currently you need to edit the Sniff file. Contributions on how to make this dynamic are welcome (`.env` file, different sniffs for each and choosing the appropriate hooks).
WPCS provides 5 different coding standards (`WordPress-VIP`, `WordPress`,
`WordPress-Extra`, `WordPress-Docs` and `WordPress-Core`). By default this uses
`WordPress-Extra`. If you want to use another one of the standards, you can
specify it in your project's composer.json's `extra` key:
Copy link
Member

Choose a reason for hiding this comment

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

Reorder for readability

Suggested change
specify it in your project's composer.json's `extra` key:
specify it in the `extra` key of your project's `composer.json` file:

```json
"extra": {
"php-composter-phpcs-wpcs": {
"standard": "WordPress-VIP"
}
}
```

## Contributing

Expand Down
8 changes: 7 additions & 1 deletion src/Sniffer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,15 @@ public function preCommit()

echo 'Running PHP CodeSniffer in ' . $this->root . PHP_EOL;
$sniffer = new PHP_CodeSniffer_CLI();
@$config = $this->getExtraKey('php-composter-phpcs-wpcs', [
Copy link
Member

Choose a reason for hiding this comment

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

Please avoid the "shut-up" operator (@ ). The getExtraKey() already verifies that the key does indeed exist and falls back to the value you provide if not. Any other error should either be dealt with separately, or bubble up because it might be pointing to a bigger issue.

Suggested change
@$config = $this->getExtraKey('php-composter-phpcs-wpcs', [
$config = $this->getExtraKey('php-composter-phpcs-wpcs', [

'standard' => 'WordPress-Extra'
]);

ob_start();
$numErrors = $sniffer->process(array('standard' => 'WordPress-Extra', 'files' => $files));
$numErrors = $sniffer->process([
Copy link
Member

Choose a reason for hiding this comment

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

Did you think about merging the $files into the $config array here? This way, one could even pass other PHPCS/WPCS settings through the configuration in composer.json. Not sure there's much that makes sense, though...

'standard' => $config['standard'],
'files' => $files
]);
$output = ob_get_clean();

echo $output . PHP_EOL;
Expand Down