feat: add numCPU func (#1890)

go-task · Oct 29, 2024 · c381923 · c381923
1 parent 7bfddaa
commit c381923
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/internal/templater/funcs.go b/internal/templater/funcs.go
@@ -17,8 +17,9 @@ var templateFuncs template.FuncMap
 
 func init() {
 	taskFuncs := template.FuncMap{
-		"OS":   func() string { return runtime.GOOS },
-		"ARCH": func() string { return runtime.GOARCH },
+		"OS":     func() string { return runtime.GOOS },
+		"ARCH":   func() string { return runtime.GOARCH },
+		"numCPU": func() int { return runtime.NumCPU() },
 		"catLines": func(s string) string {
 			s = strings.ReplaceAll(s, "\r\n", " ")
 			return strings.ReplaceAll(s, "\n", " ")

diff --git a/website/docs/reference/templating.mdx b/website/docs/reference/templating.mdx
@@ -374,7 +374,8 @@ Lastly, Task itself provides a few functions:
 | Function     | Description                                                                                                                                                                                            |
 | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | `OS`         | Returns the operating system. Possible values are `windows`, `linux`, `darwin` (macOS) and `freebsd`.                                                                                                  |
-| `ARCH`       | return the architecture Task was compiled to: `386`, `amd64`, `arm` or `s390x`.                                                                                                                        |
+| `ARCH`       | Returns the architecture Task was compiled to: `386`, `amd64`, `arm` or `s390x`.                                                                                                                        |
+| `numCPU`     | Returns the number of logical CPU's usable by the current process.                                                                                                                                     |
 | `splitLines` | Splits Unix (`\n`) and Windows (`\r\n`) styled newlines.                                                                                                                                               |
 | `catLines`   | Replaces Unix (`\n`) and Windows (`\r\n`) styled newlines with a space.                                                                                                                                |
 | `toSlash`    | Does nothing on Unix, but on Windows converts a string from `\` path format to `/`.                                                                                                                    |