cliffordp / cliff-wp-plugin-boilerplate Goto Github PK

• Code update to put .org assets in .wordpress-org directory
• Documentation update to recommend using https://github.com/ahmadawais/wp-continuous-deployment or https://github.com/marketplace/actions/wordpress-plugin-deploy

The readme lists a number of areas in which a search and replace should be performed. I think it could be handy to have a script that guides users through this:

• Could be a standalone PHP script that can be executed using something like ./bin/setup (ie, it would not depend on WP CLI nor would it be a Composer script)
• It could validate that the plugin slug (for example) is a valid slug before performing search-and-replace
• Could provide a final summary of the changes and a chance to bail out or make changes
• It could run composer install at the end

Conceptually, what do you think—worthwhile/maybe useful but not sure/meh?

https://laravel.com/docs/master/helpers --> https://packagist.org/packages/laravel/helpers requires PHP 7.1.3

===

https://packagist.org/packages/symfony/string requires PHP 7.2.5

===

https://github.com/PHLAK/Twine requires PHP 7.2

===

https://github.com/phpfunct/funct seems to cover it all for both strings and arrays (re: #87) but isn't actively maintained.

Strings:

• contains
• starts with
• ends with
• truncate

One thing missing from this library is to add prefix while accounting for it possibly existing already (and same for suffix): phpfunct/funct#47

===

https://packagist.org/packages/voku/stringy requires PHP 7.0, has all the string functions, and is actively maintained

So that's why we chose this one.

1. Correct the commands, offer an alternative or comprehensive instructions
2. Can we consolidate the number of required replacements, or do we need to add some missing ones?

Review those available from https://github.com/beberlei/assert and implement without including that library, since there's already quite a bit of overlap with WP's built-ins as well as Stringy

https://github.com/Seldaek/monolog to replace/enhance /src/common/utilities/class-debug.php

References:

• https://symfony.com/doc/current/logging.html
  • https://github.com/symfony/monolog-bridge
• https://core.trac.wordpress.org/ticket/30934
• https://docs.woocommerce.com/wc-apidocs/class-WC_Logger.html

Consider using https://github.com/micropackage/requirements instead of TGMPA

Would have to play with it to see how error messages are sent.

https://github.com/afragen/wp-dependency-installer is another alternative.

Consider implementing https://github.com/micropackage/filesystem because it is helpful for getting our plugin path and url and is a wrapper for https://developer.wordpress.org/reference/classes/wp_filesystem_base/#methods

This custom control isn't fully finished - look for the TODOs, like here:

https://github.com/phpfunct/funct seems to cover it all for both strings and arrays but isn't actively maintained.

https://github.com/voku/arrayy is from a trusted source but doesn't seem to add the value we're aiming for.

Arrays:

• contains
• diff
• intersect
• flatten
• get first
• get last
• recursive count of items

To test front-end

https://docs.cypress.io/guides/getting-started/writing-your-first-test.html

Re: /inc/core/class-deactivator.php

if a wp-admin settings screen were to support tabs

https://deliciousbrains.com/create-wordpress-plugin-settings-page/ is great

or use a library like:

• https://github.com/jamesckemp/WordPress-Settings-Framework
• https://github.com/TypistTech/wp-tabbed-admin-pages (http://packagist.p2hp.com/packages/typisttech/wp-admin-tabs has the missing screenshots)
• https://premium.wpmudev.org/blog/tabbed-interface/ (via JS)
• https://freemius.com/help/documentation/wordpress-sdk/tabs-navigation/ (via JS)
• https://github.com/WPUserManager/wp-optionskit
• https://github.com/tareq1988/wordpress-settings-api-class
• https://gopangolin.com/building-wordpress-plugin-with-react-part-1/ (React)
• https://torquemag.io/2017/06/creating-wordpress-settings-page-using-wordpress-rest-api/ (React)

Make it as easy to create new Blocks as it is to create new Shortcodes, such as https://github.com/cliffordp/cliff-wp-plugin-boilerplate/blob/1a6c0f6dfcba5bc1ddf2773ad72c365df51d1d7b/src/shortcodes/class-tk_request.php

Idea (but maybe not ideal): Convert all of our shortcode's arguments to become Blocks (with fields) by adding custom parameters that create both a shortcode and a block.

Related: https://make.wordpress.org/core/2020/03/02/general-block-editor-api-updates/

I've used the boilerplate to create a custom plugin to track user engagement analytics on live streamed video assets. included in the plugin within the /public directory are some fairly robust JavaScripts that mesh with a webhook from the stream provider and a AJAX call to track real time player events.
It's my understanding that these scripts added to the enqueue_scripts() function in the public/class-plugin-name-public.php run on every single page in the rather vast WP site I'm intending to deploy it on. This seems inefficient and rather insecure...
What's best practice as far as only getting the scripts to run on specific pages...for instance, making a custom theme template and only applying that template file to a page containing video assets?

Make rendering / getting HTML more atomic without much overhead, plus allowing overriding via child theme. Plus for shortcodes to use as well.

Options:

• https://github.com/GaryJones/Gamajo-Template-Loader
• https://github.com/micropackage/templates

• https://getcomposer.org/doc/articles/scripts.md#event-names and https://getcomposer.org/doc/articles/vendor-binaries.md
• https://github.com/WPBP/generator is for https://github.com/WPBP/WordPress-Plugin-Boilerplate-Powered
• https://github.com/humanmade/react-wp-scripts/

Should also require method names to be prefixed with shortcode_

Inspiration: https://matthewhorne.me/defer-async-wordpress-scripts/

Would be best if WordPress implements this itself, though: https://core.trac.wordpress.org/ticket/12009

Same goes for SRIs:

• https://core.trac.wordpress.org/ticket/33948
• https://github.com/meitar/wp-sri

We're already using Parcel (see #55), and it's working nicely, but WP uses Webpack so maybe we should, too:

• https://developer.wordpress.org/block-editor/tutorials/javascript/js-build-setup/
• https://github.com/gambitph/Stackable/blob/master/package.json
• https://github.com/WordPress/gutenberg/blob/master/package.json
• https://github.com/petehunt/webpack-howto

Let's build things via Weback to compare not only the ease of use but also the file size of the resulting built files.

Investigate if multiple plugins including the same package from Composer causes any issues. If yes, consider these:

• https://github.com/TypistTech/imposter-plugin --> https://typist.tech/portfolio-item/imposter/
• https://deliciousbrains.com/php-scoper-namespace-composer-depencies/ --> https://github.com/humbug/php-scoper
• https://github.com/coenjacobs/mozart

https://github.com/stellarwp/slic/

Please consider using proper namespaces.

namespace Company\WordPress\PluginName;

// e.g.

namespace AcmeLabs\WordPress\Mnemonic;
// then
namespace AcmeLabs\WordPress\Mnemonic\Frontend;

What do you think?

• https://torquemag.io/2018/06/advanced-oop-for-wordpress-part-6-continuous-integration-for-wordpress-plugins/
• https://www.branchci.com/

• https://github.com/CodesVault/howdy-wp
• WordPress plugin boilerplate (Feat. Webpack, BrowswerSync, & HMR) -- has webpack with HMR (via _ webpack-hot-middleware_ and browsersync-webpack-plugin) but requires entering the proxy URL and such, ugh
• https://github.com/deliciousbrains/wp-react-boilerplate -- the linked article says they didn't get HMR working with Webpack 3
• https://github.com/youknowriad/wp-js-plugin-starter
• https://framework.themosis.com/docs/2.0/plugin -- has webpack with HMR but this is like its own ecosystem way of doing things
• https://github.com/GaryJones/plugin-boilerplate
• https://roots.io/a-workflow-for-modern-wordpress-plugin-development/
• https://github.com/ptahdunbar/wp-skeleton-plugin
• https://developer.wordpress.org/cli/commands/scaffold/plugin/
• https://github.com/brightnucleus/boilerplate
• https://github.com/inpsyde/boilerplate
• https://github.com/WordPress/gutenberg
• https://github.com/gopangolin/wp-reactivate -- no HMR
• https://github.com/jaredpalmer/presspack -- whole environment, including HMR
• https://github.com/swashata/wp-webpack-script -- looks like it's well-built but doesn't use anything from WP (wp-element script, wp-components style) so does it double-load React, React-DOM, and styles? Lots of nice features, though, including HMR
• https://github.com/humanmade/react-wp-scripts/
• https://github.com/markjaquith/grunt-wp-plugin
• https://github.com/hlashbrooke/WordPress-Plugin-Template
• https://devowlio.gitbook.io/wp-react-starter/ -> https://github.com/devowlio/create-wp-react-app
• https://github.com/TukuToi/better-wp-plugin-boilerplate
• https://github.com/codeispoetry/wp-codespace

• https://carlalexander.ca/introduction-wordpress-unit-testing/
• https://developer.wordpress.org/cli/commands/scaffold/plugin-tests/
• https://torquemag.io/2018/04/advanced-oop-wordpress-part-3-unit-testing-wordpress-rest-api-plugins/
• https://codeception.com/07-24-2013/testing-wordpress-plugins.html
• https://github.com/delboy1978uk/blank

• https://github.com/10up/plugin-scaffold/blob/master/composer.json
• https://github.com/10up/phpcs-composer
• https://github.com/PHPCompatibility/PHPCompatibilityWP

Maybe as a Command Line argument when creating project

Like this one: https://github.com/BracketSpace/Notification-Extension-Boilerplate/blob/master/rename.sh

The idea is that there would be a 'texts' JSON/YAML/etc file (ideally a format that allows comments). You set it and, when you run the 'texts' command, it does its replacements.

Ideally, it could run the replacement command over and over, not just the initial time, in case there was a typo or such... might require keeping start/end boundaries (like curly braces) to find them again and again to be replaced... but then that would require the build command to remove such boundaries/placeholders... Maybe the placeholders stay permanently there but then the build command does the string replacements. I think I like that idea the best 🤔

Related to #64

Idea is to be able to parse the plugin's readme.txt so we could get things like the long description or the changelog. Just a nice-to-have.

https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/#markdown

The readmes use a customized version of Markdown. Most Markdown calls work as expected.

Good choice if using Composer: https://github.com/erusev/parsedown - nothing specific to WP's flavor of markdown but MIT license

Good reference with some extra functionality (possibly same as / close to WP's markdown flavor): https://github.com/Automattic/jetpack/tree/master/_inc/lib/markdown - but not using a standardized license: https://github.com/michelf/php-markdown#copyright-and-license

https://github.com/danielguillan/bem-constructor might be great

/inc/frontend/views/ should either be included within class-frontend.php or the views directory should be removed

For things not supported by Composer or some other embedded code.

https://github.com/micropackage/cache can be good for transients and such

If SCRIPT_DEBUG, set a JS/CSS file's version to time() instead of the plugin version number for cache busting's sake

• main plugin file class broken into separate file and require it
• main plugin file shouldn't be all static
• activation/deactivation hooks should not fire unless initial requirements are met (PHP version and required plugins)
• Common should not have static and should get its setup data from Init, since it's already there
• each class should be wrapped with an if class exists check

References:

• https://www.alainschlesser.com/singletons-shared-instances/
• https://www.alainschlesser.com/config-files-for-reusable-code-3/
• https://carlalexander.ca/single-responsibility-principle-wordpress/
• https://carlalexander.ca/singletons-in-wordpress/#take-plugin-api-code-out-of-the-constructor

• https://wptavern.com/improved-server-side-rendering-of-dynamic-wordpress-blocks
• https://wpgoplugins.com/an-improved-server-side-render-component-for-dynamic-wordpress-blocks/
• https://github.com/dgwyer/server-side-render-x

https://flintci.io/docs#composernormalize to help keep Composer sane

https://github.com/tareq1988/wp-eloquent seems to be the only drop-in to consider, if to include at all

For simplicity and/or succinctness, let's consider:

• https://parceljs.org/ - References:
  • https://roots.io/developing-gutenberg-blocks-with-parcel-js-and-astroturf/
  • https://blog.jakoblind.no/parcel-webpack/
• https://www.snowpack.dev/
• https://laravel-mix.com/

And these libraries:

• https://github.com/browserslist/browserslist
• https://github.com/craigsimps/gulp-wp-toolkit

https://developer.wordpress.org/plugins/plugin-basics/best-practices/#boilerplate-starting-points

Does the comment on \WP_Plugin_Name\WP_Plugin_Name::$init do what it says?

Reference: https://carlalexander.ca/singletons-in-wordpress/

Would make things a bit more flexible

https://github.com/julien731/WP-Review-Me exists for .org but optionally link elsewhere

Whether on our own or via an existing library:

For possible inclusion:

• https://github.com/lezhnev74/pasvl

For inspiration:

• https://github.com/cdrubin/matchmaker
• https://github.com/auraphp/Aura.Filter

• Display each missing plugin's nice name (actual name, not required plugin file)
• Add support for requiring a minimum version number
• Add link to install/activate the missing plugin

Could use http://tgmpluginactivation.com/