+
# Pug
Full documentation is at [pugjs.org](https://pugjs.org/)
- Pug is a high-performance template engine heavily influenced by [Haml](http://haml.info/)
- and implemented with JavaScript for [Node.js](http://nodejs.org) and browsers. For bug reports,
- feature requests and questions, [open an issue](https://github.com/pugjs/pug/issues/new).
- For discussion join the [chat room](https://gitter.im/pugjs/pug).
-
- You can test drive Pug online [here](https://pugjs.org/).
-
- [Professionally supported pug is now available](https://tidelift.com/subscription/pkg/npm-pug?utm_source=npm-pug&utm_medium=referral&utm_campaign=readme)
-
- [](https://travis-ci.org/pugjs/pug)
- [](https://coveralls.io/r/pugjs/pug?branch=master)
- [](https://www.npmjs.com/package/pug)
- [](https://gitter.im/pugjs/pug?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-[](#backers)
-[](#sponsors)
-
-### Dependency Status
-
-| Package | Dependencies | Dev Dependencies |
-| ------------- |:-------------| :-----|
-| mono-repo top | [](https://david-dm.org/pugjs/pug) | [](https://david-dm.org/pugjs/pug?type=dev) |
-| pug | [](https://david-dm.org/pugjs/pug?path=packages/pug) | [](https://david-dm.org/pugjs/pug?path=packages/pug&type=dev) |
-| pug-attrs | [](https://david-dm.org/pugjs/pug?path=packages/pug-attrs) | [](https://david-dm.org/pugjs/pug?path=packages/pug-attrs&type=dev) |
-| pug-code-gen | [](https://david-dm.org/pugjs/pug?path=packages/pug-code-gen) | [](https://david-dm.org/pugjs/pug?path=packages/pug-code-gen&type=dev) |
-| pug-error | [](https://david-dm.org/pugjs/pug?path=packages/pug-error) | [](https://david-dm.org/pugjs/pug?path=packages/pug-error&type=dev) |
-| pug-filters | [](https://david-dm.org/pugjs/pug?path=packages/pug-filters) | [](https://david-dm.org/pugjs/pug?path=packages/pug-filters&type=dev) |
-| pug-lexer | [](https://david-dm.org/pugjs/pug?path=packages/pug-lexer) | [](https://david-dm.org/pugjs/pug?path=packages/pug-lexer&type=dev) |
-| pug-linker | [](https://david-dm.org/pugjs/pug?path=packages/pug-linker) | [](https://david-dm.org/pugjs/pug?path=packages/pug-linker&type=dev) |
-| pug-load | [](https://david-dm.org/pugjs/pug?path=packages/pug-load) | [](https://david-dm.org/pugjs/pug?path=packages/pug-load&type=dev) |
-| pug-parser | [](https://david-dm.org/pugjs/pug?path=packages/pug-parser) | [](https://david-dm.org/pugjs/pug?path=packages/pug-parser&type=dev) |
-| pug-runtime | [](https://david-dm.org/pugjs/pug?path=packages/pug-runtime) | [](https://david-dm.org/pugjs/pug?path=packages/pug-runtime&type=dev) |
-| pug-strip-comments | [](https://david-dm.org/pugjs/pug?path=packages/pug-strip-comments) | [](https://david-dm.org/pugjs/pug?path=packages/pug-strip-comments&type=dev) |
-| pug-error | [](https://david-dm.org/pugjs/pug?path=packages/pug-walk) | [](https://david-dm.org/pugjs/pug?path=packages/pug-walk&type=dev) |
+Pug is a high-performance template engine heavily influenced by [Haml](http://haml.info/)
+and implemented with JavaScript for [Node.js](http://nodejs.org) and browsers. For bug reports,
+feature requests and questions, [open an issue](https://github.com/pugjs/pug/issues/new).
+For discussion join the [chat room](https://gitter.im/pugjs/pug).
+
+You can test drive Pug online [here](https://pugjs.org/).
+
+[Professionally supported pug is now available](https://tidelift.com/subscription/pkg/npm-pug?utm_source=npm-pug&utm_medium=referral&utm_campaign=readme)
+
+[](https://github.com/pugjs/pug/actions?query=workflow%3ATest+branch%3Amaster)
+[](https://rollingversions.com/pugjs/pug)
+[](https://www.npmjs.com/package/pug)
+[](https://gitter.im/pugjs/pug?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+## Packages
+
+
+Package Name | Version
+-------------|--------
+pug | [](https://www.npmjs.com/package/pug)
+pug-attrs | [](https://www.npmjs.com/package/pug-attrs)
+pug-code-gen | [](https://www.npmjs.com/package/pug-code-gen)
+pug-error | [](https://www.npmjs.com/package/pug-error)
+pug-filters | [](https://www.npmjs.com/package/pug-filters)
+pug-lexer | [](https://www.npmjs.com/package/pug-lexer)
+pug-linker | [](https://www.npmjs.com/package/pug-linker)
+pug-load | [](https://www.npmjs.com/package/pug-load)
+pug-parser | [](https://www.npmjs.com/package/pug-parser)
+pug-runtime | [](https://www.npmjs.com/package/pug-runtime)
+pug-strip-comments | [](https://www.npmjs.com/package/pug-strip-comments)
+pug-walk | [](https://www.npmjs.com/package/pug-walk)
+
## Rename from "Jade"
@@ -43,7 +43,7 @@ This project was formerly known as "Jade". However, it was revealed to us that "
If your package or app currently uses `jade`, don't worry: we have secured permissions to continue to occupy that package name, although all new versions will be released under `pug`.
-Before the renaming, work had already begun on “Jade 2.0.0”. Therefore, the rename to Pug coincided with the major version bump. As a result, upgrading from Jade to Pug will be the same process as upgrading any other package with a major version bump.
+Before the renaming, work had already begun on “Jade 2.0.0”. Therefore, the rename to Pug coincided with the major version bump. As a result, upgrading from Jade to Pug will be the same process as upgrading any other package with a major version bump.
The syntax of Pug has several differences, deprecations, and removals compared to its predecessor. These differences are documented in [#2305](https://github.com/pugjs/pug/issues/2305).
@@ -59,7 +59,6 @@ To use Pug in your own JavaScript projects:
$ npm install pug
```
-
### Command Line
After installing the latest version of [Node.js](http://nodejs.org), install with:
@@ -76,7 +75,7 @@ $ pug --help
## Syntax
-Pug is a clean, whitespace sensitive syntax for writing HTML. Here is a simple example:
+Pug is a clean, whitespace sensitive syntax for writing HTML. Here is a simple example:
```pug
doctype html
@@ -84,7 +83,7 @@ html(lang="en")
head
title= pageTitle
script(type='text/javascript').
- if (foo) bar(1 + 5)
+ if (foo) bar(1 + 5);
body
h1 Pug - node template engine
#container.col
@@ -99,21 +98,23 @@ html(lang="en")
Pug transforms the above to:
-
```html
You are amazing
-Pug is a terse and simple templating language with a strong focus on performance and powerful features.
++ Pug is a terse and simple templating language with a strong focus on + performance and powerful features. +
@@ -247,7 +249,8 @@ Support us with a monthly donation and help us continue our activities. [[Become
## Sponsors
-Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/pug#sponsor)]
+
+Become a sponsor and get your logo on our README on GitHub with a link to your site. [[Become a sponsor](https://opencollective.com/pug#sponsor)]
diff --git a/SECURITY.md b/SECURITY.md
new file mode 100644
index 000000000..9d0bc3b9f
--- /dev/null
+++ b/SECURITY.md
@@ -0,0 +1,14 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported |
+| -------- | ------------------ |
+| ^3.0.1 | :white_check_mark: |
+| <3.0.1 | :x: |
+
+## Reporting a Vulnerability
+
+To report a security vulnerability, please use the
+[Tidelift security contact](https://tidelift.com/security).
+Tidelift will coordinate the fix and disclosure.
diff --git a/lerna.json b/lerna.json
deleted file mode 100644
index 3059f1f32..000000000
--- a/lerna.json
+++ /dev/null
@@ -1,8 +0,0 @@
-{
- "lerna": "3.10.8",
- "packages": ["packages/*"],
- "npmClient": "yarn",
- "useWorkspaces": true,
- "version": "independent",
- "registry": "https://registry.npmjs.org/"
-}
\ No newline at end of file
diff --git a/package.json b/package.json
index 4b0777a91..06c9476ab 100644
--- a/package.json
+++ b/package.json
@@ -1,21 +1,26 @@
{
"name": "pug-monorepo",
"private": true,
+ "@rollingversions/ignore": true,
+ "workspaces": [
+ "packages/*"
+ ],
"devDependencies": {
- "coveralls": "3.0.2",
- "jest": "24.0.0",
- "lerna": "3.10.8",
- "prettier": "^1.3.1"
+ "coveralls": "3.0.9",
+ "jest": "^26.0.1",
+ "prettier": "1.19.1",
+ "typescript": "^4.1.2",
+ "wsrun": "^5.2.0"
},
"repository": {
"type": "git",
"url": "https://github.com/pugjs/pug.git"
},
"scripts": {
- "bootstrap": "lerna bootstrap",
- "clean": "lerna clean",
- "release": "lerna publish",
- "pretest": "lerna run pretest",
+ "prettier:check": "prettier --ignore-path .gitignore --list-different './**/*.js'",
+ "format": "prettier --ignore-path .gitignore --write './**/*.js'",
+ "build": "node scripts/prebuild && wsrun --stages --exclude-missing --fast-exit --collect-logs build && tsc --build scripts",
+ "pretest": "yarn build",
"test": "jest",
"coverage": "jest --coverage",
"coveralls": "jest --coverage --coverageReporters=text-lcov | coveralls",
@@ -25,11 +30,9 @@
"testEnvironment": "node",
"snapshotSerializers": [
"./scripts/filename-serializer.js",
- "./scripts/prettier-javascript-serializer.js"
+ "./scripts/prettier-javascript-serializer.js",
+ "./scripts/buffer-serializer.js"
]
},
- "license": "MIT",
- "workspaces": [
- "packages/*"
- ]
+ "license": "MIT"
}
diff --git a/packages/pug-attrs/index.js b/packages/pug-attrs/index.js
index 50d732144..9850ac390 100644
--- a/packages/pug-attrs/index.js
+++ b/packages/pug-attrs/index.js
@@ -6,10 +6,10 @@ var runtime = require('pug-runtime');
var stringify = require('js-stringify');
function isConstant(src) {
- return constantinople(src, {pug: runtime, 'pug_interp': undefined});
+ return constantinople(src, {pug: runtime, pug_interp: undefined});
}
function toConstant(src) {
- return constantinople.toConstant(src, {pug: runtime, 'pug_interp': undefined});
+ return constantinople.toConstant(src, {pug: runtime, pug_interp: undefined});
}
module.exports = compileAttrs;
@@ -21,15 +21,23 @@ module.exports = compileAttrs;
*/
function compileAttrs(attrs, options) {
assert(Array.isArray(attrs), 'Attrs should be an array');
- assert(attrs.every(function (attr) {
- return attr &&
- typeof attr === 'object' &&
- typeof attr.name === 'string' &&
- (typeof attr.val === 'string' || typeof attr.val === 'boolean') &&
- typeof attr.mustEscape === 'boolean';
- }), 'All attributes should be supplied as an object of the form {name, val, mustEscape}');
+ assert(
+ attrs.every(function(attr) {
+ return (
+ attr &&
+ typeof attr === 'object' &&
+ typeof attr.name === 'string' &&
+ (typeof attr.val === 'string' || typeof attr.val === 'boolean') &&
+ typeof attr.mustEscape === 'boolean'
+ );
+ }),
+ 'All attributes should be supplied as an object of the form {name, val, mustEscape}'
+ );
assert(options && typeof options === 'object', 'Options should be an object');
- assert(typeof options.terse === 'boolean', 'Options.terse should be a boolean');
+ assert(
+ typeof options.terse === 'boolean',
+ 'Options.terse should be a boolean'
+ );
assert(
typeof options.runtime === 'function',
'Options.runtime should be a function that takes a runtime function name and returns the source code that will evaluate to that function at runtime'
@@ -46,7 +54,9 @@ function compileAttrs(attrs, options) {
function addAttribute(key, val, mustEscape, buf) {
if (isConstant(val)) {
if (options.format === 'html') {
- var str = stringify(runtime.attr(key, toConstant(val), mustEscape, options.terse));
+ var str = stringify(
+ runtime.attr(key, toConstant(val), mustEscape, options.terse)
+ );
var last = buf[buf.length - 1];
if (last && last[last.length - 1] === str[0]) {
buf[buf.length - 1] = last.substr(0, last.length - 1) + str.substr(1);
@@ -62,7 +72,18 @@ function compileAttrs(attrs, options) {
}
} else {
if (options.format === 'html') {
- buf.push(options.runtime('attr') + '("' + key + '", ' + val + ', ' + stringify(mustEscape) + ', ' + stringify(options.terse) + ')');
+ buf.push(
+ options.runtime('attr') +
+ '("' +
+ key +
+ '", ' +
+ val +
+ ', ' +
+ stringify(mustEscape) +
+ ', ' +
+ stringify(options.terse) +
+ ')'
+ );
} else {
if (mustEscape) {
val = options.runtime('escape') + '(' + val + ')';
@@ -72,7 +93,7 @@ function compileAttrs(attrs, options) {
}
}
- attrs.forEach(function(attr){
+ attrs.forEach(function(attr) {
var key = attr.name;
var val = attr.val;
var mustEscape = attr.mustEscape;
@@ -101,16 +122,23 @@ function compileAttrs(attrs, options) {
classesBuf
);
} else {
- classes = classes.map(function (cls, i) {
+ classes = classes.map(function(cls, i) {
if (isConstant(cls)) {
- cls = stringify(classEscaping[i] ? runtime.escape(toConstant(cls)) : toConstant(cls));
+ cls = stringify(
+ classEscaping[i] ? runtime.escape(toConstant(cls)) : toConstant(cls)
+ );
classEscaping[i] = false;
}
return cls;
});
addAttribute(
'class',
- options.runtime('classes') + '([' + classes.join(',') + '], ' + stringify(classEscaping) + ')',
+ options.runtime('classes') +
+ '([' +
+ classes.join(',') +
+ '], ' +
+ stringify(classEscaping) +
+ ')',
false,
classesBuf
);
diff --git a/packages/pug-attrs/package.json b/packages/pug-attrs/package.json
index e4b465dd8..615713f63 100644
--- a/packages/pug-attrs/package.json
+++ b/packages/pug-attrs/package.json
@@ -6,8 +6,8 @@
"pug"
],
"dependencies": {
- "constantinople": "^3.0.1",
- "js-stringify": "^1.0.1",
+ "constantinople": "^4.0.1",
+ "js-stringify": "^1.0.2",
"pug-runtime": "^2.0.5"
},
"files": [
diff --git a/packages/pug-attrs/test/index.test.js b/packages/pug-attrs/test/index.test.js
index 1fb0d56d1..7bb8854ae 100644
--- a/packages/pug-attrs/test/index.test.js
+++ b/packages/pug-attrs/test/index.test.js
@@ -9,88 +9,293 @@ function test(input, expected, locals) {
var opts = options;
locals = locals || {};
locals.pug = locals.pug || require('pug-runtime');
- it(utils.inspect(input).replace(/\n/g, '') + ' => ' + utils.inspect(expected), function () {
- var src = attrs(input, opts);
- var localKeys = Object.keys(locals).sort();
- var output = Function(localKeys.join(', '), 'return (' + src + ');').apply(null, localKeys.map(function (key) { return locals[key]; }));
- if (opts.format === 'html') {
- expect(output).toBe(expected);
- } else {
- expect(output).toEqual(expected);
+ it(
+ utils.inspect(input).replace(/\n/g, '') + ' => ' + utils.inspect(expected),
+ function() {
+ var src = attrs(input, opts);
+ var localKeys = Object.keys(locals).sort();
+ var output = Function(
+ localKeys.join(', '),
+ 'return (' + src + ');'
+ ).apply(
+ null,
+ localKeys.map(function(key) {
+ return locals[key];
+ })
+ );
+ if (opts.format === 'html') {
+ expect(output).toBe(expected);
+ } else {
+ expect(output).toEqual(expected);
+ }
}
- });
+ );
}
function withOptions(opts, fn) {
- describe('options: ' + utils.inspect(opts), function () {
+ describe('options: ' + utils.inspect(opts), function() {
options = opts;
fn();
});
}
-withOptions({terse: true, format: 'html', runtime: function (name) { return 'pug.' + name; }}, function () {
- test([], '');
- test([{name: 'foo', val: 'false', mustEscape: true}], '');
- test([{name: 'foo', val: 'true', mustEscape: true}], ' foo');
- test([{name: 'foo', val: false, mustEscape: true}], '');
- test([{name: 'foo', val: true, mustEscape: true}], ' foo');
- test([{name: 'foo', val: 'foo', mustEscape: true}], '', {foo: false});
- test([{name: 'foo', val: 'foo', mustEscape: true}], ' foo', {foo: true});
- test([{name: 'foo', val: '"foo"', mustEscape: true}], ' foo="foo"');
- test([{name: 'foo', val: '"foo"', mustEscape: true}, {name: 'bar', val: '"bar"', mustEscape: true}], ' foo="foo" bar="bar"');
- test([{name: 'foo', val: 'foo', mustEscape: true}], ' foo="fooo"', {foo: 'fooo'});
- test([{name: 'foo', val: 'foo', mustEscape: true}, {name: 'bar', val: 'bar', mustEscape: true}], ' foo="fooo" bar="baro"', {foo: 'fooo', bar: 'baro'});
- test([{name: 'style', val: '{color: "red"}', mustEscape: true}], ' style="color:red;"');
- test([{name: 'style', val: '{color: color}', mustEscape: true}], ' style="color:red;"', {color: 'red'});
- test([{name: 'class', val: '"foo"', mustEscape: true}, {name: 'class', val: '["bar", "baz"]', mustEscape: true}], ' class="foo bar baz"');
- test([{name: 'class', val: '{foo: foo}', mustEscape: true}, {name: 'class', val: '["bar", "baz"]', mustEscape: true}], ' class="foo bar baz"', {foo: true});
- test([{name: 'class', val: '{foo: foo}', mustEscape: true}, {name: 'class', val: '["bar", "baz"]', mustEscape: true}], ' class="bar baz"', {foo: false});
- test([{name: 'class', val: 'foo', mustEscape: true}, {name: 'class', val: '"bar
' - ].join(''); + var html = ['', 'bar
'].join(''); assert.equal(html, pug.render(str)); // Between tags - var str = [ - 'p foo', - '// bar ', - 'p baz' - ].join('\n'); + var str = ['p foo', '// bar ', 'p baz'].join('\n'); - var html = [ - 'foo
', - '', - 'baz
' - ].join(''); + var html = ['foo
', '', 'baz
'].join(''); assert.equal(html, pug.render(str)); // Quotes var str = "", - js = "// script(src: '/js/validate.js') "; + js = "// script(src: '/js/validate.js') "; assert.equal(str, pug.render(js)); }); - it('should support unbuffered comments', function(){ - var str = [ - '//- foo', - 'p bar' - ].join('\n'); + it('should support unbuffered comments', function() { + var str = ['//- foo', 'p bar'].join('\n'); - var html = [ - 'bar
' - ].join(''); + var html = ['bar
'].join(''); assert.equal(html, pug.render(str)); - var str = [ - 'p foo', - '//- bar ', - 'p baz' - ].join('\n'); + var str = ['p foo', '//- bar ', 'p baz'].join('\n'); - var html = [ - 'foo
', - 'baz
' - ].join(''); + var html = ['foo
', 'baz
'].join(''); assert.equal(html, pug.render(str)); }); - it('should support literal html', function(){ - assert.equal('', pug.render('')); + it('should support literal html', function() { + assert.equal( + '', + pug.render('') + ); }); - it('should support code', function(){ + it('should support code', function() { assert.equal('test', pug.render('!= "test"')); assert.equal('test', pug.render('= "test"')); assert.equal('test', pug.render('- var foo = "test"\n=foo')); - assert.equal('footestbar', pug.render('- var foo = "test"\n| foo\nem= foo\n| bar')); - assert.equal('test