Reference

Classes

Core classes

JustfileFixture

Helper for inspecting recipes and asserting justfile contract behaviour.

JustfileFixture Methods

Methods for the JustfileFixture class

JustfileFixture.recipe_names()

List recipe names, optionally including private recipes.

JustfileFixture.dependencies()

Return direct dependency recipe names for recipe.

JustfileFixture.parameters()

Return raw parameter payloads for recipe.

JustfileFixture.parameter_names()

Return parameter names for recipe.

JustfileFixture.is_shebang()

Report whether recipe is marked as a shebang recipe.

JustfileFixture.is_private()

Report whether recipe is marked private.

JustfileFixture.doc()

Return recipe documentation text if present.

JustfileFixture.body()

Return raw body fragments for recipe.

JustfileFixture.show()

Return rendered recipe text from just --show with caching.

JustfileFixture.assignments()

Return assignment values keyed by assignment name.

JustfileFixture.aliases()

Return alias-to-target recipe mappings.

JustfileFixture.assert_exists()

Assert that recipe exists.

JustfileFixture.assert_depends_on()

Assert dependency expectations for a recipe.

JustfileFixture.assert_parameter()

Assert that recipe declares parameter, optionally checking attributes.

JustfileFixture.assert_body_contains()

Assert that rendered recipe text contains text.

JustfileFixture.assert_not_shebang()

Assert that recipe can be dry-run safely.

JustfileFixture.assert_variable_referenced()

Assert that variable is structurally referenced in recipe body fragments.

JustfileFixture.dry_run()

Run just --dry-run for any recipe, including shebang and script recipes.

JustfileFixture.assert_dry_run_contains()

Assert successful dry-run output contains text.

Exceptions

Exception classes

JustCommandError

Raised when invoking just fails.

JustJsonFormatError

Raised when just --dump JSON is malformed or incompatible.

UnknownRecipeError

Raised when a requested recipe does not exist.