Skip to content

Commit 6822fc7

Browse files
committed
docs: add shell alias tip for shellscript_format
Signed-off-by: Sebastian Davids <[email protected]>
1 parent e933db5 commit 6822fc7

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

docs/user-guide/modules/ROOT/pages/scripts/general/shellscript-format.adoc

+18
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,24 @@ $ scripts/general/shellscript_format.sh
1313
$ scripts/general/shellscript_format.sh /tmp/example
1414
----
1515

16+
[TIP]
17+
====
18+
Instead of this script you might want to add a shell alias:
19+
20+
[,shell]
21+
----
22+
alias shfmtg='shfmt --write --indent 2 --case-indent --binary-next-line --simplify'
23+
----
24+
25+
26+
27+
[,console]
28+
----
29+
$ shfmtg .
30+
$ shfmtg /tmp/example
31+
----
32+
====
33+
1634
== Prerequisites
1735

1836
* xref:developer-guide::dev-environment/dev-installation.adoc#shfmt[shfmt]

0 commit comments

Comments
 (0)