Skip to content

Latest commit

 

History

History
87 lines (62 loc) · 2.52 KB

site-build.md

File metadata and controls

87 lines (62 loc) · 2.52 KB
Raw

Composer Compile Plugin: Managing the root package (for site-builders)

For PHP site-builders, the compilation process is a seamless part of the regular download (eg composer install).

By default, the plugin will prompt before compiling any new packages:

Screenshot

You may suppress this prompt with runtime options. Runtime options are described more below.

Mode

The "compilation mode" gives a broad preference. It may be set as an environment-variable:

  • COMPOSER_COMPILE=none: Do not compile anything automatically.
  • COMPOSER_COMPILE=all: Automatically run all compilation tasks.
  • COMPOSER_COMPILE=whitelist: Automatically compile anything on the whitelist, and reject everything else.
  • COMPOSER_COMPILE=prompt (default): Automatically compile anything on the whitelist, and prompt for everything else.

Alternatively, the same option may be added persistently to composer.json, e.g.:

composer config extra.compile-mode all

or

// FILE: composer.json
{
  "extra": {
    "compile-mode": "all"
  }
}

If both the environment variable (COMPOSER_COMPILE) and the JSON option (extra.compile-mode) are set, then the environment-variable takes precedence.

Whitelist

If the mode is prompt or whitelist, then any whitelisted packages will run compilation steps automatically:

// FILE: composer.json
{
  "extra": {
    "compile-whitelist": [
      "vendor1/package1",
      "vendor2/package2",
      "vendor3/*"
    ]
  }
}

The root-package is automatically whitelisted.

Passthru

The "passthru" option indicates whether to display console-output from the underlying compilation tasks. It may be set as an environment-variable:

  • COMPOSER_COMPILE_PASSTHRU=never: Do not display console-output from individual tasks.
  • COMPOSER_COMPILE_PASSTHRU=always: Do display console-output from individual tasks.
  • COMPOSER_COMPILE_PASSTHRU=error (default): Do not display console-output unless there's an error.

Alternatively, the same option may be added persistently to composer.json, e.g.:

composer config extra.compile-passthru always

or

// FILE: composer.json
{
  "extra": {
    "compile-passthru": "always"
  }
}

Additionally, the verbose (-v) flag will enable COMPOSER_COMPILE_PASSTHRU=always.

If the value is set in multiple ways, the order of preceduce (highest to lowest) is: (1) verbose flag (-v), (2) environment variable (COMPOSER_COMPILE_PASSTHRU), and (3) the JSON option (extra.compile-passthru).