diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..3f81e6e --- /dev/null +++ b/.editorconfig @@ -0,0 +1,18 @@ +root = true + +[*] +charset = utf-8 +end_of_line = lf +trim_trailing_whitespace = true +insert_final_newline = true +indent_style = tab +indent_size = 4 + +[*.{ts,tsx,js,jsx,scss,css,json,yaml,yml,feature,xml}] +indent_style = space +indent_size = 2 + +# Dotfiles +[.*] +indent_style = space +indent_size = 2 diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..4688723 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,28 @@ +# +# Exclude these files from release archives. +# +# This will also make the files unavailable when using Composer with `--prefer-dist`. +# +# Via WPCS. +# +/.github export-ignore +/.phpcs export-ignore +/phpcs.xml export-ignore +/phpunit.xml export-ignore +/tests export-ignore +/configure.php export-ignore +/Makefile export-ignore + +# +# Auto detect text files and perform LF normalization. +# +# http://davidlaing.com/2012/09/19/customise-your-gitattributes-to-become-a-git-ninja/ +# +* text=auto + +# +# The above will handle all files not found below. +# +*.md text +*.php text +*.inc text diff --git a/.github/workflows/coding-quality.yml b/.github/workflows/coding-quality.yml new file mode 100644 index 0000000..30ce26e --- /dev/null +++ b/.github/workflows/coding-quality.yml @@ -0,0 +1,13 @@ +name: Code Quality + +on: + pull_request: + branches: + - main + +jobs: + code-quality: + if: github.event.pull_request.draft == false + uses: alleyinteractive/.github/.github/workflows/php-code-quality.yml@main + with: + php: '8.2' diff --git a/.github/workflows/coding-standards.yml b/.github/workflows/coding-standards.yml new file mode 100644 index 0000000..e2be7a9 --- /dev/null +++ b/.github/workflows/coding-standards.yml @@ -0,0 +1,13 @@ +name: Coding Standards + +on: + pull_request: + branches: + - main + +jobs: + coding-standards: + if: github.event.pull_request.draft == false + uses: alleyinteractive/.github/.github/workflows/php-coding-standards.yml@main + with: + php: '8.2' diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a854579 --- /dev/null +++ b/.gitignore @@ -0,0 +1,26 @@ +# Build files +build +vendor +composer.lock +node_modules + +# Log files +*.log + +# Cache files +.phpcs/*.json +.phpunit.result.cache + +# Ignore temporary OS files +.DS_Store +.DS_Store? +.Spotlight-V100 +.Trashes +ehthumbs.db +Thumbs.db +.thumbsdb + +# IDE files +*.code-workspace +.idea +.vscode diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..03c1c05 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ +# Changelog + +This library adheres to [Semantic Versioning](https://semver.org/) and [Keep a CHANGELOG](https://keepachangelog.com/en/1.0.0/). + +## 1.0.0 + +Initial release. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d159169 --- /dev/null +++ b/LICENSE @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..07c853b --- /dev/null +++ b/README.md @@ -0,0 +1,132 @@ +# Block Audit Command + +This is a WP-CLI package for auditing block usage in post content, which can help decide which blocks to prioritize before a content migration or redesign. + +Quick links: [Using](#using) | [Installing](#installing) | [About](#about) + +## Using + +This package implements the following commands: + +### wp block-audit run + +Report how many of each type of block there is in post content and aggregated details about them. + +The report includes the number of times each block is used, the post types it's used in, and details comprising: + +- For all blocks, the count of 'align' attribute values. +- For 'core/heading' blocks, the count of each heading level used. +- For 'core/embed' blocks, the count of each embed provider used. + +You can add more details to the report with the `alley_block_audit_block_type_details` and `alley_block_audit_{$block_name}_block_type_details` filters: + +```php +add_filter( + 'alley_block_audit_block_type_details', + function ( $details, $block_name, $attrs, $inner_html, $block ) { + if ( isset( $attrs['fontSize'] ) && is_string( $attrs['fontSize'] ) ) { + $details['fontSize'][ $attrs['fontSize'] ] ??= 0; + $details['fontSize'][ $attrs['fontSize'] ]++; + } + + return $details; + }, + 10, + 5, +); + +add_filter( + 'alley_block_audit_core/image_block_type_details', + function ( $details, $block_name, $attrs, $inner_html, $block ) { + if ( isset( $attrs['aspectRatio'] ) && is_string( $attrs['aspectRatio'] ) ) { + $details['aspectRatio'][ $attrs['aspectRatio'] ] ??= 0; + $details['aspectRatio'][ $attrs['aspectRatio'] ]++; + } + + return $details; + }, + 10, + 5, +); +``` + +~~~ +wp block-audit run [--=] [--format=] [--verbose] [--rewind] +~~~ + +**OPTIONS** + + [--=] + One or more args to pass to WP_Query except for 'order', 'orderby', or 'paged'. + + [--format=] + Render output in a particular format. + --- + default: table + options: + - table + - csv + - json + - count + - yaml + --- + + [--verbose] + Turn on verbose mode. + + [--rewind] + Resets the cursor so the next time the command is run it will start from the beginning. + +**EXAMPLES** + + $ wp block-audit run --post_type=post,page + +-----------------------------------+-------+------------------------------------------------------------+-----------------+----------------------------------------------------------------------+ + | Block Name | Count | Example URL | Post Types | Details | + +-----------------------------------+-------+------------------------------------------------------------+-----------------+----------------------------------------------------------------------+ + | core/archives | 3 | https://www.example.com/2023/01/13/widgets-block-category/ | ["post"] | | + | core/button | 12 | https://www.example.com/2023/01/13/design-category-blocks/ | ["post"] | {"align":{"left":2,"center":1,"right":1}} | + | core/code | 2 | https://www.example.com/2023/01/13/text-category-blocks/ | ["post"] | | + | core/column | 40 | https://www.example.com/2023/01/13/design-category-blocks/ | ["post"] | | + | core/columns | 13 | https://www.example.com/2023/01/13/design-category-blocks/ | ["post"] | {"align":{"wide":2,"full":1}} | + | core/cover | 21 | https://www.example.com/2023/01/13/media-category-blocks/ | ["post"] | {"align":{"left":1,"center":2,"full":1,"wide":2}} | + | core/file | 3 | https://www.example.com/2023/01/13/media-category-blocks/ | ["post"] | | + | core/gallery | 10 | https://www.example.com/2023/01/13/media-category-blocks/ | ["post"] | | + | core/group | 25 | https://www.example.com/2023/01/13/design-category-blocks/ | ["post"] | | + | core/heading | 23 | https://www.example.com/2023/01/13/text-category-blocks/ | ["post","page"] | {"H1":2,"H2":11,"H3":4,"H4":2,"H5":2,"H6":2} | + | core/html | 2 | https://www.example.com/2023/01/13/widgets-block-category/ | ["post"] | | + | core/image | 19 | https://www.example.com/2023/01/13/media-category-blocks/ | ["post"] | {"align":{"center":2,"left":2,"right":3,"none":1,"wide":1,"full":1}} | + | core/list | 9 | https://www.example.com/2023/01/13/text-category-blocks/ | ["post"] | | + | core/list-item | 6 | https://www.example.com/2023/01/13/text-category-blocks/ | ["post"] | | + | core/media-text | 6 | https://www.example.com/2023/01/13/media-category-blocks/ | ["post"] | {"align":{"full":1}} | + | core/paragraph | 262 | https://www.example.com/2023/01/13/text-category-blocks/ | ["post","page"] | {"align":{"center":16,"right":1,"left":1}} | + | core/pullquote | 4 | https://www.example.com/2023/01/13/text-category-blocks/ | ["post"] | | + | core/spacer | 4 | https://www.example.com/2023/01/13/design-category-blocks/ | ["post"] | | + | core/table | 4 | https://www.example.com/2023/01/13/text-category-blocks/ | ["post"] | | + +-----------------------------------+-------+---------------------------------------------------------------+-----------------+----------------------------------------------------------------------+ + + +## Installing + +Installing this package requires WP-CLI v1.3.0 or greater. Update to the latest stable release with `wp cli update`. + +Once you've done so, you can install the latest stable version of this package with: + +```bash +wp package install alleyinteractive/wp-block-audit-command:@stable +``` + +You can also install this package with Composer: + +```bash +composer require alleyinteractive/wp-block-audit-command +``` + +## About + +### License + +[GPL-2.0-or-later](https://github.com/alleyinteractive/wp-type-extensions/blob/main/LICENSE) + +### Maintainers + +[Alley Interactive](https://github.com/alleyinteractive) diff --git a/command.php b/command.php new file mode 100644 index 0000000..d2a10f1 --- /dev/null +++ b/command.php @@ -0,0 +1,28 @@ + new Features\Block_Audit_Command() + ) + ) +)->boot(); diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..6f117f4 --- /dev/null +++ b/composer.json @@ -0,0 +1,53 @@ +{ + "name": "alleyinteractive/wp-block-audit-command", + "description": "Audit WordPress block usage in post content.", + "type": "wp-cli-package", + "homepage": "https://github.com/alleyinteractive/wp-block-audit-command", + "license": "GPL-2.0-or-later", + "authors": [ + { + "name": "Alley", + "email": "info@alley.com" + } + ], + "require": { + "php": "^8.1", + "alleyinteractive/composer-wordpress-autoloader": "^1.0", + "alleyinteractive/wp-bulk-task": "dev-main", + "alleyinteractive/wp-match-blocks": "^3.0", + "alleyinteractive/wp-type-extensions": "^2.1" + }, + "require-dev": { + "alleyinteractive/alley-coding-standards": "^2.0", + "szepeviktor/phpstan-wordpress": "^1.1", + "wp-cli/entity-command": "^2.6", + "wp-cli/wp-cli": "^2.10" + }, + "config": { + "allow-plugins": { + "alleyinteractive/composer-wordpress-autoloader": true, + "dealerdirect/phpcodesniffer-composer-installer": true, + "pestphp/pest-plugin": true + }, + "sort-packages": true + }, + "autoload": { + "files": [ + "command.php" + ] + }, + "extra": { + "wordpress-autoloader": { + "autoload": { + "Alley\\WP": "src" + } + } + }, + "minimum-stability": "dev", + "prefer-stable": true, + "scripts": { + "phpcbf": "phpcbf .", + "phpcs": "phpcs .", + "phpstan": "phpstan --memory-limit=512M" + } +} diff --git a/phpcs.xml b/phpcs.xml new file mode 100644 index 0000000..8c0ac54 --- /dev/null +++ b/phpcs.xml @@ -0,0 +1,48 @@ + + + PHP_CodeSniffer standard for alleyinteractive/wp-block-audit-command. + + src/ + tests/ + vendor/ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + tests/* + + diff --git a/phpstan.neon b/phpstan.neon new file mode 100644 index 0000000..1c92546 --- /dev/null +++ b/phpstan.neon @@ -0,0 +1,14 @@ +includes: + - vendor/szepeviktor/phpstan-wordpress/extension.neon + +parameters: + # Level 9 is the highest level + level: max + + scanDirectories: + - vendor/wp-cli/php-cli-tools/lib/ + - vendor/wp-cli/wp-cli/php/ + + paths: + - src/ + - command.php diff --git a/src/features/class-block-audit-command.php b/src/features/class-block-audit-command.php new file mode 100644 index 0000000..9151942 --- /dev/null +++ b/src/features/class-block-audit-command.php @@ -0,0 +1,319 @@ +=] + * : One or more args to pass to WP_Query except for 'order', 'orderby', or 'paged'. + * + * [--format=] + * : Render output in a particular format. + * --- + * default: table + * options: + * - table + * - csv + * - json + * - count + * - yaml + * --- + * + * [--verbose] + * : Turn on verbose mode. + * + * [--rewind] + * : Resets the cursor so the next time the command is run it will start from the beginning. + * + * ## EXAMPLES + * + * $ wp block-audit run --post_type=post,page + * +-----------------------------------+-------+------------------------------------------------------------+-----------------+----------------------------------------------------------------------+ + * | Block Name | Count | Example URL | Post Types | Details | + * +-----------------------------------+-------+------------------------------------------------------------+-----------------+----------------------------------------------------------------------+ + * | core/archives | 3 | https://www.example.com/2023/01/13/widgets-block-category/ | ["post"] | | + * | core/button | 12 | https://www.example.com/2023/01/13/design-category-blocks/ | ["post"] | {"align":{"left":2,"center":1,"right":1}} | + * | core/code | 2 | https://www.example.com/2023/01/13/text-category-blocks/ | ["post"] | | + * | core/column | 40 | https://www.example.com/2023/01/13/design-category-blocks/ | ["post"] | | + * | core/columns | 13 | https://www.example.com/2023/01/13/design-category-blocks/ | ["post"] | {"align":{"wide":2,"full":1}} | + * | core/cover | 21 | https://www.example.com/2023/01/13/media-category-blocks/ | ["post"] | {"align":{"left":1,"center":2,"full":1,"wide":2}} | + * | core/file | 3 | https://www.example.com/2023/01/13/media-category-blocks/ | ["post"] | | + * | core/gallery | 10 | https://www.example.com/2023/01/13/media-category-blocks/ | ["post"] | | + * | core/group | 25 | https://www.example.com/2023/01/13/design-category-blocks/ | ["post"] | | + * | core/heading | 23 | https://www.example.com/2023/01/13/text-category-blocks/ | ["post","page"] | {"H1":2,"H2":11,"H3":4,"H4":2,"H5":2,"H6":2} | + * | core/html | 2 | https://www.example.com/2023/01/13/widgets-block-category/ | ["post"] | | + * | core/image | 19 | https://www.example.com/2023/01/13/media-category-blocks/ | ["post"] | {"align":{"center":2,"left":2,"right":3,"none":1,"wide":1,"full":1}} | + * | core/list | 9 | https://www.example.com/2023/01/13/text-category-blocks/ | ["post"] | | + * | core/list-item | 6 | https://www.example.com/2023/01/13/text-category-blocks/ | ["post"] | | + * | core/media-text | 6 | https://www.example.com/2023/01/13/media-category-blocks/ | ["post"] | {"align":{"full":1}} | + * | core/paragraph | 262 | https://www.example.com/2023/01/13/text-category-blocks/ | ["post","page"] | {"align":{"center":16,"right":1,"left":1}} | + * | core/pullquote | 4 | https://www.example.com/2023/01/13/text-category-blocks/ | ["post"] | | + * | core/spacer | 4 | https://www.example.com/2023/01/13/design-category-blocks/ | ["post"] | | + * | core/table | 4 | https://www.example.com/2023/01/13/text-category-blocks/ | ["post"] | | + * +-----------------------------------+-------+---------------------------------------------------------------+-----------------+----------------------------------------------------------------------+ + * + * @phpstan-param array $args + * @phpstan-param array $assoc_args + * + * @param array $args Positional arguments. + * @param array $assoc_args Associative arguments. + */ + public function run( array $args, array $assoc_args = [] ): void { + global $wpdb; + + $out = []; + + $user_query_args = array_diff_key( $assoc_args, array_flip( [ 'format', 'verbose', 'rewind' ] ) ); + + $bulk_task = new Bulk_Task( + 'audit-blocks-' . md5( (string) wp_json_encode( $user_query_args ) ), + get_flag_value( $assoc_args, 'verbose', false ) + ? new PHP_CLI_Progress_Bar( 'Bulk Task: audit-blocks' ) + : new Null_Progress_Bar(), + ); + + if ( get_flag_value( $assoc_args, 'rewind', false ) ) { + $bulk_task->cursor->reset(); + \WP_CLI::log( 'Rewound the cursor. Run again without the --rewind flag to process posts.' ); + return; + } + + add_filter( 'ep_skip_query_integration', '__return_true' ); + + $query_args = array_merge( + [ + 'post_status' => 'publish', + 'post_type' => array_diff( + // This gets all post types in the DB, regardless of whether they're registered. Useful for migrations. + // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching, WordPress.DB.PreparedSQLPlaceholders.UnsupportedIdentifierPlaceholder + $wpdb->get_col( $wpdb->prepare( 'SELECT DISTINCT post_type FROM %i', $wpdb->posts ) ), + [ 'revision' ], + ), + ], + $user_query_args, + ); + $query_args = self::process_csv_arguments_to_arrays( $query_args ); + if ( isset( $query_args['post_type'] ) && is_string( $query_args['post_type'] ) && 'any' !== $query_args['post_type'] ) { + $query_args['post_type'] = explode( ',', $query_args['post_type'] ); + } + + $bulk_task->run( + $query_args, + function ( \WP_Post $post ) use ( &$out ) { + $blocks = match_blocks( + $post, + [ + 'flatten' => true, + 'skip_empty_blocks' => false, // For counting classic blocks. + ], + ); + + if ( ! is_iterable( $blocks ) ) { + return; + } + + foreach ( $blocks as $block ) { + $block_name = $block['blockName']; + + // Label null blocks as classic blocks if they contain HTML. + if ( ! $block_name ) { + $html = $block['innerHTML'] ?? ''; + $html = trim( $html ); + + if ( ! $html ) { + continue; + } + + $block_name = 'core/classic'; + } + + if ( ! isset( $out[ $block_name ] ) ) { + /** + * Filters the example URL included for a block type. + * + * @param string $example_url The example URL. Defaults to the permalink of the post where the block type was first seen. + */ + $example_url = apply_filters( 'alley_block_audit_block_type_example_url', get_permalink( $post ) ); + + $out[ $block_name ] = [ + 'Block Name' => $block_name, + 'Count' => 0, + 'Example URL' => $example_url, + 'Post Types' => [], + 'Details' => [], + ]; + } + + $out[ $block_name ]['Count']++; + + if ( ! in_array( $post->post_type, $out[ $block_name ]['Post Types'], true ) ) { + $out[ $block_name ]['Post Types'][] = $post->post_type; + } + + $out[ $block_name ]['Details'] = $this->with_details( + $out[ $block_name ]['Details'], // @phpstan-ignore-line + $block, // @phpstan-ignore-line + ); + } + }, + ); + + if ( count( $out ) === 0 ) { + \WP_CLI::warning( 'No results. Run again with the --rewind flag to reset the cursor.' ); + return; + } + + // Sort by block name. + ksort( $out ); + $first = reset( $out ); + + foreach ( $out as &$values ) { + // Sort details. + ksort( $values['Details'] ); + + // Leave details empty if there are none. + if ( [] === $values['Details'] ) { + $values['Details'] = ''; + } + } + + $format = get_flag_value( $assoc_args, 'format' ); + + format_items( + is_string( $format ) && $format ? $format : 'table', + $out, + array_keys( $first ), + ); + } + + /** + * Add to details about blocks of a certain type. + * + * For example: + * + * - Keep track of which heading levels are in use. + * - Keep track of how many recirculation modules use custom post titles. + * + * @phpstan-param array> $details + * @phpstan-param array{blockName: string, attrs: array, innerHTML: string} $block + * @phpstan-return array + * + * @param array $details Accumulated details about blocks of this type so far. + * @param array $block Block being audited. + * @return array Updated details. + */ + private function with_details( array $details, array $block ): array { + static $has_filter = []; + + $html = new \WP_HTML_Tag_Processor( $block['innerHTML'] ); + $attrs = $block['attrs']; + + // Automatically track standard alignment attribute. + if ( isset( $attrs['align'] ) && is_string( $attrs['align'] ) ) { + $details['align'][ $attrs['align'] ] ??= 0; + $details['align'][ $attrs['align'] ]++; + } + + $block_name = $block['blockName']; + + if ( ! $block_name ) { + $block_name = 'core/classic'; + } + + switch ( $block_name ) { + case 'core/embed': + if ( ! empty( $attrs['providerNameSlug'] ) ) { + $details['providerNameSlug'][ $attrs['providerNameSlug'] ] ??= 0; + $details['providerNameSlug'][ $attrs['providerNameSlug'] ]++; + } + break; + + case 'core/heading': + while ( $html->next_tag() ) { + $tag = $html->get_tag(); + + if ( is_string( $tag ) && preg_match( '/^H\d$/', $tag ) ) { + $details[ $tag ] ??= 0; + $details[ $tag ]++; + } + } + break; + + default: + break; + } + + $should_filter = + ( $has_filter['all'] ??= has_filter( 'alley_block_audit_block_type_details' ) ) + || ( $has_filter[ $block_name ] ??= has_filter( "alley_block_audit_{$block_name}_block_type_details" ) ); + + if ( $should_filter ) { + /** + * Filters the details about a block. + * + * @param array $details Details about blocks of this type so far. + * @param string $block_name Name of the block being audited. + * @param array $attrs Block attributes. + * @param string $innerHTML Inner HTML of the block. + * @param array $block Block being audited. + * @return array Updated block type details. + */ + $details = apply_filters( 'alley_block_audit_block_type_details', $details, $block_name, $attrs, $block['innerHTML'], $block ); + + /** + * Filters the details about a block. + * + * The dynamic portion of the hook name, `$block_name`, refers to the name of the block being audited. + * + * @param array $details Details about blocks of this type so far. + * @param string $block_name Name of the block being audited. + * @param array $attrs Block attributes. + * @param string $innerHTML Inner HTML of the block. + * @param array $block Block being audited. + * @return array Updated block type details. + */ + $details = apply_filters( "alley_block_audit_{$block_name}_block_type_details", $details, $block_name, $attrs, $block['innerHTML'], $block ); + } + + if ( ! is_array( $details ) ) { + $details = []; + } + + return $details; + } +}