Skip to content

check_makefile_targets

rhiza_hooks.check_makefile_targets

Check that Makefile contains expected targets for rhiza projects.

A catch-all rule satisfies every recommended target at once. Since rhiza v1.4.0 the root Makefile is a rhiza-task shim that defines only help and forwards every other goal through %:, so make test works with no test: rule in sight; reporting fmt, install and test missing there is a false report on a Makefile that is correct, and under --strict it blocks the commit. The rule is applied by :meth:rhiza_hooks._makefile.MakefileTargets.defines, shared with check-workflow-make-targets so the two agree on what "defined" means.

check_makefile(filepath, recommended=RECOMMENDED_TARGETS)

Check a Makefile for recommended targets.

Parameters:

Name Type Description Default
filepath Path

Path to the Makefile

 required
recommended set[str]

Target names that must be present (defaults to RECOMMENDED_TARGETS)

 RECOMMENDED_TARGETS

Returns:

Type Description
list[str]

List of warning messages (empty if all recommended targets exist)
Source code in rhiza_hooks/check_makefile_targets.py 
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
def check_makefile(filepath: Path, recommended: set[str] = RECOMMENDED_TARGETS) -> list[str]:
    """Check a Makefile for recommended targets.

    Args:
        filepath: Path to the Makefile
        recommended: Target names that must be present (defaults to RECOMMENDED_TARGETS)

    Returns:
        List of warning messages (empty if all recommended targets exist)
    """
    warnings: list[str] = []

    try:
        content = filepath.read_text(encoding="utf-8")
    except FileNotFoundError:
        return [f"File not found: {filepath}"]

    targets = extract_targets(content)

    # Only check the main Makefile for recommended targets
    if filepath.name == "Makefile":
        missing = {target for target in recommended if not targets.defines(target)}
        if missing:
            warnings.append(f"Missing recommended targets: {', '.join(sorted(missing))}")

    return warnings

main(argv=None)

Main entry point for the hook.

Source code in rhiza_hooks/check_makefile_targets.py 
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
def main(argv: list[str] | None = None) -> int:
    """Main entry point for the hook."""
    parser = argparse.ArgumentParser(description="Check Makefile for recommended targets")
    parser.add_argument(
        "filenames",
        nargs="*",
        help="Filenames to check",
    )
    parser.add_argument(
        "--strict",
        action="store_true",
        help="Exit with error if recommended targets are missing",
    )
    parser.add_argument(
        "--target",
        action="append",
        metavar="NAME",
        help="Required target name; repeatable. When given, replaces the default set.",
    )
    parser.add_argument(
        "--extend-target",
        action="append",
        metavar="NAME",
        help="Extra required target name; repeatable. Added on top of the active set.",
    )
    args = parser.parse_args(argv)

    recommended = resolve_recommended_targets(args.target, args.extend_target)

    retval = 0
    for filename in args.filenames:
        filepath = Path(filename)
        warnings = check_makefile(filepath, recommended)
        if warnings:
            print(f"{filename}:", file=sys.stderr)
            for warning in warnings:
                print(f"  - {warning}", file=sys.stderr)
            if args.strict:
                retval = 1

    return retval

Build the effective set of required targets from the CLI options.

Parameters:

Name Type Description Default
targets list[str] | None

Values of --target. When non-empty they replace the defaults.

 required
extra_targets list[str] | None

Values of --extend-target, always added to the active set.

 required

Returns:

Type Description
set[str]

The set of target names a Makefile is expected to define.

With neither option, the built-in defaults apply:

sorted(resolve_recommended_targets(None, None)) ['fmt', 'help', 'install', 'test']

--target replaces them, so a project with its own vocabulary is not also held to the defaults:

sorted(resolve_recommended_targets(["build"], None)) ['build']

--extend-target adds to whichever set is active:

sorted(resolve_recommended_targets(None, ["deploy"])) ['deploy', 'fmt', 'help', 'install', 'test'] sorted(resolve_recommended_targets(["build"], ["deploy"])) ['build', 'deploy']

Source code in rhiza_hooks/check_makefile_targets.py 
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
def resolve_recommended_targets(targets: list[str] | None, extra_targets: list[str] | None) -> set[str]:
    """Build the effective set of required targets from the CLI options.

    Args:
        targets: Values of ``--target``. When non-empty they *replace* the defaults.
        extra_targets: Values of ``--extend-target``, always *added* to the active set.

    Returns:
        The set of target names a Makefile is expected to define.

    With neither option, the built-in defaults apply:

    >>> sorted(resolve_recommended_targets(None, None))
    ['fmt', 'help', 'install', 'test']

    ``--target`` *replaces* them, so a project with its own vocabulary is not
    also held to the defaults:

    >>> sorted(resolve_recommended_targets(["build"], None))
    ['build']

    ``--extend-target`` *adds* to whichever set is active:

    >>> sorted(resolve_recommended_targets(None, ["deploy"]))
    ['deploy', 'fmt', 'help', 'install', 'test']
    >>> sorted(resolve_recommended_targets(["build"], ["deploy"]))
    ['build', 'deploy']
    """
    base = set(targets) if targets else set(RECOMMENDED_TARGETS)
    return base | set(extra_targets or [])