PHPackages pablotron/luigi-template - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Templating & Views](/categories/templating) 4. / 5. pablotron/luigi-template ActiveLibrary[Templating & Views](/categories/templating) pablotron/luigi-template ======================== String emplate library. v0.5.0(7y ago)033MITJavaPHP ^7 Since Oct 5Pushed 7y ago1 watchersCompare [ Source](https://github.com/pablotron/luigi-template)[ Packagist](https://packagist.org/packages/pablotron/luigi-template)[ Docs](https://github.com/pablotron/luigi-template)[ RSS](/packages/pablotron-luigi-template/feed)WikiDiscussions master Synced 2w ago READMEChangelogDependencies (2)Versions (2)Used By (0) Luigi Template ============== [](#luigi-template) Overview -------- [](#overview) Simple multi-language string templating library inspired by [Unix pipes](https://en.wikipedia.org/wiki/Pipeline_(Unix)). Features: - Multi-language: Java, JavaScript, PHP, and Ruby. - Chainable filters, via piping. - Useful built-in filters. - Template caching. - Small: Less than 4k minified (see `luigi-template.min.js`), - Stand-alone: No external dependencies (no jQuery, etc), - Compatible: Works in browsers as old as IE9. - MIT-licensed. Installation (Java) ------------------- [](#installation-java) To generate a stand-alone JAR file, do the following: ``` mvn package ``` The generated JAR file will be available in the `target/` directory. Installation (JavaScript) ------------------------- [](#installation-javascript) Minify `luigi-template.js` using your minifier of choice, and drop it into your source tree. I like [jsmin](https://www.crockford.com/javascript/jsmin.html), personally: ``` jsmin < luigi-template.js > luigi-template-0.5.0.min.js ``` *Note:* If you are upgrading from a pre-0.5.0 version of Luigi Template, be sure to include `luigi-compat.js` as well. See the *Changes in 0.5.0* section below for details. Installation (PHP) ------------------ [](#installation-php) ### Using [Composer](https://getcomposer.org/) [](#using-composer) ``` # in your project root composer require pablotron/luigi-template:~0.5 ``` Or add it to the `composer.json` for your project, like so: ``` "require": { "pablotron/luigi-template": "~0.5" }, ``` ### Manual Installation [](#manual-installation) The source file for Luigi Template is entirely self-contained, which means you can embed it directly in your project without using [Composer](https://getcomposer.org/) by doing the following: ``` # copy file to your project cp php/src/Template.php path/to/your/project/ # then, somewhere in your project... require_once 'path/to/Template.php'; ``` Installation (Ruby) ------------------- [](#installation-ruby) Install via [RubyGems](https://rubygems.org/): ``` # install luigi-template via ruby gems gem install -r luigi-template ``` Usage (JavaScript) ------------------ [](#usage-javascript) A minimal template: ``` // create template var t = new Luigi.Template('hello %{name}'); // run template, print result to console console.log(t.run({ name: 'Paul', })); // prints "hello Paul" ``` If you have a template that you only need to run one time, you can use the `Luigi.run()` singleton to run it, like this: ``` // create and run template in one shot var r = Luigi.run('hello %{name}', { name: 'Paul', }); // print result to console console.log(r); // prints "hello Paul" ``` Templates parameters can be modified by filters. Filters are applied to a parameter value by appending a `|` (pipe) character, followed by the filter name. Here is the template from above, with the name value HTML-escaped using a built-in filter: ``` // create template that prints hello and the HTML-escaped name var t = new Luigi.Template('hello %{name | h}'); // run template, print result to console console.log(t.run({ name: '', })); // prints "hello <Paul>" ``` The built-in templates are: - `uc`: Upper-case string value. - `lc`: Lower-case string value. - `s`: Pluralize a value by returning `""` if the value is 1, and `"s"` otherwise. - `length`: Get the length of an array. - `trim`: Trim leading and trailing whitespace from a string. - `h`: HTML-escape a string value. - `u`: URL-escape a string value. - `json`: JSON-encode a value. You can create your own custom filters, too. The easiest way to create your own custom filter is to add it to the set of global filters (`Luigi.FILTERS`), like so: ``` // add global template filter Luigi.FILTERS.barify = function(s) { return 'bar-' + s + '-bar'; }; // create template that uses custom global filter var t = new Luigi.Template('hello %{name | barify | h}'); // run template, print result to console console.log(t.run({ name: '', })); // prints "hello bar-<Paul>-bar" ``` You can also create a custom filter and limit it to a particular template by passing a custom filter hash as the second parameter to the `Luigi.Template` constructor, like this: ``` // create template with custom template-specific filter var t = new Luigi.Template('hello %{name | barify | h}', { barify: function(s) { return 'bar-' + s + '-bar'; }, }); // run template, print result to console console.log(t.run({ name: '', })); // prints "hello bar-<Paul>-bar" ``` You can pass arguments to your custom filters. Here's an example: ``` // create template with custom template-specific filter named // "wrap", which wraps the value in the given filter parameters var t = new Luigi.Template('hello %{name | wrap head tail | h}', { wrap: function(s, args) { if (args.length == 2) { return [args[0], s, args[1]].join('-'; } else if (args.length == 1) { return [args[0], s, args[0]].join('-'); } else { return s; } }, }); // run template, print result to console console.log(t.run({ name: '', })); // prints "hello head-<Paul>-tail" ``` If you have a lot of separate templates, or a few large templates, then it's a good idea to use a template cache. A template cache will create templates as they are needed (also known as "lazy initialization"), so the script loads quickly. A template cache also caches instantiated (that is, created) templates for future use, so that running a template from the cache is fast too. Here's how you create a template cache: ``` // create template cache with a single template var cache = Luigi.cache({ hello: 'hello %{name | uc | h}' }); // run template, print result to console console.log(cache.run('hello', { name: '', })); // prints "hello <PAUL%gt;" ``` Template caches use their own set of custom filters by passing a custom filter hash when creating a template cache: ``` // create template cache with a custom filter named "reverse" var cache = Luigi.cache({ hello: 'hello %{name | uc | reverse | h}' }, { reverse: function(s) { var cs = (s || '').split(''); cs.reverse(); return cs.join(''); }, }); // run template, print result to console console.log(cache.run('hello', { name: '', })); // prints "hello %gt;LUAP<" ``` A template cache is also a convenient way to group all of the templates in a script together: ``` // add global filter named "reverse" Luigi.FILTERS.reverse = function(s) { var cs = (s || '').split(''); cs.reverse(); return cs.join(''); }; // create template cache var TEMPLATES = Luigi.cache({ upper: 'hello %{name | uc | h}', reverse: 'hello %{name | reverse | h}', }); // run the upper and reverse templates above and populate // the elements #upper and #reverse with their respective // result ['upper', 'reverse'].forEach(function(id) { getElementByid(id).innerHTML = TEMPLATES.run(id, { name: '', }); }); ``` Documentation ------------- [](#documentation) Usage documentation is available in the *Usage* section above, and API documentation is available online at the following URL: See the following sections to generate language-specific API documentation. Documentation (Java) -------------------- [](#documentation-java) The Java implementation of Luigi Template uses the [maven-javadoc-plugin](https://maven.apache.org/plugins/maven-javadoc-plugin/) to generate API documentation. To generate API documentation in `java/target/apidocs/`: ``` cd java/ mvn javadoc:javadoc ``` To generate API documentation as a `jar` file: ``` cd java/ mvn javadoc:jar ``` See [this page](https://maven.apache.org/plugins/maven-javadoc-plugin/usage.html) for additional options. Documentation (JavaScript) -------------------------- [](#documentation-javascript) You can generate the JavaScript API documentation using [jsdoc](http://usejsdoc.org/). Documentation (Ruby) -------------------- [](#documentation-ruby) You can generate the Ruby API documentation in the `ruby/docs/`directory via [RDoc](https://github.com/ruby/rdoc), like so: ``` # generate API documentation in ruby/docs/ directory cd ruby/ rake docs ``` Tests (Java) ------------ [](#tests-java) To run the Java test suite, do the following: ``` cd java/ mvn test ``` Tests (JavaScript) ------------------ [](#tests-javascript) This `js/test/` directory contains the test suite for the JavaScript implementation of [Luigi Template](https://github.com/pablotron/luigi-template), written in [Mocha](https://mochajs.org/) and [Chai](http://www.chaijs.com/). To run the test suite, load the `js/test/test.html` page in a browser. Tests (PHP) ----------- [](#tests-php) You can run the PHP test suite and static analyzer by doing the following: ``` # run php unit tests and static analyzer composer test ``` To run only the unit tests ([PHPUnit](https://phpunit.de/)): ``` # run the php unit tests composer test-unit ``` To run only the static analyzer ([Phan](https://github.com/phan/phan)): ``` # run the php static analyzer composer test-static ``` Run the unit tests and generate [JUnit](https://junit.org/)-compatible output: ``` # run all unit tests and export the results as XML composer test-xml ``` Tests (Ruby) ------------ [](#tests-ruby) You can run the [minitest](https://github.com/seattlerb/minitest) test suite via [Rake](https://github.com/ruby/rake), like so: ``` # run the test suite cd ruby/ rake test ``` To generate a [JUnit](https://junit.org/)-compatible XML report, install the [minitest-junit](https://github.com/aespinosa/minitest-junit) gem and then do the following: ``` # run the test suite and generate a junit-compatible report.xml cd ruby/ rake test TESTOPTS=--junit ``` Changes in 0.5.0 (JavaScript) ----------------------------- [](#changes-in-050-javascript) Version 0.5.0 of Luigi Template changes the namespace from `LuigiTemplate` to `Luigi`, which has the following effects: - old (0.4.x): `new LuigiTemplate(...)`, new (0.5): `new Luigi.Template(...)` - old (0.4.x): `LuigiTemplate.run(...)`, new: (0.5): `Luigi.run(...)` - old (0.4.x): `LuigiTemplate.VERSION`, new (0.5): `Luigi.VERSION` - old (0.4.x): `LuigiTemplate.FILTERS`, new: (0.5): `Luigi.FILTERS` - old (0.4.x): `new LuigiTemplate.Cache(...)`, new: (0.5): `Luigi.cache(...)` (recommended) or `new Luigi.Cache(...)` If you have an existing system that you cannot make changes to, you can include `luigi-compat.js` as a compatibility shim. Tests for the compatibility shim are available in `js/test/compat/`. *Note:* The compatibility shim will disappear in a future release. Author ------ [](#author) Paul Duncan () License ------- [](#license) Copyright 2014-2018 Paul Duncan () Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ### Health Score 24 — LowBetter than 31% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity7 Limited adoption so far Community7 Small or concentrated contributor base Maturity52 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Unknown Total 1 Last Release 2825d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/238903?v=4)[pabs](/maintainers/pabs)[@Pabs](https://github.com/Pabs) --- Top Contributors [![pablotron](https://avatars.githubusercontent.com/u/523681?v=4)](https://github.com/pablotron "pablotron (112 commits)") ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/pablotron-luigi-template/health.svg) ``` [![Health](https://phpackages.com/badges/pablotron-luigi-template/health.svg)](https://phpackages.com/packages/pablotron-luigi-template) ``` ### Alternatives [limenius/react-bundle Client and Server-side react rendering in a Symfony Bundle 3861.2M](/packages/limenius-react-bundle)[area17/laravel-auto-head-tags Laravel Auto Head Tags helps you build the list of head elements for your app 4616.0k](/packages/area17-laravel-auto-head-tags)[jelix/wikirenderer WikiRenderer is a library to generate HTML or anything else from wiki content. 1712.2k1](/packages/jelix-wikirenderer)[webkinder/sproutset A Composer package for handling responsive images in Roots Bedrock + Sage + Blade projects. 281.8k](/packages/webkinder-sproutset) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)