summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGino Vincenzini <OpenMySourceCode@gmail.com>2023-10-09 00:05:05 -0400
committerGitHub <noreply@github.com>2023-10-09 04:05:05 +0000
commit7e5bac66ae77a11d6af766d46873b83fb92b66c5 (patch)
tree7b054f9b0b81dc993c2f66879dd97e3860f9b583
parent992c6943da90c9b0e421e5d2f25e24d699f1fa02 (diff)
Update Indentation Documentation (#1600)
-rw-r--r--README.md38
1 files changed, 37 insertions, 1 deletions
diff --git a/README.md b/README.md
index 928c59fa..33477a30 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