https://github.com/squarespace/template-engine

TypeScript implementation of Squarespace template language
https://github.com/squarespace/template-engine

Last synced: 2 days ago
JSON representation

TypeScript implementation of Squarespace template language

• Host: GitHub
• URL: https://github.com/squarespace/template-engine
• Owner: Squarespace
• License: apache-2.0
• Created: 2017-12-15T19:07:55.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2024-11-28T15:48:54.000Z (about 2 months ago)
• Last Synced: 2025-01-16T09:33:09.077Z (10 days ago)
• Language: TypeScript
• Homepage:
• Size: 932 KB
• Stars: 26
• Watchers: 16
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        

# template-engine

This is a port of the Squarespace Java [template-compiler](https://github.com/squarespace/template-compiler) project to TypeScript.

[![Build Status](https://travis-ci.org/Squarespace/template-engine.svg?branch=master)](https://travis-ci.org/Squarespace/template-engine)

[![Coverage Status](https://img.shields.io/coveralls/Squarespace/template-engine.svg)](https://coveralls.io/github/Squarespace/template-engine?branch=master)

### Versioning

The following live branches exist:

* `1.x` - for ongoing releases using [moment](https://www.npmjs.com/package/moment) and moment-timezone as direct dependencies

* `master` - 2.x and future releases using [@phensley/cldr](https://www.npmjs.com/package/@phensley/cldr) for international formatting

### Rationale

The need for compilation of Squarespace templates in the browser has grown over time. The existing projects that enable browser compilation of Squarespace templates are incomplete, incompatible and have maintenance issues.

This project is a new implementation of the Squarespace template syntax with the following goals:

 * Provide a sound foundation for current and future development.

 * Meet frontend application performance criteria.

 * Support all current server-side functionality, including all plugins.

 * Full compatibility with server compiler.

 * Separate the parsing and execution phases to support repeated executions of a template efficiently.

 * Organized and modular codebase.

 * Follow same basic design as Java compiler.

 * High test coverage.

### License

[Apache 2.0](https://tldrlegal.com/license/apache-license-2.0-(apache-2.0))