Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/3f/jt
Extremely Small, Fast, and damn Customizable ⚙ template engine on Native low-level implementation. / Mr. Jt / [ TypeScript & JavaScript ]
https://github.com/3f/jt
customizable customizable-templates javascript jevel jt mr-jt mrjt native-template native-template-engine nodejs template template-engine templater typescript web
Last synced: 27 days ago
JSON representation
Extremely Small, Fast, and damn Customizable ⚙ template engine on Native low-level implementation. / Mr. Jt / [ TypeScript & JavaScript ]
- Host: GitHub
- URL: https://github.com/3f/jt
- Owner: 3F
- License: mit
- Created: 2019-05-12T20:50:27.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-05-28T20:45:26.000Z (over 5 years ago)
- Last Synced: 2024-11-24T16:48:47.954Z (about 1 month ago)
- Topics: customizable, customizable-templates, javascript, jevel, jt, mr-jt, mrjt, native-template, native-template-engine, nodejs, template, template-engine, templater, typescript, web
- Language: JavaScript
- Homepage:
- Size: 54.7 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- Changelog: changelog.txt
- Funding: .github/FUNDING.yml
- License: License.txt
Awesome Lists containing this project
README
# [](https://github.com/3F/Jt)
🎩
Meet beardless customizable template engine, Mr. Jt for Node.js and Web browsers.
[](https://ci.appveyor.com/project/3Fs/jt/branch/master)
[](https://coveralls.io/github/3F/Jt)
[](https://ci.appveyor.com/project/3Fs/jt/build/tests)
[](https://github.com/3F/Jt/releases/latest)
[](https://www.npmjs.com/package/mrjt)
[](https://github.com/3F/Jt/blob/master/License.txt)
[](https://unpkg.com/mrjt/Core/Jt.es6.js)
[](https://ci.appveyor.com/project/3Fs/jt/history)
```javascript
jt.use('', ' $Hello %p% {{world}} ')
.as({ p: 'amazing'})
.reset().as({ p: 'crazy'})
// ... +$Hello, +{{world}}
```
```javascript
jt.use('s1', 'Today is a {( a < b )} good {/} bad {;} day!')
.sa(jtif, { a: 5, b: 7})
.value()
```
## Why Jt ?
Extremely small, fast, and damn customizable. Okay, Let's see what's going on:
### Speed 🚀
Only **native** lower-level implementation. Even for conditional statements, like:
```
{( d > 5 )} yes {/} no {;}
```
Which do **not** uses `regex`, or `eval()`, or `new Function()`, ... Feel the speed.
### Size 📦
Extra small size. Just about o-n-e kilobyte of fully workable core engine:
* ~ **1.02 KB** for Core of ES6 gzipped;
* ~ 1.09 KB for Core of **ES3** gzipped;
*Same things for custom handlers.*
### Configurable 🔧
You can configure, add, or change anything!
Jt was designed to be loyal to your preferences *on the fly*. Maybe for this:
```javascript
jt.use('s1', 'Good {{p}}, $p -p- !')
.as({ p: 'Jt' })
.as({ p: 'Mr.' }, {op: '$'})
.as({ p: 'morning' }, '{{}}')
.val(),
```
Or for this:
```javascript
// {( true )} yes {/} no {;} -> {if( true )} yes {else} no {endif}
jt.use('legacy', '{if( true )} yes {else} no {endif}!')
.sa(new JtIfHandler([ '{}' ],
{
if: 'if',
else: 'else',
fi: 'endif',
}))
.val() // yes !
```
Or for something more ...
### Extensible via Pluginable handlers 🗃
Sure! Add or change any features for the layers, still *on the fly*.
Do you need something special? No problem, just implement [IJtHandler](https://github.com/3F/Jt/blob/master/src/Handlers/IJtHandler.ts) to cover your awesome things. It easy.
### Comfy but strong 🌇
Changeable layers through common chain will make you happy.
You can control everything just in a few steps:
```javascript
jt.use('hello', 'Hello you from $tip, dear $name.')
.as({ tip: 'Jt', name: 'John' }); // Hello you from Jt, dear John.
// ...
jt.use('hello')
.as(-1, true)
.as({ name: 'Denis' }) // Hello you from Jt, dear Denis.
.reset()
.as({ tip: 'Moscow' })
.eject((v) => t.is(v, 'Hello you from Moscow, dear $name.'))
...
.as({ name: '{( r > 100 )}friend{/}visitor{;}' })
.sa(jtif, { r: actual }) // // Hello you from Moscow, dear friend.
...
.val();
🐧
```
### Stability 🗠
Clean **[API](#api)** and its **tests** will take care of your peace of mind. [](https://coveralls.io/github/3F/Jt)
[](https://ci.appveyor.com/project/3Fs/jt/build/tests)
### No dependencies to something 👐
Developed from scratch without dependencies to something from our end-product.
### Open and Free 🍰
Open Source project; MIT License, Yes! Enjoy!
## License
Licensed under the [MIT License (MIT)](https://github.com/3F/Jt/blob/master/License.txt)
```
Copyright (c) 2019 Denis Kuzmin < [email protected] > GitHub/3F
```
[ [ ☕ Donate ](https://3F.github.com/Donation/) ]
## API
* Core: [IJt](https://github.com/3F/Jt/blob/master/src/Core/IJt.ts) ➟ [IJtAct](https://github.com/3F/Jt/blob/master/src/Core/IJtAct.ts)
* Configuration: [IJtConfig](https://github.com/3F/Jt/blob/master/src/Core/IJtConfig.ts)
* Handlers: [IJtHandler](https://github.com/3F/Jt/blob/master/src/Handlers/IJtHandler.ts)
## Download
Separate ES3+/ES6+ support for your environment. Choose more suitable package for your case.
* NPM: [](https://www.npmjs.com/package/mrjt)
* CDN: [](https://unpkg.com/mrjt/Core/Jt.es6.js)
* ... `https://unpkg.com/mrjt[@version]/[path_to_specific_file]`
* GHR Stable: [/releases](https://github.com/3F/Jt/releases) [ [latest](https://github.com/3F/Jt/releases/latest) ]
* CI builds: [`/artifacts` page](https://ci.appveyor.com/project/3Fs/jt/history) or find as `Pre-release` with mark `🎲 Nightly build` on [GitHub Releases](https://github.com/3F/Jt/releases) page.
## Build & Tests
```
npm install
gulp build --conf debug
```
Available tests can be raised by command:
```
npm test
```
We're waiting for your awesome contributions!