Pre-commit hook: Only use local copies of phpcs and phpcbf

[ockham]

Changes proposed in this Pull Request

In theory, we run the PHPCBF auto-formatter in our pre-commit hook. In practice, this has been failing, and I suspect has been the source of a number of PRs being submitted with PHP lint errors that PHPCBF could auto-fix -- see e.g. #43817.

The reason for this is that our pre-commit hook will preferably use a system-wide installed copy of those tools; however, there's no guarantee that dependencies, such as the WordPress Coding Standards, are also available globally. They will however be installed locally through a simply compose install, as will PHPCS and PHPCBF, and our pre-commit hook already has messaging to instruct the user to do so.

The fix is thus to never use the globally installed versions of PHPCS and PHPCBF, but always the locally installed ones, and if they can't be found, instruct the user to run compose install.

Testing instructions

Prerequisites:

• Make sure you don't have WordPress Coding Standards globally installed. You can verify by running phpcs -i.

To reproduce the issue:

• Remove your vendor/ subfolder from your local Calypso directory (this holds files installed by Composer).
• Make a change to a PHP file in the WordPress.com Editing Toolkit plugin (formerly known as FSE) that includes something that PHPCS will fix (e.g. some whitespace change). E.g.

diff --git a/apps/full-site-editing/full-site-editing-plugin/block-patterns/patterns/call-to-action-02.php b/apps/full-site-editing/full-site-editing-plugin/block-patterns/patterns/call-to-action-02.php
index a67ca71017..4ee456fb24 100644
--- a/apps/full-site-editing/full-site-editing-plugin/block-patterns/patterns/call-to-action-02.php
+++ b/apps/full-site-editing/full-site-editing-plugin/block-patterns/patterns/call-to-action-02.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Call to Action pattern.
+ * Call to Action pattern. Blahblah
  *
  * @package A8C\FSE
  */
@@ -37,8 +37,8 @@ $markup = '
 ';
 
 return array(
-       'title'         => esc_html__( 'Call to Action', 'full-site-editing' ),
-       'categories'    => array( 'call-to-action' ),
-       'content'       => $markup,
-       'viewportWidth' => 1280,
+       'title'           => esc_html__( 'Call to Action', 'full-site-editing' ),
+       'categories'      => array( 'call-to-action' ),
+       'content'         => $markup,
+       'viewportWidth'   => 1280,
 );

Make sure your editor isn't configured to format on save!

• Commit these changes.
• Note that the commit will fail with the following error:

PHPCBF formatting staged file: apps/full-site-editing/full-site-editing-plugin/block-patterns/patterns/call-to-action-02.php
ERROR: Referenced sniff "WordPress" does not exist

Which isn't very helpful 🙁

To reproduce the fix:

• Now run the same instructions on this branch.
• This time, committing will fail with:

PHPCBF formatting staged file: apps/full-site-editing/full-site-editing-plugin/block-patterns/patterns/call-to-action-02.php
COMMIT ABORTED: Working with PHP files in this repository requires the PHP Code Sniffer and its dependencies to be installed. Make sure you have composer installed on your machine and from the root of this repository, run `composer install`.

• Follow these instructions (run composer install).
• Try committing again. This time, it should pass.
• Inspect the commit. The whitespace changes should be formatted according to standard.

[matticbot]

Test live: https://calypso.live/?branch=update/pre-commit-hook-command-locations

[matticbot]

This PR does not affect the size of JS and CSS bundles shipped to the user's browser.

Generated by performance advisor bot at iscalypsofastyet.com.

[matticbot]

Caution: This PR affects files in the Editing Toolkit Plugin on WordPress.com
Please ensure your changes work on WordPress.com before merging.

D47506-code has been created so you can easily test it on your sandbox. See this FieldGuide page about developing the Editing Toolkit Plugin for more info: PCYsg-ly5-p2

[noahtallen]

This matches a similar thing I experienced a week ago, and the same thing fixed it. Thanks for the standalone fix :)

btw, do we know if this hook runs if the changes are only JS-related? We probably want to avoid forcing everyone to use composer install just for changes in normal calypso