feat: add alias q for template function shellQuote (#1603)

Resolves #1601
go-task · Apr 24, 2024 · 16070c7 · 16070c7
1 parent 72d9671
commit 16070c7
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,7 @@
   @pd93).
 - Fix error when a file or directory in the project contained a special char
   like `&`, `(` or `)` (#1551, #1584 by @andreynering).
+- Added alias `q` for template function `shellQuote` (#1601 by @vergenzt)
 
 ## v3.36.0 - 2024-04-08
 

diff --git a/internal/templater/funcs.go b/internal/templater/funcs.go
@@ -73,6 +73,10 @@ func init() {
 			return spew.Sdump(v)
 		},
 	}
+
+	// aliases
+	taskFuncs["q"] = taskFuncs["shellQuote"]
+
 	// Deprecated aliases for renamed functions.
 	taskFuncs["FromSlash"] = taskFuncs["fromSlash"]
 	taskFuncs["ToSlash"] = taskFuncs["toSlash"]

diff --git a/website/docs/usage.mdx b/website/docs/usage.mdx
@@ -1415,7 +1415,7 @@ Task also adds the following functions:
   converts a string from `/` path format to `\`.
 - `exeExt`: Returns the right executable extension for the current OS (`".exe"`
   for Windows, `""` for others).
-- `shellQuote`: Quotes a string to make it safe for use in shell scripts. Task
+- `shellQuote` (aliased to `q`): Quotes a string to make it safe for use in shell scripts. Task
   uses [this Go function](https://pkg.go.dev/mvdan.cc/sh/v3@v3.4.0/syntax#Quote)
   for this. The Bash dialect is assumed.
 - `splitArgs`: Splits a string as if it were a command's arguments. Task uses

diff --git a/website/versioned_docs/version-latest/usage.mdx b/website/versioned_docs/version-latest/usage.mdx
@@ -1377,7 +1377,7 @@ Task also adds the following functions:
   converts a string from `/` path format to `\`.
 - `exeExt`: Returns the right executable extension for the current OS (`".exe"`
   for Windows, `""` for others).
-- `shellQuote`: Quotes a string to make it safe for use in shell scripts. Task
+- `shellQuote` (aliased to `q`): Quotes a string to make it safe for use in shell scripts. Task
   uses [this Go function](https://pkg.go.dev/mvdan.cc/sh/v3@v3.4.0/syntax#Quote)
   for this. The Bash dialect is assumed.
 - `splitArgs`: Splits a string as if it were a command's arguments. Task uses