+
# Pug
Full documentation is at [pugjs.org](https://pugjs.org/)
@@ -9,7 +10,7 @@ feature requests and questions, [open an issue](https://github.com/pugjs/pug/iss
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)
@@ -17,23 +18,24 @@ You can test drive Pug online [here](https://pugjs.org/).
[](https://www.npmjs.com/package/pug)
[](https://gitter.im/pugjs/pug?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-### 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-walk | [](https://david-dm.org/pugjs/pug?path=packages/pug-walk) | [](https://david-dm.org/pugjs/pug?path=packages/pug-walk&type=dev) |
+## 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"
@@ -41,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).
@@ -57,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:
@@ -74,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
@@ -82,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
@@ -97,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. +
@@ -246,6 +249,7 @@ 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)]
diff --git a/package.json b/package.json
index ba40c0720..06c9476ab 100644
--- a/package.json
+++ b/package.json
@@ -8,7 +8,9 @@
"devDependencies": {
"coveralls": "3.0.9",
"jest": "^26.0.1",
- "prettier": "1.19.1"
+ "prettier": "1.19.1",
+ "typescript": "^4.1.2",
+ "wsrun": "^5.2.0"
},
"repository": {
"type": "git",
@@ -17,7 +19,7 @@
"scripts": {
"prettier:check": "prettier --ignore-path .gitignore --list-different './**/*.js'",
"format": "prettier --ignore-path .gitignore --write './**/*.js'",
- "build": "wsrun --stages --exclude-missing --fast-exit --collect-logs build",
+ "build": "node scripts/prebuild && wsrun --stages --exclude-missing --fast-exit --collect-logs build && tsc --build scripts",
"pretest": "yarn build",
"test": "jest",
"coverage": "jest --coverage",
@@ -32,8 +34,5 @@
"./scripts/buffer-serializer.js"
]
},
- "license": "MIT",
- "dependencies": {
- "wsrun": "^5.2.0"
- }
+ "license": "MIT"
}
diff --git a/packages/pug-error/package.json b/packages/pug-error/package.json
index 2cf393930..f0864d379 100644
--- a/packages/pug-error/package.json
+++ b/packages/pug-error/package.json
@@ -2,11 +2,13 @@
"name": "pug-error",
"version": "1.3.3",
"description": "Standard error objects for pug",
+ "main": "./lib/index.js",
+ "types": "./lib/index.d.ts",
"keywords": [
"pug"
],
"files": [
- "index.js"
+ "lib/"
],
"repository": {
"type": "git",
diff --git a/packages/pug-error/index.js b/packages/pug-error/src/index.ts
similarity index 53%
rename from packages/pug-error/index.js
rename to packages/pug-error/src/index.ts
index 9bc75135d..087b606d1 100644
--- a/packages/pug-error/index.js
+++ b/packages/pug-error/src/index.ts
@@ -1,24 +1,25 @@
-'use strict';
-
-module.exports = makeError;
-function makeError(code, message, options) {
- var line = options.line;
- var column = options.column;
- var filename = options.filename;
- var src = options.src;
- var fullMessage;
- var location = line + (column ? ':' + column : '');
+export default function makeError(
+ code: string,
+ message: string,
+ options: {line: number; column: number; filename?: string; src?: string},
+) {
+ const line = options.line;
+ const column = options.column;
+ const filename = options.filename;
+ const src = options.src;
+ let fullMessage;
+ const location = line + (column ? ':' + column : '');
if (src && line >= 1 && line <= src.split('\n').length) {
- var lines = src.split('\n');
- var start = Math.max(line - 3, 0);
- var end = Math.min(lines.length, line + 3);
+ const lines = src.split('\n');
+ const start = Math.max(line - 3, 0);
+ const end = Math.min(lines.length, line + 3);
// Error context
- var context = lines
+ const context = lines
.slice(start, end)
.map(function(text, i) {
- var curr = i + start + 1;
- var preamble = (curr == line ? ' > ' : ' ') + curr + '| ';
- var out = preamble + text;
+ const curr = i + start + 1;
+ const preamble = (curr == line ? ' > ' : ' ') + curr + '| ';
+ let out = preamble + text;
if (curr === line && column > 0) {
out += '\n';
out += Array(preamble.length + column).join('-') + '^';
@@ -31,7 +32,7 @@ function makeError(code, message, options) {
} else {
fullMessage = (filename || 'Pug') + ':' + location + '\n\n' + message;
}
- var err = new Error(fullMessage);
+ const err: any = new Error(fullMessage);
err.code = 'PUG:' + code;
err.msg = message;
err.line = line;
@@ -49,3 +50,7 @@ function makeError(code, message, options) {
};
return err;
}
+
+// Make this easier to use from CommonJS
+module.exports = makeError;
+module.exports.default = makeError;
diff --git a/packages/pug-error/test/index.test.js b/packages/pug-error/test/index.test.js
index 19aca14a3..7008fa853 100644
--- a/packages/pug-error/test/index.test.js
+++ b/packages/pug-error/test/index.test.js
@@ -1,6 +1,5 @@
'use strict';
-var assert = require('assert');
var error = require('../');
describe('with a source', function() {
diff --git a/packages/pug-error/tsconfig.json b/packages/pug-error/tsconfig.json
new file mode 100644
index 000000000..1233d3d8c
--- /dev/null
+++ b/packages/pug-error/tsconfig.json
@@ -0,0 +1,10 @@
+{
+ "extends": "../../tsconfig.json",
+ "compilerOptions": {
+ "composite": true,
+ "rootDir": "src",
+ "outDir": "lib",
+ "tsBuildInfoFile": "lib/tsconfig.tsbuildinfo",
+ },
+ "references": [],
+}
diff --git a/packages/pug-strip-comments/LICENSE b/packages/pug-strip-comments/LICENSE
new file mode 100644
index 000000000..e2a4f77b0
--- /dev/null
+++ b/packages/pug-strip-comments/LICENSE
@@ -0,0 +1,19 @@
+Copyright (c) 2021 Forbes Lindesay
+
+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.
\ No newline at end of file
diff --git a/scripts/prebuild.js b/scripts/prebuild.js
new file mode 100644
index 000000000..7df2ccd82
--- /dev/null
+++ b/scripts/prebuild.js
@@ -0,0 +1,132 @@
+const {
+ readdirSync,
+ writeFileSync,
+ statSync,
+ readFileSync,
+ existsSync,
+} = require('fs');
+
+const LICENSE = `Copyright (c) ${new Date().getFullYear()} Forbes Lindesay
+
+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.`;
+
+const packageNames = [];
+const typeScriptPackages = [];
+const packageDirectories = readdirSync(__dirname + '/../packages')
+ .filter(directory =>
+ statSync(__dirname + '/../packages/' + directory).isDirectory()
+ )
+ .sort();
+packageDirectories.forEach(directory => {
+ if (!existsSync(__dirname + '/../packages/' + directory + '/LICENSE')) {
+ writeFileSync(
+ __dirname + '/../packages/' + directory + '/LICENSE',
+ LICENSE
+ );
+ }
+ let pkg = {};
+ try {
+ pkg = JSON.parse(
+ readFileSync(
+ __dirname + '/../packages/' + directory + '/package.json',
+ 'utf8'
+ )
+ );
+ } catch (ex) {
+ if (ex.code !== 'ENOENT') {
+ throw ex;
+ }
+ }
+ const before = JSON.stringify(pkg);
+ if (!pkg.name) {
+ pkg.name = directory;
+ }
+ packageNames.push(pkg.name);
+ const after = JSON.stringify(pkg);
+ if (before !== after) {
+ writeFileSync(
+ __dirname + '/../packages/' + directory + '/package.json',
+ JSON.stringify(pkg, null, ' ') + '\n'
+ );
+ }
+ if (existsSync(__dirname + '/../packages/' + directory + '/tsconfig.json')) {
+ typeScriptPackages.push(directory);
+ const deps = [
+ ...Object.keys(pkg.dependencies || {}),
+ ...Object.keys(pkg.devDependencies || {}),
+ ]
+ .filter(dep =>
+ existsSync(__dirname + '/../packages/' + dep + '/tsconfig.json')
+ )
+ .map(
+ dep =>
+ `\n {"path": ${JSON.stringify(
+ `../${dep.substr(`@databases/`.length)}`
+ )}},`
+ )
+ .join(``);
+ writeFileSync(
+ __dirname + '/../packages/' + directory + '/tsconfig.json',
+ `{
+ "extends": "../../tsconfig.json",
+ "compilerOptions": {
+ "composite": true,
+ "rootDir": "src",
+ "outDir": "lib",
+ "tsBuildInfoFile": "lib/tsconfig.tsbuildinfo",
+ },
+ "references": ${deps.length ? `[${deps}\n ],` : `[],`}
+}
+`
+ );
+ }
+});
+
+writeFileSync(
+ `scripts/tsconfig.json`,
+ `{
+ "extends": "../tsconfig.json",
+ "references": [${typeScriptPackages
+ .map(n => `\n {"path": ${JSON.stringify(`../packages/${n}`)}},`)
+ .join(``)}
+ ],
+}`
+);
+const [README_HEADER, _table, README_FOOTER] = readFileSync(
+ __dirname + '/../README.md',
+ 'utf8'
+).split('');
+
+const versionsTable = `
+Package Name | Version
+-------------|--------
+${packageNames
+ .sort()
+ .map(
+ name =>
+ `${name} | [](https://www.npmjs.com/package/${name})`
+ )
+ .join('\n')}
+`;
+writeFileSync(
+ __dirname + '/../README.md',
+ [README_HEADER, versionsTable, README_FOOTER || ''].join(
+ ''
+ )
+);
diff --git a/tsconfig.json b/tsconfig.json
new file mode 100644
index 000000000..a5df34e36
--- /dev/null
+++ b/tsconfig.json
@@ -0,0 +1,15 @@
+{
+ "compilerOptions": {
+ "target": "ES5",
+ "module": "commonjs",
+ "declaration": true,
+ "sourceMap": true,
+ "strict": true,
+ "noUnusedLocals": true,
+ "noUnusedParameters": false,
+ "noImplicitReturns": true,
+ "noFallthroughCasesInSwitch": true,
+ "lib": ["es2016", "dom"],
+ "pretty": true
+ }
+}
\ No newline at end of file
diff --git a/yarn.lock b/yarn.lock
index aebbb3fa2..0c402c83a 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -4039,6 +4039,11 @@ typedarray-to-buffer@^3.1.5:
dependencies:
is-typedarray "^1.0.0"
+typescript@^4.1.2:
+ version "4.5.4"
+ resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.5.4.tgz#a17d3a0263bf5c8723b9c52f43c5084edf13c2e8"
+ integrity sha512-VgYs2A2QIRuGphtzFV7aQJduJ2gyfTljngLzjpfW9FoYZF6xuw1W0vW9ghCKLfcWrCFxK81CSGRAvS1pn4fIUg==
+
uc.micro@^1.0.1, uc.micro@^1.0.5:
version "1.0.6"
resolved "https://registry.yarnpkg.com/uc.micro/-/uc.micro-1.0.6.tgz#9c411a802a409a91fc6cf74081baba34b24499ac"