npmpackage.info

pug

Pug – robust, elegant, feature rich template engine for Node.js

3.0.3

21,699

JavaScript

185.52 kB

356,704,118 3.6

Installations

npm install pug

Pull Requests

Open

23

Total

861

Closed

336

Merged

502

Issues

Open

296

Total

2,578

Closed

2,282

Releases

pug@3.0.3

Published on 24 May 2024

pug-code-gen@3.0.3

Published on 24 May 2024

pug-error@2.1.0

Published on 24 May 2024

pug@3.0.2

Published on 28 Feb 2021

pug-lexer@5.0.1

Published on 28 Feb 2021

pug-runtime@3.0.1

Published on 28 Feb 2021

View all 25 releases

Developer

pugjs

Developer Guide

BETA

Module System

CommonJS, UMD

Min. Node Version

Typescript Support

No

Node Version

12.22.12

NPM Version

6.14.16 Statistics

21,699 Stars

2,573 Commits

1,952 Forks

539 Watching

11 Branches

250 Contributors

Updated on 27 Nov 2024

Bundle Size

785.00 kB

Minified

185.52 kB

Minified + Gzipped

Bundlephobia

Languages

JavaScript (78.47%)

Pug (14.98%)

HTML (5.98%)

TypeScript (0.49%)

CoffeeScript (0.04%)

Stylus (0.03%)

CSS (0.01%)

Total Downloads

Cumulative downloads

Total Downloads

356,704,118

Last day

-4.1%

300,101

Compared to previous day

Last week

1.4%

1,591,158

Compared to previous week

Last month

10.4%

6,573,360

Compared to previous month

Last year

8.2%

76,114,474

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

pug-code-gen pug-filters pug-lexer pug-linker pug-load pug-parser pug-runtime pug-strip-comments

Dev Dependencies

jstransformer-cdata jstransformer-coffee-script jstransformer-less jstransformer-markdown-it jstransformer-stylus jstransformer-uglify-js jstransformer-verbatim mkdirp rimraf uglify-js

Versions

Pug

Full documentation is at pugjs.org

Pug is a high-performance template engine heavily influenced by Haml and implemented with JavaScript for Node.js and browsers. For bug reports, feature requests and questions, open an issue. For discussion join the chat room.

You can test drive Pug online here.

Professionally supported pug is now available

Packages

Package Name	Version
pug
pug-attrs
pug-code-gen
pug-error
pug-filters
pug-lexer
pug-linker
pug-load
pug-parser
pug-runtime
pug-strip-comments
pug-walk

Rename from "Jade"

This project was formerly known as "Jade". However, it was revealed to us that "Jade" is a registered trademark; as a result, a rename was needed. After some discussion among the maintainers, "Pug" was chosen as the new name for this project. As of version 2, "pug" is the official package name.

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.

The syntax of Pug has several differences, deprecations, and removals compared to its predecessor. These differences are documented in #2305.

The website and documentation for Pug are still being updated. But if you are new to Pug, you should get started with the new syntax and install the Pug package from npm.

Installation

Package

To use Pug in your own JavaScript projects:

1$ npm install pug

Command Line

After installing the latest version of Node.js, install with:

1$ npm install pug-cli -g

and run with

1$ pug --help

Syntax

Pug is a clean, whitespace sensitive syntax for writing HTML. Here is a simple example:

1doctype html
2html(lang="en")
3  head
4    title= pageTitle
5    script(type='text/javascript').
6      if (foo) bar(1 + 5);
7  body
8    h1 Pug - node template engine
9    #container.col
10      if youAreUsingPug
11        p You are amazing
12      else
13        p Get on it!
14      p.
15        Pug is a terse and simple templating language with a
16        strong focus on performance and powerful features.

Pug transforms the above to:

1<!DOCTYPE html>
2<html lang="en">
3  <head>
4    <title>Pug</title>
5    <script type="text/javascript">
6      if (foo) bar(1 + 5);
7    </script>
8  </head>
9  <body>
10    <h1>Pug - node template engine</h1>
11    <div id="container" class="col">
12      <p>You are amazing</p>
13      <p>
14        Pug is a terse and simple templating language with a strong focus on
15        performance and powerful features.
16      </p>
17    </div>
18  </body>
19</html>

API

For full API, see pugjs.org/api/reference.html

1var pug = require('pug');
2
3// compile
4var fn = pug.compile('string of pug', options);
5var html = fn(locals);
6
7// render
8var html = pug.render('string of pug', merge(options, locals));
9
10// renderFile
11var html = pug.renderFile('filename.pug', merge(options, locals));

Options

filename Used in exceptions, and required when using includes
compileDebug When false no debug instrumentation is compiled
pretty Add pretty-indentation whitespace to output (false by default)

Browser Support

The latest version of pug can be downloaded for the browser in standalone form. It only supports the very latest browsers, though, and is a large file. It is recommended that you pre-compile your pug templates to JavaScript.

To compile a template for use on the client using the command line, do:

1$ pug --client --no-debug filename.pug

which will produce filename.js containing the compiled template.

Tutorials

cssdeck interactive Pug syntax tutorial
cssdeck interactive Pug logic tutorial
Pug について。 (A Japanese Tutorial)

Implementations in other languages

Ports in other languages

Ports to other languages, with very close syntax:

Equivalents in other languages

Templates engines for other languages with a different syntax, but a similar philosophy:

Scaml for Scala
Slim for Ruby (should not be confused with Slim PHP framework)
HAML for Ruby

Framework implementations/adapters

Embedded view engines for frameworks:

CMS plugins

WordPress

Additional Resources

Emacs Mode
Vim Syntax
TextMate Bundle
Coda/SubEtha syntax Mode
html2pug converter
pug2php converter
Pug Server Ideal for building local prototypes apart from any application
cache-pug-templates Cache Pug templates for Lad/Koa/Express/Connect with Redis
Prettier Plugin

Backers

Support us with a monthly donation and help us continue our activities. [Become a backer]

License

MIT

Stable Version

The latest stable version of the package.

Stable Version

3.0.3

HIGH

6.8/10

Summary

Remote code execution via the `pretty` option.

Affected Versions

< 3.0.1

Patched Versions

3.0.1

MODERATE

6.8/10

Summary

Pug allows JavaScript code execution if an application accepts untrusted input

Affected Versions

<= 3.0.2

Patched Versions

3.0.3

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Security-Policy

Determines if the project has published a security policy.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

5

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/rollingversions-canary.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/pugjs/pug/rollingversions-canary.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/rollingversions-canary.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/pugjs/pug/rollingversions-canary.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/rollingversions-canary.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/pugjs/pug/rollingversions-canary.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/rollingversions-canary.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/pugjs/pug/rollingversions-canary.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/rollingversions.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/pugjs/pug/rollingversions.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/rollingversions.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/pugjs/pug/rollingversions.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/rollingversions.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/pugjs/pug/rollingversions.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/rollingversions.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/pugjs/pug/rollingversions.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/pugjs/pug/test.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/pugjs/pug/test.yml/master?enable=pin
Info: 0 out of 10 GitHub-owned GitHubAction dependencies pinned

0

Fuzzing

Determines if the project uses fuzzing.

0

License

Determines if the project has defined a license.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

3.6

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to pug

pug-error

2.1.0

Standard error objects for pug

pug-attrs

3.0.0

Generate code for Pug attributes

pug-load

3.0.0

The Pug loader is responsible for loading the depenendencies of a given Pug file.

@types/pug

2.0.10

TypeScript definitions for pug

pug

Installations

Pull Requests

23

861

336

502

Issues

296

2,578

2,282

Releases

Developer

Developer Guide

CommonJS, UMD

No

12.22.12

6.14.16

Statistics

Bundle Size

785.00 kB

185.52 kB

Languages

Total Downloads

356,704,118

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

Pug

Packages

Rename from "Jade"

Installation

Package

Command Line

Syntax

API

Options

Browser Support

Tutorials

Implementations in other languages

Ports in other languages

Equivalents in other languages

Framework implementations/adapters

CMS plugins

Additional Resources

Backers

Sponsors

License

Stable Version

3.0.3

HIGH

MODERATE

10

10

10

5

0

0

0

0

0

0

0

0

3.6

/10

Other packages similar to pug