pug-plugin
Advanced tools
Pug plugin for webpack handles a template as an entry point, extracts CSS and JS from their sources referenced in Pug.
The Pug Plugin generates static HTML or template function from Pug template containing source files of scripts, styles, images, fonts and other resources, similar to how it works in Vite.
script and style source files directly in Pug:
link(href="./style.scss" rel="stylesheet")script(src="./app.tsx" defer="defer")href src srcset etc. using relative path or alias:
link(href="../images/favicon.svg" type="image/svg" rel=icon)img(src="@images/pic.png" srcset="@images/pic400.png 1x, @images/pic800.png 2x")link and script tags.:escape :code :highlight :markdown.See the full list of features.
Note
‼️ All features and options of the html-bundler-webpack-plugin available now in the
pug-plugintoo.
Warning
Since the version
5.0.0, the Pug plugin is essentially the html-bundler-webpack-plugin preconfigured for using Pug templates.
Warning
Compared to the version
4.x, in the new version5.xthe source asset file can be specified in a template without therequire()function. For compatibility, therequire()function is still supported.//- OLD syntax: the path is relative to the partial file or can be as the webpack alias link(href=require("./style.scss") rel="stylesheet") //- NEW syntax: the path is relative to the entry file or can be as the webpack alias link(href="./style.scss" rel="stylesheet")See the full list of the BREAKING CHANGES in v5.
Install the pug-plugin:
npm install pug-plugin --save-dev
Install additional packages for styles:
npm install css-loader sass sass-loader --save-dev
For example, there is the Pug template with source asset files ./src/views/index.pug:
html
head
//- relative path to SCSS source file
link(href="../scss/style.scss" rel="stylesheet")
//- relative path to TypeScript source file
script(src="../app/main.js" defer="defer")
body
h1 Hello World!
//- relative path to image source file
img(src="../assets/images/picture1.png")
//- Webpack alias as path (src/assets/images/) to image source file
img(src="@images/picture2.png")
The minimal webpack config:
const PugPlugin = require('PugPlugin');
module.exports = {
plugins: [
new PugPlugin({
entry: {
// define many page templates here
index: 'src/views/index.pug', // => dist/index.html
},
js: {
// JS output filename
filename: 'js/[name].[contenthash:8].js',
},
css: {
// CSS output filename
filename: 'css/[name].[contenthash:8].css',
},
}),
],
module: {
rules: [
{
test: /\.(s?css|sass)$/,
use: ['css-loader', 'sass-loader'],
},
{
test: /\.(ico|png|jp?g|webp|svg)$/,
type: 'asset/resource',
generator: {
filename: 'img/[name].[hash:8][ext][query]',
},
},
],
},
};
Warning
No additional pug or html loaders required.
The generated HTML contains URLs of the output filenames:
<html>
<head>
<link href="css/style.05e4dd86.css" rel="stylesheet" />
<script src="js/main.f4b855d8.js" defer="defer"></script>
</head>
<body>
<h1>Hello World!</h1>
<img src="img/picture1.58b43bd8.png" />
<img src="img/picture2.bd858b43.png" />
</body>
</html>
Why the Pug Plugin since v5.0 based on html-bundler-webpack-plugin?
2021
The history of the creation of the pug-plugin began back in October 2021.
Then, at the end of 2021, I created the @webdiscus/pug-loader that had all the features of the original pug-loader.
2022
Using, then without an alternative, html-webpack-plugin caused me pain and suffering to configure webpack for rendering Pug templates containing various assets.
At the beginning of 2022, I started creating the pug-plugin as a complete replacement for the html-webpack-plugin and many other "crutches".
During of the year, the pug-plugin has gained a lot of useful features and was able to replace the html-webpack-plugin, mini-css-extract-plugin and many other plugins and loaders.
2023
Based on the pug-plugin code, I decided to create a universal html-bundler-webpack-plugin that would support all the most popular template engines, such as Eta, EJS, Handlebars, Nunjucks, Pug, TwigJS, and would be extendable for other template engines, e.g., LiquidJS.
During 2023, this plugin has gained even more useful features and absorbed all the functionality of the pug-plugin and the @webdiscus/pug-loader.
2024
At the beginning of 2024, the pug-plugin completely switched to the universal code html-bundler-webpack-plugin.
Starting from version 5.0, the pug-plugin is the html-bundler-webpack-plugin pre-configured for Pug templates with the pre-installed pug package.
The config of pug-plugin >= v5.0:
const PugPlugin = require('pug-plugin');
module.exports = {
plugins: [
new PugPlugin({
entry: {
index: 'src/views/home.pug',
},
}),
],
};
is the same as:
const HtmlBundlerPlugin = require('html-bundler-webpack-plugin');
module.exports = {
plugins: [
new HtmlBundlerPlugin({
entry: {
index: 'src/views/home.pug',
},
preprocessor: 'pug', // <= enable using Pug templating engine
}),
],
};
The
pug-plugin's heart 🧡 now lives in thehtml-bundler-webpack-plugin's body 🏋️♂️.
@webdiscus/pug-loader->pug-plugin->html-bundler-webpack-plugin->pug-plugin
FAQs
Pug plugin for webpack handles a template as an entry point, extracts CSS and JS from their sources referenced in Pug.
We found that pug-plugin demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Snyk's use of malicious npm packages for research raises ethical concerns, highlighting risks in public deployment, data exfiltration, and unauthorized testing.
Research
Security News
Socket researchers found several malicious npm packages typosquatting Chalk and Chokidar, targeting Node.js developers with kill switches and data theft.
Security News
pnpm 10 blocks lifecycle scripts by default to improve security, addressing supply chain attack risks but sparking debate over compatibility and workflow changes.