From b1848d6125a6a0ea7d0ca91c7f52a76d54dd29e7 Mon Sep 17 00:00:00 2001 From: Alin Gavriliuc Date: Fri, 7 Apr 2023 17:55:42 +0200 Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20=20EJS=20cheatsheet?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- source/_posts/ejs.md | 232 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 232 insertions(+) create mode 100644 source/_posts/ejs.md diff --git a/source/_posts/ejs.md b/source/_posts/ejs.md new file mode 100644 index 0000000..2a0803f --- /dev/null +++ b/source/_posts/ejs.md @@ -0,0 +1,232 @@ +--- +title: EJS +date: 2023-04-07 +background: bg-[#b4ca65] +tags: + - EJS + - Frontend + - Framework +categories: + - Programming +intro: What is the "E" for? "Embedded?" Could be. How about "Effective," "Elegant," or just "Easy"? EJS is a simple templating language that lets you generate HTML markup with plain JavaScript. No religiousness about how to organize things. No reinvention of iteration and control-flow. It's just plain JavaScript. +plugins: + - copyCode +--- + +## Get Started { .cols-2 } + +### Install + +``` +npm install ejs +``` + +### Use + +Pass EJS a template string and some data. BOOM, you've got some HTML. +``` +let ejs = require('ejs'); +let people = ['geddy', 'neil', 'alex']; +let html = ejs.render('<%= people.join(", "); %>', {people: people}); +``` + +### CLI + +Feed it a template file and a data file, and specify an output file. +``` +ejs ./template_file.ejs -f data_file.json -o ./output.html +``` + +### Browser Support + +Download a browser build from the latest release, and use it in a script tag. +``` + + +``` + +## Docs + +### Example + +``` +<% if (user) { %> +

<%= user.name %>

+<% } %> +``` + +### Usage + +``` +let template = ejs.compile(str, options); +template(data); +// => Rendered HTML string + +ejs.render(str, data, options); +// => Rendered HTML string + +ejs.renderFile(filename, data, options, function(err, str){ + // str => Rendered HTML string +}); +``` + +### Includes + +``` + +``` + +### Custom delimiters + +``` +let ejs = require('ejs'), + users = ['geddy', 'neil', 'alex']; + +// Just one template +ejs.render('', {users: users}, + {delimiter: '?'}); +// => 'geddy | neil | alex' + +// Or globally +ejs.delimiter = '$'; +ejs.render('<$= users.join(" | "); $>', {users: users}); +// => 'geddy | neil | alex' +``` + +### Caching + +``` +let ejs = require('ejs'), +LRU = require('lru-cache'); +ejs.cache = LRU(100); // LRU cache with 100-item limit +``` + +### Custom file loader + +``` +let ejs = require('ejs'); +let myFileLoader = function (filePath) { + return 'myFileLoader: ' + fs.readFileSync(filePath); +}; + +ejs.fileLoader = myFileLoader; +``` + +### Layouts + +``` +<%- include('header'); -%> +

+ Title +

+

+ My page +

+<%- include('footer'); -%> +``` + +## Client-side support { .cols-1 } + +### Example + +``` +
+ + +``` + +### Caveats + +``` +let str = "Hello <%= include('file', {person: 'John'}); %>", + fn = ejs.compile(str, {client: true}); + +fn(data, null, function(path, d){ // include callback + // path -> 'file' + // d -> {person: 'John'} + // Put your code here + // Return the contents of file as a string +}); // returns rendered string +``` + + +## Options { .cols-1 } + +### Options list +| Option | Description | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| cache | Compiled functions are cached, requires filename | +| filename | Used by cache to key caches, and for includes | +| root | Set project root for includes with an absolute path (e.g., /file.ejs). Can be an array to try to resolve include from multiple directories. | +| views | An array of paths to use when resolving includes with relative paths. | +| context | Function execution context | +| compileDebug | When false, no debug instrumentation is compiled | +| client | Returns standalone compiled function | +| delimiter | Character to use for inner delimiter, by default '%' | +| openDelimiter | Character to use for opening delimiter, by default '<' | +| closeDelimiter | Character to use for closing delimiter, by default '>' | +| debug | Outputs generated function body | +| strict | When set to `true`, generated function is in strict mode | +| _with | Whether or not to use with() {} constructs. If false, then the locals will be stored in the locals object. (Implies `--strict`) | +| localsName | Name to use for the object storing local variables when not using with Defaults to locals | +| rmWhitespace | Remove all safe-to-remove whitespace, including leading and trailing whitespace. It also enables a safer version of -%> line slurping for all scriptlet tags (it does not strip new lines of tags in the middle of a line). | +| escape | The escaping function used with <%= construct. It is used in rendering and is .toString()ed in the generation of client functions. (By default escapes XML). | +| outputFunctionName| Set to a string (e.g., 'echo' or 'print') for a function to print output inside scriptlet tags. | +| async | When true, EJS will use an async function for rendering. (Depends on async/await support in the JS runtime. | + +## Tags { .cols-1 } + +### Tags list +| Tag | Description | +|------|----------------------------------------------------------------------| +| <% | 'Scriptlet' tag, for control-flow, no output | +| <%_ | 'Whitespace Slurping' Scriptlet tag, strips all whitespace before it | +| <%= | Outputs the value into the template (HTML escaped) | +| <%- | Outputs the unescaped value into the template | +| <%# | Comment tag, no execution, no output | +| <%% | Outputs a literal '<%' | +| %> | Plain ending tag | +| -%> | Trim-mode ('newline slurp') tag, trims following newline | +| _%> | 'Whitespace Slurping' ending tag, removes all whitespace after it | + +## Cli { .cols-1 } + +### Cli list +| Option | Description | +|----------------|-------------------------------------------------------------------------------------------------------------------------| +| cache | Compiled functions are cached, requires filename | +| -o / --output-file FILE | Write the rendered output to FILE rather than stdout. | +| -f / --data-file FILE | Must be JSON-formatted. Use parsed input from FILE as data for rendering. | +| -i / --data-input STRING | Must be JSON-formatted and URI-encoded. Use parsed input from STRING as data for rendering. | +| -m / --delimiter CHARACTER | Use CHARACTER with angle brackets for open/close (defaults to %). | +| -p / --open-delimiter CHARACTER | Use CHARACTER instead of left angle bracket to open. | +| -c / --close-delimiter CHARACTER| Use CHARACTER instead of right angle bracket to close. | +| -s / --strict | When set to `true`, generated function is in strict mode | +| -n / --no-with | Use 'locals' object for vars rather than using `with` (implies --strict). | +| -l / --locals-name | Name to use for the object storing local variables when not using `with`. | +| -w / --rm-whitespace | Remove all safe-to-remove whitespace, including leading and trailing whitespace. | +| -d / --debug | Outputs generated function body | +| -h / --help | Display this help message. | +| -V/v / --version | Display the EJS version. | + + +Examples of use : +``` +$ ejs -p [ -c ] ./template_file.ejs -o ./output.html +$ ejs ./test/fixtures/user.ejs name=Lerxst +$ ejs -n -l _ ./some_template.ejs -f ./data_file.json +``` \ No newline at end of file