https://github.com/kagisearch/mustache-codegen
Mustache template code generation for Go and JavaScript
https://github.com/kagisearch/mustache-codegen
codegen go golang javascript mustache-templates
Last synced: 7 months ago
JSON representation
Mustache template code generation for Go and JavaScript
- Host: GitHub
- URL: https://github.com/kagisearch/mustache-codegen
- Owner: kagisearch
- License: mit
- Created: 2025-02-24T17:59:34.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-02-24T22:11:00.000Z (7 months ago)
- Last Synced: 2025-02-24T22:28:15.432Z (7 months ago)
- Topics: codegen, go, golang, javascript, mustache-templates
- Language: Go
- Homepage:
- Size: 70.3 KB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mustache-codegen
mustache-codegen is an implementation of the [Mustache templating language][]
that emits compiled code for Go and JavaScript.
This permits programs to use static Mustache templates
for rendering text formats like HTML
without requiring the runtime overhead and binary size of template parsing.
mustache-codegen implements Mustache v1.4, including [inheritance][].
See [mustache(5)][] for a syntax manual.
[Mustache templating language]: https://mustache.github.io/
[inheritance]: https://mustache.github.io/mustache.5.html#Parents
[mustache(5)]: https://mustache.github.io/mustache.5.html
## Installation
[Install Go][], and then run:
```shell
go install github.com/kagisearch/mustache-codegen/cmd/mustache-codegen@latest
```
This will install the `mustache-codegen` in `$GOPATH/bin`.
(Use `go env GOPATH` to locate `$GOPATH` if this is not already on your `PATH`.)
[Install Go]: https://go.dev/dl/
## Using with Go
Use `mustache-codegen -lang=go` to generate Go code from a Mustache template.
For example, if we have a template `foo_bar.mustache` with the following content:
```mustache
{{! foo_bar.mustache }}
Hello, {{subject}}!
```
Then we run:
```shell
mustache-codegen -lang=go -o foo_bar.go foo_bar.mustache
```
mustache-codegen will create a function in foo_bar.go with the following signature:
```go
package main
func FooBar(buf *bytes.Buffer, data any)
```
The function's name is based on the template file's name.
The generated package name can be changed with the `-go-package` option.
The template accesses the data via reflection.
See the [support package][Go support package] for details on how Mustache tags
map to Go data structures.
We can use the template function by creating another file `main.go` like this:
```go
package main
import (
"bytes"
"os"
)
func main() {
buf := new(bytes.Buffer)
FooBar(buf, map[string]string{"subject": "World"})
buf.WriteTo(os.Stdout)
}
```
[Go support package]: https://pkg.go.dev/github.com/kagisearch/mustache-codegen/go/mustache
## Using with JavaScript
Use `mustache-codegen -lang=js` to generate JavaScript code from a Mustache template.
The generated code will use [JavaScript module syntax][]
and export a default function that takes the data as its sole argument
and returns the rendered template as a string.
For example, if we have a template `foo.mustache` with the following content:
```mustache
{{! foo.mustache }}
Hello, {{subject}}!
```
Then we run:
```shell
mustache-codegen -lang=js -o foo.mjs foo.mustache
```
We can use the template like this:
```javascript
// main.mjs
import foo from "./foo.mjs"
console.log(foo({subject: "World"}))
```
[JavaScript module syntax]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
### Using with TypeScript
If you are using [TypeScript][],
you can make a `.js` file typed by adding a [`.d.ts` file][] with the same base name.
For the example above, a reasonable `foo.d.ts` file would be:
```typescript
export interface Params {
foo: string
}
export default function(params: Params): string
```
mustache-codegen cannot automatically generate type information for its templates
because Mustache tags can intentionally operate on many data types
and variables can refer to data in parent contexts.
[TypeScript]: https://www.typescriptlang.org/
[`.d.ts` file]: https://www.typescriptlang.org/docs/handbook/declaration-files/introduction.html
## Partials
Upon encountering a partial tag like `{{>foo}}` or a parent tag like `{{