From 7e5bac66ae77a11d6af766d46873b83fb92b66c5 Mon Sep 17 00:00:00 2001 From: Gino Vincenzini Date: Mon, 9 Oct 2023 00:05:05 -0400 Subject: [PATCH] Update Indentation Documentation (#1600) --- README.md | 38 +++++++++++++++++++++++++++++++++++++- 1 file changed, 37 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 928c59f..33477a3 100644 --- a/README.md +++ b/README.md @@ -1918,7 +1918,43 @@ foo: ### Indentation -Recipe lines can be indented with spaces or tabs, but not a mix of both. All of a recipe's lines must have the same indentation, but different recipes in the same `justfile` may use different indentation. +Recipe lines can be indented with spaces or tabs, but not a mix of both. All of a recipe's lines must have the same type of indentation, but different recipes in the same `justfile` may use different indentation. + +Each recipe must be indented at least one level from the `recipe-name` but after that may be further indented. + +Here's a justfile with a recipe indented with spaces, represented as `·`, and tabs, represented as `→`. + +```justfile +set windows-shell := ["pwsh", "-NoLogo", "-NoProfileLoadTime", "-Command"] + +set ignore-comments + +list-space directory: +··#!pwsh +··foreach ($item in $(Get-ChildItem {{directory}} )) { +····echo $item.Name +··} +··echo "" + +# indentation nesting works even when newlines are escaped +list-tab directory: +→ @foreach ($item in $(Get-ChildItem {{directory}} )) { \ +→ → echo $item.Name \ +→ } +→ @echo "" +``` + +```pwsh +PS > just list-space ~ +Desktop +Documents +Downloads + +PS > just list-tab ~ +Desktop +Documents +Downloads +``` ### Multi-Line Constructs