friends-of-wp/wp-dev-cli-ext-boilerplate

There is no license information available for the latest version (dev-develop) of this package.

WP DevCli Extension that takes care of plugin boilerplate creation.

Maintainers

Details

github.com/friends-of-wp/wp-dev-cli-ext-boilerplate

Source

Issues

Installs: 47

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 0

Open Issues: 0

dev-develop 2023-04-27 05:54 UTC

Unknown License 905ec1f5ed9b5004e0afba9d950cd9632fd9cc8f

This package is auto-updated.

Last update: 2024-12-27 09:12:43 UTC

README

This a an extension to the Friends of WP Command Line Tool for Developers. This command is included in the default tool.

Usage

The usage of the boilerplate creation command is very easy. As the only parameter the plugin output directory is needed. All other configuration is done via the creation process starting afterwards.

./wp-dev.phar plugin:boilerplate:create /path/to/plugin/plugin-name

How to create individual steps

It is possible to add individual steps to the boilerplate creation process. This is done via the config yaml file that can be handed over via the CLI parameter -c.

./wp-dev.phar plugin:boilerplate:create /path/to/plugin/plugin-name -c my-default-config.yml

CLI Output

The config file should have all the steps in there. All those steps will be processes in the order in that list.

steps:
  - \FriendsOfWp\BoilerplateDevCliExtension\Boilerplate\Step\InitializeStep
  - \FriendsOfWp\BoilerplateDevCliExtension\Boilerplate\Step\CopyTemplatesStep
  - \FriendsOfWp\BoilerplateDevCliExtension\Boilerplate\Step\ReplacingPlaceholdersStep
  - \FriendsOfWp\BoilerplateDevCliExtension\Boilerplate\Step\RenameMasterFileStep
  - \FriendsOfWp\BoilerplateDevCliExtension\Boilerplate\Step\RenamePluginDirStep

How to pre-define parameters

When a custom config file is used it is possible to predefine the answers of some questions in the creation workflow. This helps for example if some answers are "always" the same like author or license.

parameters:
  core_plugin_name: "Acme Security"
  core_plugin_description: "This is the description for the Acme Studios Security plugin."
  core_plugin_version: "1.0.0"

  core_plugin_author_name: Nils langner
  core_plugin_author_email: nils.langner@startwind.io

Todos

  • Create settings configuration (RFC-FWP-01)
  • Create empty plugin admin pages
  • Add author to plugin questions
  • Select license
  • Select menu images
  • Extend config file to prefill as default "questions" (like license).
  • Create config file from actual question answers (to reuse in the next run)
  • Ask for license