From 9a1fd4f4969a5cd1e63299b32ee276637efeb48f Mon Sep 17 00:00:00 2001 From: "Hagen, Kody J" Date: Fri, 22 May 2026 21:33:13 -0500 Subject: [PATCH 1/2] docs(docs): add README documenting shipped binaries and usage --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..4fc867e --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# @bsu/wp-coding-standards + +PHP tool binaries for BSU WordPress development. Installed via npm, ships the following tools in `vendor/bin/`: + +| Binary | Version | Purpose | +|---|---|---| +| `phpcs` | 4.x | PHP CodeSniffer — enforces BSUWordPressCS coding standards | +| `phpcbf` | 4.x | PHP Code Beautifier — auto-fixes PHPCS violations | +| `phpstan` | 1.x | PHPStan — static analysis for type safety and correctness | + +## Usage in bsuwp + +These binaries are referenced directly by path in `bsuwp/package.json` scripts: + +```bash +npm run lint:php # phpcs via this package +npm run fix:php # phpcbf via this package +npm run analyse:php # phpstan via this package +``` + +## Updating + +To update tool versions, modify `composer.json` and run `composer update`, then commit the updated `composer.lock` and `vendor/` in a PR to `release`. From aa75d4a1faf1298aa048dc5ee89ac09d602eac82 Mon Sep 17 00:00:00 2001 From: "Hagen, Kody J" Date: Fri, 22 May 2026 22:00:41 -0500 Subject: [PATCH 2/2] fix(config): commit CodeSniffer.conf with installed_paths including BSUWordPressCS --- vendor/phpcsstandards/php_codesniffer/CodeSniffer.conf | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 vendor/phpcsstandards/php_codesniffer/CodeSniffer.conf diff --git a/vendor/phpcsstandards/php_codesniffer/CodeSniffer.conf b/vendor/phpcsstandards/php_codesniffer/CodeSniffer.conf new file mode 100644 index 0000000..1418d3c --- /dev/null +++ b/vendor/phpcsstandards/php_codesniffer/CodeSniffer.conf @@ -0,0 +1,5 @@ + '../../phpcsstandards/phpcsextra,../../phpcsstandards/phpcsutils,../../wp-coding-standards/wpcs,../../../../BSUWordPressCS', +); +?> \ No newline at end of file