charlie/wp-scaffolder

Scaffolding scripts for the Wordpress Theme using WP CLI and Bash

Installs: 591

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 0

Open Issues: 0

Language:Shell

Type:wordpress-scaffolding-scripts

1.0.10 2023-08-02 00:41 UTC

This package is auto-updated.

Last update: 2025-07-29 02:24:48 UTC


README

Getting the theme

Currently some of these scripts are tied to the structure and configuration of the Charlie Base WordPress theme. You can locate that theme here.

Or

By running gh repo clone charlie-dev/charlie-wp-theme . to install into the current directory you are in. Omit the . at the end to generate a new folder.

Configuration within theme.

If your theme does not use composer, you will need to composer init within your active theme.

Once you have a composer.json file generated, add the following snippet to your composer.json file. This will instruct composer to run scripts in this codebase in the proper order.

"scripts": {
    "post-install-cmd": [
      "php -r \"shell_exec('cp -rf vendor/charlie/wp-scaffolder/scripts/. scripts/');\"",
      "bash scripts/set-env.sh",
      "bash scripts/plugin-extraction.sh",
      "bash scripts/database.sh"
    ],
    "post-update-cmd": [
      "php -r \"shell_exec('cp -rf vendor/charlie/wp-scaffolder/scripts/. scripts/');\"",
      "bash scripts/set-env.sh",
      "bash scripts/plugin-extraction.sh",
      "bash scripts/database.sh"
    ]
  },

Then run composer install, this should create a /scripts folder within your theme, and if there is no .env present, you will be prompted for your theme name and install path.