pax_global_header 0000666 0000000 0000000 00000000064 14606250725 0014521 g ustar 00root root 0000000 0000000 52 comment=d3f807dea9ce904e20a47a661f2310ce9134dc2a
ejs-3.1.10/ 0000775 0000000 0000000 00000000000 14606250725 0012364 5 ustar 00root root 0000000 0000000 ejs-3.1.10/.eslintignore 0000664 0000000 0000000 00000000041 14606250725 0015062 0 ustar 00root root 0000000 0000000 coverage
out
/ejs.js
/ejs.min.js
ejs-3.1.10/.eslintrc.json 0000664 0000000 0000000 00000001625 14606250725 0015164 0 ustar 00root root 0000000 0000000 {
"env": {
"browser": true,
"commonjs": true,
"node": true
},
"globals": {
"suite": "readonly",
"test": "readonly"
},
"parserOptions": {
"ecmaVersion": 6
},
"extends": "eslint:recommended",
"rules": {
"linebreak-style": [
"error",
"unix"
],
"no-trailing-spaces": 2,
"indent": [
"error",
2
],
"quotes": [
"error",
"single",
{
"avoidEscape": true,
"allowTemplateLiterals": true
}
],
"semi": [
"error",
"always"
],
"comma-style": [
"error",
"last"
],
"one-var": [
"error",
"never"
],
"no-console": 0,
"no-useless-escape": 0
}
}
ejs-3.1.10/.github/ 0000775 0000000 0000000 00000000000 14606250725 0013724 5 ustar 00root root 0000000 0000000 ejs-3.1.10/.github/workflows/ 0000775 0000000 0000000 00000000000 14606250725 0015761 5 ustar 00root root 0000000 0000000 ejs-3.1.10/.github/workflows/create-release.yml 0000664 0000000 0000000 00000001427 14606250725 0021371 0 ustar 00root root 0000000 0000000 name: Create release
on:
push:
tags:
- 'v*'
jobs:
create-release:
name: Create GitHub Release
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Get semver number
id: get_semver
env:
TAG_NAME: ${{ github.ref }}
run: echo "::set-output name=num::${TAG_NAME:11}"
- name: Create release on GitHub API
id: create_release
uses: actions/create-release@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
tag_name: ${{ github.ref }}
release_name: "v${{ steps.get_semver.outputs.num }}"
body: |
Version ${{ steps.get_semver.outputs.num }}
draft: false
prerelease: false
ejs-3.1.10/.gitignore 0000664 0000000 0000000 00000000460 14606250725 0014354 0 ustar 00root root 0000000 0000000 # If you add anything here, consider also adding to .npmignore
v8.log
*.swp
*.swo
auth_info.js
dist
.idea/
tags
nbproject/
spec/browser/autogen_suite.js
node_modules
tmtags
*.DS_Store
examples/*/log/*
site/log/*
.log
npm-debug.log
doc/
test/tmp
coverage/
/ejs.js
/ejs.min.js
out/
pkg/
/package-lock.json
ejs-3.1.10/.npmignore 0000664 0000000 0000000 00000000324 14606250725 0014362 0 ustar 00root root 0000000 0000000 test/
# Copied from .gitignore
v8.log
*.swp
*.swo
auth_info.js
dist
.idea/
tags
nbproject/
spec/browser/autogen_suite.js
tmtags
*.DS_Store
examples/*/log/*
site/log/*
.log
npm-debug.log
doc/
coverage/
out/
pkg/
ejs-3.1.10/.travis.yml 0000664 0000000 0000000 00000000101 14606250725 0014465 0 ustar 00root root 0000000 0000000 language: node_js
sudo: false
node_js:
- "8"
- "10"
- "12"
ejs-3.1.10/CODE_OF_CONDUCT.md 0000664 0000000 0000000 00000004521 14606250725 0015165 0 ustar 00root root 0000000 0000000 # Contributor Code of Conduct
As contributors and maintainers of this project, and in the interest of
fostering an open and welcoming community, we pledge to respect all people who
contribute through reporting issues, posting feature requests, updating
documentation, submitting pull requests or patches, and other activities.
We are committed to making participation in this project a harassment-free
experience for everyone, regardless of level of experience, gender, gender
identity and expression, sexual orientation, disability, personal appearance,
body size, race, ethnicity, age, religion, or nationality.
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery
* Personal attacks
* Trolling or insulting/derogatory comments
* Public or private harassment
* Publishing other's private information, such as physical or electronic
addresses, without explicit permission
* Other unethical or unprofessional conduct
Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
By adopting this Code of Conduct, project maintainers commit themselves to
fairly and consistently applying these principles to every aspect of managing
this project. Project maintainers who do not follow or enforce the Code of
Conduct may be permanently removed from the project team.
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community.
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting a project maintainer at mde@fleegix.org. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. Maintainers are
obligated to maintain confidentiality with regard to the reporter of an
incident.
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 1.3.0, available at
[http://contributor-covenant.org/version/1/3/0/][version]
[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/3/0/
ejs-3.1.10/LICENSE 0000664 0000000 0000000 00000026136 14606250725 0013401 0 ustar 00root root 0000000 0000000
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
ejs-3.1.10/README.md 0000664 0000000 0000000 00000032036 14606250725 0013647 0 ustar 00root root 0000000 0000000 Embedded JavaScript templates
[](https://snyk.io/test/npm/ejs)
=============================
## Security
Security professionals, before reporting any security issues, please reference the
SECURITY.md
in this project, in particular, the following: "EJS is effectively a JavaScript runtime.
Its entire job is to execute JavaScript. If you run the EJS render method without
checking the inputs yourself, you are responsible for the results."
In short, DO NOT submit 'vulnerabilities' that include this snippet of code:
```javascript
app.get('/', (req, res) => {
res.render('index', req.query);
});
```
## Installation
```bash
$ npm install ejs
```
## Features
* Control flow with `<% %>`
* Escaped output with `<%= %>` (escape function configurable)
* Unescaped raw output with `<%- %>`
* Newline-trim mode ('newline slurping') with `-%>` ending tag
* Whitespace-trim mode (slurp all whitespace) for control flow with `<%_ _%>`
* Custom delimiters (e.g. `[? ?]` instead of `<% %>`)
* Includes
* Client-side support
* Static caching of intermediate JavaScript
* Static caching of templates
* Complies with the [Express](http://expressjs.com) view system
## Example
```ejs
<% if (user) { %>
[?= users.join(" | "); ?]
', {users: users}, {delimiter: '?', openDelimiter: '[', closeDelimiter: ']'}); // => 'geddy | neil | alex
' // Or globally ejs.delimiter = '?'; ejs.openDelimiter = '['; ejs.closeDelimiter = ']'; ejs.render('[?= users.join(" | "); ?]
', {users: users}); // => 'geddy | neil | alex
' ``` ### Caching EJS ships with a basic in-process cache for caching the intermediate JavaScript functions used to render templates. It's easy to plug in LRU caching using Node's `lru-cache` library: ```javascript let ejs = require('ejs'), LRU = require('lru-cache'); ejs.cache = LRU(100); // LRU cache with 100-item limit ``` If you want to clear the EJS cache, call `ejs.clearCache`. If you're using the LRU cache and need a different limit, simple reset `ejs.cache` to a new instance of the LRU. ### Custom file loader The default file loader is `fs.readFileSync`, if you want to customize it, you can set ejs.fileLoader. ```javascript let ejs = require('ejs'); let myFileLoad = function (filePath) { return 'myFileLoad: ' + fs.readFileSync(filePath); }; ejs.fileLoader = myFileLoad; ``` With this feature, you can preprocess the template before reading it. ### Layouts EJS does not specifically support blocks, but layouts can be implemented by including headers and footers, like so: ```ejs <%- include('header') -%>My page
<%- include('footer') -%> ``` ## Client-side support Go to the [Latest Release](https://github.com/mde/ejs/releases/latest), download `./ejs.js` or `./ejs.min.js`. Alternately, you can compile it yourself by cloning the repository and running `jake build` (or `$(npm bin)/jake build` if jake is not installed globally). Include one of these files on your page, and `ejs` should be available globally. ### Example ```html ``` ### Caveats Most of EJS will work as expected; however, there are a few things to note: 1. Obviously, since you do not have access to the filesystem, `ejs.renderFile()` won't work. 2. For the same reason, `include`s do not work unless you use an `include callback`. Here is an example: ```javascript 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 ``` See the [examples folder](https://github.com/mde/ejs/tree/master/examples) for more details. ## CLI EJS ships with a full-featured CLI. Options are similar to those used in JavaScript code: - `-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. Here are some examples of usage: ```shell $ 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 ``` ### Data input There is a variety of ways to pass the CLI data for rendering. Stdin: ```shell $ ./test/fixtures/user_data.json | ejs ./test/fixtures/user.ejs $ ejs ./test/fixtures/user.ejs < test/fixtures/user_data.json ``` A data file: ```shell $ ejs ./test/fixtures/user.ejs -f ./user_data.json ``` A command-line option (must be URI-encoded): ```shell ./bin/cli.js -i %7B%22name%22%3A%20%22foo%22%7D ./test/fixtures/user.ejs ``` Or, passing values directly at the end of the invocation: ```shell ./bin/cli.js -m $ ./test/fixtures/user.ejs name=foo ``` ### Output The CLI by default send output to stdout, but you can use the `-o` or `--output-file` flag to specify a target file to send the output to. ## IDE Integration with Syntax Highlighting VSCode:Javascript EJS by *DigitalBrainstem* ## Related projects There are a number of implementations of EJS: * TJ's implementation, the v1 of this library: https://github.com/tj/ejs * EJS Embedded JavaScript Framework on Google Code: https://code.google.com/p/embeddedjavascript/ * Sam Stephenson's Ruby implementation: https://rubygems.org/gems/ejs * Erubis, an ERB implementation which also runs JavaScript: http://www.kuwata-lab.com/erubis/users-guide.04.html#lang-javascript * DigitalBrainstem EJS Language support: https://github.com/Digitalbrainstem/ejs-grammar ## License Licensed under the Apache License, Version 2.0 (<starting content closing>The spaces between *starting* and *content*, and *content* and *closing* are not required; they are recommended though for readability. Delimiters ---------- The *starting* and *closing* tags contain a special string called the delimiter. In this document, all tags are shown using the `%` delimiter, which is the default. You can, however, change that to your liking. See https://github.com/mde/ejs#custom-delimiters for more information on how to change it. Starting tags ------------- ### `<%=`: Escaped output The most important thing for a template language is the ability to pass variables to the template. In EJS, this is done with the `<%=` and `<%-` tags. `<%=` is the starting tag to use for variables that need to be escaped. If the specified string contains forbidden characters like `<` and `&`, they are escaped automatically with HTML codes. The content of the tag can be any valid JavaScript operators, so tags like `<%= name ? name : (lastName || 'John Doe') %>` would work as intended. #### Example ##### EJS ```ejs
Hello, <%= name %>.
Hello, <%= 'the Most Honorable ' + name %>.
``` ##### Locals ```json { "name": "TimothHello, Timoth<y>.
Hello, the Most Honorable Timoth<y>.
``` ### `<%-`: Unescaped output If your local contains preformatted HTML, you might not want to escape it. In this case, use the `<%-` tag. However, always **be 100% sure** the rendered local is sanitized, to prevent cross-site scripting (XSS) attacks. #### Example ##### EJS ```ejsHello, <%- myHtml %>.
Hello, <%= myHtml %>.
Hello, <%- myMaliciousHtml %>.
Hello, <%= myMaliciousHtml %>.
``` ##### Locals ```json { "myHtml": "Timothy" , "myMaliciousHtml": "" } ``` ##### HTML ```html
Hello, Timothy.
Hello, <strong>Timothy</strong>.
Hello,
.
Hello, </p><script>document.write()</script><p>.
``` ### `<%#`: Comments The `<%#` starting tag denotes that the statement is a comment that is not to be executed or rendered in the resulting HTML. #### Whitespace The use of `<%#` might cause some useless whitespace, as illustrated by the example below. You can trim it using the `-%>` ending tag. #### Example ##### EJS ```ejsYay it's true!
<%# Good practice %> <% if (true) { %>Yay it's true!
<% } %> ``` ```ejs <%# These are all valid statements %> <% var output , exclamation = '' , shouldOutput = false if (true) output = 'true!' if (true) { exclamation = 'Yay! '; } if (true) shouldOutput = true; %> <% if (shouldOutput) { %> <%= exclamation + 'It\'s ' + output %> <% } %> ``` #### Line breaks inside a tag Line breaks are allowed in `<%` tags. Unless the statement involves mixing EJS and JavaScript scriptlet, always put complete statements in a tag. For example, the following works: ```ejs <% var stringToShow = thisIsABooleanVariableWithAVeryLongName ? 'OK' : 'not OK' %> ``` While the following does not: ```ejs <% var stringToShow = thisIsABooleanVariableWithAVeryLongName %> <% ? 'OK' %> <% : 'not OK' %> ``` #### Semicolons As is in JavaScript, semicolons are not required if proper line breaks are preserved. #### Whitespace The use of scriptlets might cause some useless whitespace, as illustrated by the example below. You can trim it by 1. using the `-%>` ending tag, and 2. using the `<%_` starting tag or starting the tag in the beginning of a line. #### Example In the following example, several different coding styles are used simultaneously, to show that EJS is flexible with regards to personal habits. It does *not* mean that we recommend mixing coding styles in your own project. ##### EJS ```ejs`, where it is not necessary to escape `<` or `>` at all. ##### EJS ```ejsThis is literal: <%%This is literal too: <%% %>This is literal as well: %%>``` ##### HTML ```htmlThis is literal: <%This is literal too: <% %>This is literal as well: %>``` ## Including other files EJS offer two ways of including other files. You can even include files that are not EJS templates, as the case is for CSS stylesheets. For both flavors, if the file specified does not have an extension, `.ejs` is automatically appended. If it is an absolute path, that file is included. Otherwise, the file is assumed to be in the same directory as the parent template. The behavior of resolving included file path can be overridden using the `ejs.resolveInclude` function. #### Whitespace control You most probably should not use the `-%>` ending tag on an `include` directive, as it trims the whitespace after the included file. #### Example ##### included.ejs ```ejs