README

Extra preflight-command checkers for Itineris projects.

This package only make sense for Itineris projects. Abort immediately!

What is this?

This package adds the followings to Itineris projects so that you don't need to copy and paste:

• custom checkers
• common config
• bundle other itinerisltd/preflight-xxx packages

Installation

1A. WP CLI - Kinsta

Kinsta still using WP CLI v1.x. Contact Kinsta support team to upgrade your site's WP CLI to v2. (It might take a few hours)

$ wp package install itinerisltd/preflight-itineris:@stable

1B. WP CLI - AWS

Merge itinerisltd/trellis-aws master, then re-provision.

2. Bedrock

This means <bedrock>/config/preflight.toml:

// <bedrock>/config/application.php

Config::define('PREFLIGHT_DIR', __DIR__);

// Not recommanded. Update Bedrock!!!!
// In case you are using an old Bedrock without roots/wp-config:
define('PREFLIGHT_DIR', __DIR__);

3. preflight.toml

Copy this to <bedrock>/config/preflight.toml:

# <bedrock>/config/preflight.toml

# Use TOML v0.4.0 syntax
# See: https://github.com/toml-lang/toml/blob/master/versions/en/toml-v0.4.0.md

# TOML v0.5.0 not yet supported

###########################################################
#                                                         #
#     If you disable or change checker options,           #
#     you must write comments explaining the reasons!     #
#                                                         #
###########################################################

# Use expected production URL (i.e: client's doamin)
# Starts with 'https://'
[extra-production-home-url]
url = 'https://preflightcommand.com' # TODO

[extra-production-site-url]
url = 'https://preflightcommand.com/wp' # TODO

Usage

$ wp help preflight
$ wp help preflight <subcommand>

# List all checkers
$ wp preflight checklist

# List all .toml config files
$ wp preflight config paths

# Validate all .toml config files
$ wp preflight config validate

# Run the checks
$ wp preflight check

# More info
$ wp preflight check --fields=id,status,message,description,link

# Print in yaml, for smaller screens
$ wp preflight check --fields=id,description,link,status,messages --format=yaml

# See all check options
$ wp help preflight check

Plugins

These plugins inject their checks automatically (no installation needed):

• https://github.com/ItinerisLtd/gf-sagepay
• https://github.com/ItinerisLtd/gf-worldpay