F
🦄 The closest thing to template literals in Go. Parse expressions in strings - the simple way.
Install / Use
/learn @atomicgo/FREADME
<p align="center"> <strong><a href="https://pkg.go.dev/atomicgo.dev/f#section-documentation" target="_blank">Documentation</a></strong> | <strong><a href="https://github.com/atomicgo/atomicgo/blob/main/CONTRIBUTING.md" target="_blank">Contributing</a></strong> | <strong><a href="https://github.com/atomicgo/atomicgo/blob/main/CODE_OF_CONDUCT.md" target="_blank">Code of Conduct</a></strong> </p>
<p align="center"> <img src="https://raw.githubusercontent.com/atomicgo/atomicgo/main/assets/header.png" alt="AtomicGo"> </p> <p align="center"> <table> <tbody> </tbody> </table> </p> <h3 align="center"><pre>go get atomicgo.dev/f</pre></h3> <p align="center"> <table> <tbody> </tbody> </table> </p> <!-- gomarkdoc:embed:start --> <!-- Code generated by gomarkdoc. DO NOT EDIT -->
f
import "atomicgo.dev/f"
F is the closest thing to template literals in Go.
F is a simple, fast and safe way to format strings in Go, with a familiar syntax. It evaluates expressions inside `${}` and replaces them with their values.
The expressions support many operators, including ternary operator, and function calls. See the syntax here: https://expr.medv.io/docs/Language-Definition
<details><summary>Example (Demo)</summary> <p>package main
import (
"fmt"
"atomicgo.dev/f"
)
type Person struct {
Name string
Age int
}
func main() {
// Format a string with a struct
john := Person{Name: "Bob", Age: 22}
fmt.Println(f.Format("${Name} is ${Age} years old", john))
// Format a string with a map
alice := map[string]any{"Name": "Alice", "Age": 27}
fmt.Println(f.Format("${Name} is ${Age} years old", alice))
// Evaluate an expression
fmt.Println(f.Format("John is 22 years old: ${Age == 22}", john))
// Ternary operator
fmt.Println(f.Format("John is 22 years old: ${Age == 22 ? 'yes' : 'no'}", john))
}
Output
Bob is 22 years old
Alice is 27 years old
John is 22 years old: true
John is 22 years old: yes
Index
- func Format(template string, data ...any) string
- func FormatSafe(template string, data ...any) (string, error)
- type Parsed
- type Part
<a name="Format"></a>
func Format
func Format(template string, data ...any) string
Format formats the template string.
<a name="FormatSafe"></a>
func FormatSafe
func FormatSafe(template string, data ...any) (string, error)
FormatSafe formats the template string and returns an additional, optional error, if something goes wrong.
<a name="Parsed"></a>
type Parsed
Parsed contains a parsed template string, ready to be evaluated.
type Parsed struct {
Template string
Parts []Part
}
<a name="Parse"></a>
func Parse
func Parse(template string) Parsed
Parse parses a template string into a Parsed struct.
<a name="Parsed.Eval"></a>
func (Parsed) Eval
func (parsed Parsed) Eval(data any) (string, error)
Eval evaluated expressions in the parsed template string.
<a name="Parsed.String"></a>
func (Parsed) String
func (parsed Parsed) String() string
String returns the parsed template parts as a single string.
<a name="Part"></a>
type Part
Part is a single part of a template string. Can either be a raw string, or an expression.
type Part struct {
Value string
Parsed bool
}
Generated by gomarkdoc
<!-- gomarkdoc:embed:end -->AtomicGo.dev · with ❤️ by @MarvinJWendt | MarvinJWendt.com
