wyrihaximus / makefiles

0.15.2 2026-10-08 05:32 UTC

Requires

• php: ^8.4
• composer-plugin-api: ^2
• ext-json: ^8.4

Requires (Dev)

• wyrihaximus/test-utilities: ^14.4.0

Conflicts

• infection/infection: <0.32.0

MIT

• Cees-Jan Kiewiet

Published on Packagist.org on 2026-10-08 05:55 UTC

README

Shared GNU Make targets and a Composer plugin that generates a project Makefile for PHP libraries and applications maintained under WyriHaximus.

What it does

When you add this package as a development dependency, the Composer plugin runs on composer install and composer update (during autoload dump) and writes a root Makefile tailored to your project. That file is generated from templates/Makefile.PHP; you normally edit your project's etc/Makefile for project-specific targets instead of hand-maintaining the root file.

The generated Makefile wires up:

• Local or containerized PHP using ghcr.io/wyrihaximusnet/php images when Docker is available, or direct execution when you are already inside those images or Docker is not installed.
• Aggregate workflows such as make / make all (full QA) and make contrib (a smaller subset suited to day-to-day contributions).
• Discoverable help via make help, make help-contrib, and make help-migrations.
• GitHub Actions job lists as JSON from targets like make task-list-ci-locked for matrix CI pipelines.
• Post-install maintenance via make on-install-or-update, which runs migration targets and hooks used by Renovate in self-hosted setups.

Composer also registers post-install-cmd / post-update-cmd scripts that run make on-install-or-update when possible, so new checkouts stay aligned with expected config layout under etc/qa/, etc/ci/, and related paths.

Installation

Require the package as a dev dependency (the plugin only activates when wyrihaximus/makefiles is listed under require-dev, or when working inside this repository itself):

composer require --dev wyrihaximus/makefiles

Allow the plugin in composer.json:

"config": {
    "allow-plugins": {
        "wyrihaximus/makefiles": true
    }
}

Then run composer update (or make install once a Makefile exists) so the root Makefile is generated.

Everyday usage

Command	Purpose
make / make all	Run the full QA pipeline for the project
make contrib	Run a contributor-focused subset (see make help-contrib)
make help	List available targets with short descriptions
make install / make update	Install or update Composer dependencies in the expected environment
make run …	Run an arbitrary command inside the PHP container (or locally when Docker is unused)
make shell	Interactive shell in the PHP environment
make unit-testing-filter …	Run PHPUnit with a class or method filter

See CONTRIBUTING.md for the contribution workflow used across WyriHaximus PHP repositories.

What is included

Makefile fragments live under includes/. They are merged into your generated Makefile at install time.

PHP quality assurance (includes/PHP.mk)

Targets for tooling typically configured under etc/qa/, including:

• Syntax lint (parallel-lint)
• Code style (PHP_CodeSniffer) via cs / cs-fix
• Static analysis (PHPStan) via stan
• Unit tests and coverage enforcement (PHPUnit, coverage-guard) via unit-testing, coverage-guard
• Mutation testing (Infection) via mutation-testing
• Composer hygiene: composer-validate, composer-normalize, composer-require-checker, composer-unused, dependency helpers
• Refactoring upgrades (Rector) via rector-upgrade
• Backward compatibility checks (Roave) where configured

Many targets honor supported features (described under Configuration) so CI can skip jobs your package does not support (for example when unit tests or PHP_CodeSniffer are turned off).

Documentation QA (includes/Documentation.QA.mk)

documentation-qa runs markdown structure lint (markdownlint-cli2), link checking (lychee), spelling (cspell), and prose lint (Vale) against project docs.

Shared project terms live in etc/wordlist.txt and are copied into enforced templates via make documentation-wordlist-sync (WordlistDocumentationConfigSync::sync()). On each Composer install or update, WordlistDocumentationConfigSync::enrichQaWordlistsWithPhpSymbols() (migration migrations-docs-enrich-qa-wordlists-with-php-symbols) merges loaded PHP symbol names and Composer vendor and package names from composer.lock and the root composer.json name into etc/qa/cspell.json and etc/qa/vale-vocab.txt. The class exposes only those two helpers plus addWordsToQaWordlists() for custom terms; everything else is internal.

Packages and applications that ship their own product names, acronyms, or API tokens in documentation can register those spellings with an install migration in etc/Makefile. Call WordlistDocumentationConfigSync::addWordsToQaWordlists() with only the extra strings (variadic). The helper merges into both QA wordlists, drops duplicates and blanks, and keeps entries sorted, so the migration stays idempotent:

migrations-docs-add-my-package-wordlist: #### Register package-specific documentation spellings ##*I*##
    ($(DOCKER_RUN) php -r '$$autoload = getcwd() . "/vendor/autoload.php"; if (!is_file($$autoload)) {exit;} require $$autoload; \WyriHaximus\Makefiles\Documentation\WordlistDocumentationConfigSync::addWordsToQaWordlists(getcwd(), "AcmeWidget", "subprocess");' || true)

Use a tab before the recipe line in your real etc/Makefile (spaces above are for markdown lint only). Tag the target with ##*I*## so it runs with other install migrations, then run make install in the consuming repository to regenerate the root Makefile.

Container access (includes/ContainerAccess.mk)

run and shell targets execute commands in the selected PHP image, with volume mounts for the workspace, Composer cache, optional Docker socket access for Testcontainers when required, and sensible defaults for CI versus interactive TTY use.

Aggregates and help

• includes/All.mk and includes/Contrib.mk define all and contrib from annotated targets in other fragments.
• includes/Help.mk and includes/TaskFinders.mk power help output and CI task list generation (task-list-ci-*, supported-features).

Migrations (includes/*Migrations*.mk)

Idempotent migrations-* targets normalize repository layout and tool configs (PHPUnit, PHPStan, PHPCS, Infection, GitHub Actions, Renovate, documentation, AI agent files, and more). They are collected into on-install-or-update so existing repos can adopt new conventions without manual copy-paste. Use make help-migrations to see migration targets.

Project-specific targets

The template includes includes/EXTRA.mk, which is resolved from your repository’s etc/Makefile. Put custom targets, Docker Compose service hooks (extra-services-up / extra-services-down), and lifecycle hooks there; they are inlined when the root Makefile is generated.

Configuration

Supported features matrix

Declare which capabilities apply to your package under extra.wyrihaximus.supported-features in composer.json. The plugin resolves defaults from your requirements (for example ext-parallel excludes macOS and Windows CI variants and enables ZTS) and prints the matrix during generation.

Available feature keys (see SupportedFeatures):

Feature	Default	Typical use
code-style	enabled	PHPCS targets and related CI jobs
static-analysis	enabled	PHPStan and mutation testing CI jobs
unit-tests	enabled	PHPUnit and coverage jobs
composer-dependency-checkers	enabled	composer-require-checker / composer-unused
composer-plugin	off	Set true for Composer plugins that need plugin-specific CI
linux / macos / windows	enabled	OS dimensions in CI task lists
zts	auto from ext-parallel	ZTS PHP Docker image selection
opentelemetry-instrumentation	auto from OTel setup	Docker OpenTelemetry env tuning

Example:

"extra": {
    "wyrihaximus": {
        "supported-features": {
            "composer-plugin": true
        }
    }
}

Requirements-aware conditionals

The generator inspects composer.json requirements and adjusts the Makefile (PHP version platform, slim versus full Docker images, ZTS, Testcontainers socket access, and similar) so generated commands match what the project actually needs.

CI integration

Fragment targets declare which aggregates they belong to with a help suffix such as ##*LCH*##. During composer install / composer update, TaskListInjector reads those markers and expands placeholders like make-list(all) and task-list(ci-locked) in includes/All.mk, includes/Contrib.mk, and includes/TaskFinders.mk.

GitHub Actions workflows in consuming repositories call make task-list-ci-locked, make task-list-ci-low, make task-list-ci-high, or related targets to build JSON job lists for matrix pipelines. Run make supported-features locally to inspect the feature flags CI uses to filter jobs.

Aggregate markers

Place one or more marker letters between ##* and *## on the same line as the target help text (after the ## description). Letters combine: ##*LCH*## enrolls the target in every aggregate listed for L, C, and H.

Optional feature gates append ##^feature^## or ##^one|other^## (pipe-separated). The target is omitted from generated lists when any listed supported feature is turned off.

Marker	Meaning	Aggregates
A	Full local QA and every CI variation	make all, task-list-ci-all
E	Contributor workflow (also local full QA)	make all, make contrib, make help-contrib
I	Install / update maintenance (I and hash count)	make on-install-or-update, and sometimes make all
K	CI once on locked dependencies	task-list-ci-locked
D	CI jobs that run directly on the OS (not in the PHP container)	task-list-ci-dos
L	CI against lowest dependencies	make all, task-list-ci-all, task-list-ci-low
C	CI on locked deps plus the full matrix	make all, task-list-ci-all, task-list-ci-locked
H	CI against highest dependencies	make all, task-list-ci-all, task-list-ci-high

I and hash count

Migration targets use #### in the help prefix (four # characters before the description). Those run only under on-install-or-update. A target with ## (two # characters) and I is also included in local make all, but not in task-list-ci-all.

Examples from this package:

• stan and mutation-testing typically use ##*LCH*## so they run locally and across CI dependency/OS matrices.
• Individual documentation tools use ##*K*## so CI runs them once on locked dependencies; see includes/Documentation.QA.mk.
• documentation-qa uses ##*E*##: local make all and make contrib, not task-list-ci-all (CI still runs the K subtargets via task-list-ci-locked).

Custom targets in etc/Makefile can use the same markers so make install regenerates aggregate and CI task lists consistently.

License

The MIT License (MIT)

Copyright (c) 2026 Cees-Jan Kiewiet

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.