jazz - GitLite

KO | EN

gitlite — search

#javascript #python #react #typescript #go #golang #rust #nodejs #awesome #vue #pytorch #ios #mcp #open-source

jazz

(★ 60)

OG template engine for Node.js

파일 탐색기

최종 버전 다운로드 (.zip)

- - ci-workflow.yaml
  - codeql-analysis.yml
  - publish-workflow.yaml
  - release-major-workflow.yaml
  - release-minor-workflow.yaml
  - release-patch-workflow.yaml
  - upgrade-deps-workflow.yaml
- filter.jazz
- filter.js
- foreach.jazz
- foreach.js
- foreach_object.jazz
- foreach_object.js
- getattr.jazz
- getattr.js
- html.jazz
- html.js
- ifelse.jazz
- ifelse.js
- include.js
- include_footer.jazz
- include_header.jazz
- include_main.jazz
- include_subheader.jazz
- jazz-lib.sh
- letter.jazz
- letter.js
- simple.jazz
- simple.js
- - ast.js
  - compiler.js
  - error.js
  - parser.js
  - scanner.js
  - tokens.js
- jazz.js
- ast.js
- compiler.js
- error.js
- jazz.js
- parser.js
- scanner.js
- tokens.js
- - render.js
- access.js
- conditionals.js
- expressions.js
- functions.js
- loops.js
- rendering.js
.bob.json
.gitignore
.rtk.json
AGENTS.md
avatar.jpg
CHANGELOG.md
eslint.config.js
LICENSE
Makefile
Makefile-extras
package-lock.json
package.json
README.md
suntory.yml

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![Avatar](https://raw.githubusercontent.com/cliffano/jazz/main/avatar.jpg)

[![Build Status](https://github.com/cliffano/jazz/workflows/CI/badge.svg)](https://github.com/cliffano/jazz/actions?query=workflow%3ACI)
[![Dependencies Status](https://img.shields.io/librariesio/release/npm/jazz)](https://libraries.io/npm/jazz)
[![Code Scanning Status](https://github.com/cliffano/jazz/workflows/CodeQL/badge.svg)](https://github.com/cliffano/jazz/actions?query=workflow%3ACodeQL)
[![Coverage Status](https://coveralls.io/repos/github/cliffano/jazz/badge.svg?branch=main)](https://coveralls.io/r/cliffano/jazz?branch=main)
[![Security Status](https://snyk.io/test/github/cliffano/jazz/badge.svg)](https://snyk.io/test/github/cliffano/jazz)
[![Published Version](https://img.shields.io/npm/v/jazz.svg)](https://www.npmjs.com/package/jazz)

# Jazz

Jazz is a minimalistic template engine with zero runtime dependency.

One of the OG template engines with first commit from 2010.

## Installation

```shell
npm install jazz
```

## Usage

```javascript
import jazz from "jazz";
import sys from "sys";

const template = jazz.compile("my template source code {someVariable}");
template.eval({"someVariable": "lolmuffin"}, function(data) { sys.puts(data); });
```

This example would output the following:

```text
my template source code lolmuffin
```

### Printing variables

```text
{someVariable}
```

This works for any type of expression, so the following should also work:

```text
{users.fred}
{"hello"}
{45}
{a eq b}
```

### Filter functions

You can call filter functions like so:

```text
{someFilter(arg1, arg2)}
```

Filter functions are statements, NOT expressions so they cannot be chained
nor used in if/forelse/etc. tests. However, calls can be made on any type
of expression -- e.g.

```text
{math.sin(45)}
```

### Implementing filter functions

Filter functions may block so rather than returning the value you want
rendered as you might in other frameworks, jazz passes in a callback to
your filter function that you then call to indicate that you have a
result. e.g. here we simulate a blocking operation using setTimeout().

```text
// sum.jazz

{sum(5, 10)}
```

```javascript
// sum.js

import jazz = from "jazz";

const params = {
    sum: function(arg1, arg2, cb) {
        setTimeout(function() {
            cb((arg1 + arg2).toString());
        }, 2000);
    }
}
jazz.compile("sum.jazz").eval(params, function(output) { console.log(output); });
```

Note that even though the execution of the callback is delayed, this example still
works.

### Conditional Statements

You can check if a variable evaluates to a true value like so:

```text
{if name}
    Hello, {name}
{end}
```

Else clauses are also supported:

```text
{if name}
    Hello, {name}
{else}
    Hello, Captain Anonymous
{end}
```

As are else..if clauses:

```text
{if firstName}
    Hello, {firstName}
{elif lastName}
    Hello, Mr. {lastName}
{else}
    Hello, Captain Anonymous
{end}
```

Limited logical expressions are also possible:

```text
{if user.lastName and user.isVip}
    Hello, Mr. {user.lastName}, my good man!
{end}

{if fred.tired or fred.bored}
    Fred: "Yawn!"
{end}

{if not awake}
    Zzz
{end}
```

eq & neq comparison operators are available for comparing two values:

```text
{if config.feature eq "enabled"}
    Feature is enabled!
{end}

{if status neq "inactive"}
    Huzzah!
{end}
```

You can also group expressions using parentheses:

```text
{if (a and b) or c}
    ...
{end}
```

### Looping over an array

```html
{foreach item in someArray}
    <p>{item}</p>
{end}
```

The value being iterated over can be any expression supporting
an Array-like interface.

### Looping over an object

```html
{foreach pair in someObject}
    <p>{pair.key} = {pair.value}</p>
{end}
```

### Synchronous functions

```html
{if @blah('a')}
    <p>There were so many blahs in a</p>
{end}
```

The function is provided to the template the same way asynchronous functions are, just with a return instead of a cb.

### Loop counters / index

```html
{foreach pair in someObject}
    <p>Loop number (1 based): {__count}</p>
    <p>Index (0 based): {__index}</p>
    <p>{pair.key} = {pair.value}</p>
{end}
```

### Looking into arrays/objects

```html
<p>{object['array'][0].cheese}</p>
```

## Credits

Jazz was created by the brilliant Thomas Lee and Daniel Brain during the era of Shine Technologies early adoption of node.

## Colophon

[Developer's Guide](https:/cliffano.github.io/developers-guide-nodejs.html)

Build reports:

* [Code complexity report](https://cliffano.github.io/jazz/complexity/plato/index.html)
* [Unit tests report](https://cliffano.github.io/jazz/test/mocha.txt)
* [Test coverage report](https://cliffano.github.io/jazz/coverage/c8/index.html)
* [Integration tests report](https://cliffano.github.io/jazz/test-integration/mocha.txt)
* [API Documentation](https://cliffano.github.io/jazz/doc/jsdoc/index.html)