Skip to content

gozenc/interpolate-html-plugin

Repository files navigation

InterpolateHtmlPlugin

Replaces your variable names in your HTML templates.

Inspired from react-dev-utils/interpolate-html-plugin.
Written in TypeScript with

Overview

It works in combination with latest versions of HtmlWebpackPlugin and webpack. You can learn more about creating plugins like this here.

Installation

NPM YARN
npm i -D webpack html-webpack-plugin yarn add -D webpack html-webpack-plugin
npm i -D @gozenc/interpolate-html-plugin yarn add -D @gozenc/interpolate-html-plugin

Usage

const HtmlWebpackPlugin = require("html-webpack-plugin")
const InterpolateHtmlPlugin = require("@gozenc/interpolate-html-plugin")
// In the webpack.config file:
...
plugins: [
    new InterpolateHtmlPlugin(HtmlWebpackPlugin, {
        'PUBLIC_URL': "https://example.com",
        // Replaces %PUBLIC_URL% with https://example.com in index.html.
        VARIABLE: 1024,
        // Replaces %VARIABLE% with 1024 in index.html.
    }),
    ...

Development

I know build pipeline looks kinda strange, but I am making some Linux practice with node concurrently for performant build pipelines. I may insert some C calls into it too. I'll develop it further in the future, but of course I am open for discussions for it.

Also just open a ticket for feature requests of course, I'll be glad to resolve them.

ToDo

  • Add webpack@3 support.
  • Add webpack@4 support.
  • More testing suites for development.
  • Type definitions for hook.tap params.

About

InterpolateHtmlPlugin implemented for webpack v5

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published