icelam/html-inline-script-webpack-pluginPublic

NotificationsYou must be signed in to change notification settings
Fork10
Star57

A webpack plugin for converting external script files to inline script block. Requires 'html-webpack-plugin' to work.

www.npmjs.com/package/html-inline-script-webpack-plugin

License

MIT license

57 stars 10 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 456 Commits
.github		.github
.husky		.husky
__tests__		__tests__
docs		docs
src		src
.editorconfig		.editorconfig
.eslintignore		.eslintignore
.eslintrc		.eslintrc
.gitignore		.gitignore
.lintstagedrc		.lintstagedrc
.npmignore		.npmignore
.nvmrc		.nvmrc
.prettierrc		.prettierrc
.versionrc		.versionrc
CHANGELOG.md		CHANGELOG.md
LICENSE		LICENSE
README.md		README.md
commitlint.config.js		commitlint.config.js
jest.config.js		jest.config.js
package.json		package.json
tsconfig.json		tsconfig.json
yarn.lock		yarn.lock

Repository files navigation

HTML Inline Script Webpack Plugin for webpack (html-inline-script-webpack-plugin)

A webpack plugin for converting external script files<script src="app.js"></script> to inline script block<script>...</script>. Requireshtml-webpack-plugin to work.

Inspired byreact-dev-utils created byFacebook.

Install

Webpack5

npm i html-inline-script-webpack-plugin -D

Webpack4

npm i html-inline-script-webpack-plugin@^1 -D

Usage

By default, the plugin will convert all the external script files to inline script block, and remove the original script file from build assets.

constHtmlWebpackPlugin=require('html-webpack-plugin');constHtmlInlineScriptPlugin=require('html-inline-script-webpack-plugin');module.exports={plugins:[newHtmlWebpackPlugin(),newHtmlInlineScriptPlugin()],};

Options

Below are lists of options supported by this plugin:

Name	Description	Type
scriptMatchPattern	List of script files that should be processed and inject as inline script. This will be filtered using the output file name.	RegExp[]
htmlMatchPattern	List of HTML template files that should be processed by this plugin. Useful when you have multiple`html-webpack-plugin` initialized. This will be filtered using the`options?.filename` provided by`html-webpack-plugin`.	RegExp[]
assetPreservePattern	List of script files that should be preserved by this plugin after inserting them inline. This will be filtered using the output file name.	RegExp[]

Here are some examples illustrating how to use these options:

Process only script files that have file name start with`runtime~` and`app~`

constHtmlWebpackPlugin=require('html-webpack-plugin');constHtmlInlineScriptPlugin=require('html-inline-script-webpack-plugin');module.exports={plugins:[newHtmlWebpackPlugin(),newHtmlInlineScriptPlugin({scriptMatchPattern:[/runtime~.+[.]js$/,/app~.+[.]js$/],}),],};

Process any script files but only have them inlined in`index.html`

constHtmlWebpackPlugin=require('html-webpack-plugin');constHtmlInlineScriptPlugin=require('html-inline-script-webpack-plugin');module.exports={plugins:[newHtmlWebpackPlugin({filename:'index.html',template:'static/index.webos.html',}),newHtmlWebpackPlugin({filename:'page2.html',template:'page2.html',}),newHtmlInlineScriptPlugin({htmlMatchPattern:[/index.html$/],}),],};

Process script files that have file name start with`runtime~` and`app~` and inject only to`index.html`

constHtmlWebpackPlugin=require('html-webpack-plugin');constHtmlInlineScriptPlugin=require('html-inline-script-webpack-plugin');module.exports={plugins:[newHtmlWebpackPlugin({filename:'index.html',template:'static/index.webos.html',}),newHtmlWebpackPlugin({filename:'page2.html',template:'page2.html',}),newHtmlInlineScriptPlugin({scriptMatchPattern:[/runtime~.+[.]js$/,/app~.+[.]js$/],htmlMatchPattern:[/index.html$/],}),],};

Process any script files but preserve`main.js` from build assets

constHtmlWebpackPlugin=require('html-webpack-plugin');constHtmlInlineScriptPlugin=require('html-inline-script-webpack-plugin');module.exports={plugins:[newHtmlWebpackPlugin(),newHtmlInlineScriptPlugin({assetPreservePattern:[/main.js$/],}),],};

Known limitations

This plugin does not transform Web Worker syntax like `new Worker(new URL('./worker.js', import.meta.url));``. It simply embeds the source code processed by webpack into HTML files, and emits any JavaScript files that is not processed by the plugin.
This plugin is designed to embed script content into HTML files for deployment to environments where only a single file can be uploaded, or where the script file itself is small enough that it doesn't warrant an additional HTTP request. It is not intended for use in development, and may fail if HMR is enabled.
This plugin does not support inlining scripts that are dynamically imported (theimport() syntax). The reason is explained inthis issue.