Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/icelam/html-inline-script-webpack-plugin
A webpack plugin for converting external script files to inline script block. Requires 'html-webpack-plugin' to work.
https://github.com/icelam/html-inline-script-webpack-plugin
html-webpack-plugin inline-script inline-source typescript webpack webpack-plugin webpack4
Last synced: 3 days ago
JSON representation
A webpack plugin for converting external script files to inline script block. Requires 'html-webpack-plugin' to work.
- Host: GitHub
- URL: https://github.com/icelam/html-inline-script-webpack-plugin
- Owner: icelam
- License: mit
- Created: 2020-07-09T06:28:36.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2024-08-01T10:30:34.000Z (5 months ago)
- Last Synced: 2024-10-11T23:08:45.983Z (3 months ago)
- Topics: html-webpack-plugin, inline-script, inline-source, typescript, webpack, webpack-plugin, webpack4
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/html-inline-script-webpack-plugin
- Size: 1.76 MB
- Stars: 55
- Watchers: 3
- Forks: 10
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# HTML Inline Script Webpack Plugin for webpack (html-inline-script-webpack-plugin)
[](https://github.com/icelam/html-inline-script-webpack-plugin/releases)
[](https://www.npmjs.com/package/html-inline-script-webpack-plugin)
[](https://packagephobia.com/result?p=html-inline-script-webpack-plugin)
[](https://packagequality.com/#?package=html-inline-script-webpack-plugin)
[](https://npmjs.org/package/html-inline-script-webpack-plugin)
A webpack plugin for converting external script files `` to inline script block `...`. Requires [html-webpack-plugin](https://github.com/jantimon/html-webpack-plugin) to work.
Inspired by [react-dev-utils](https://github.com/facebook/create-react-app/blob/master/packages/react-dev-utils/InlineChunkHtmlPlugin.js) created by [Facebook](https://github.com/facebook/).
## Install
### Webpack5
```bash
npm i html-inline-script-webpack-plugin -D
```
### Webpack4
```bash
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.
```js
const HtmlWebpackPlugin = require('html-webpack-plugin');
const HtmlInlineScriptPlugin = require('html-inline-script-webpack-plugin');
module.exports = {
plugins: [new HtmlWebpackPlugin(), new HtmlInlineScriptPlugin()],
};
```
## 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`](https://github.com/jantimon/html-webpack-plugin#options) 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~`
```js
const HtmlWebpackPlugin = require('html-webpack-plugin');
const HtmlInlineScriptPlugin = require('html-inline-script-webpack-plugin');
module.exports = {
plugins: [
new HtmlWebpackPlugin(),
new HtmlInlineScriptPlugin({
scriptMatchPattern: [/runtime~.+[.]js$/, /app~.+[.]js$/],
}),
],
};
```
##### Process any script files but only have them inlined in `index.html`
```js
const HtmlWebpackPlugin = require('html-webpack-plugin');
const HtmlInlineScriptPlugin = require('html-inline-script-webpack-plugin');
module.exports = {
plugins: [
new HtmlWebpackPlugin({
filename: 'index.html',
template: 'static/index.webos.html',
}),
new HtmlWebpackPlugin({
filename: 'page2.html',
template: 'page2.html',
}),
new HtmlInlineScriptPlugin({
htmlMatchPattern: [/index.html$/],
}),
],
};
```
##### Process script files that have file name start with `runtime~` and `app~` and inject only to `index.html`
```js
const HtmlWebpackPlugin = require('html-webpack-plugin');
const HtmlInlineScriptPlugin = require('html-inline-script-webpack-plugin');
module.exports = {
plugins: [
new HtmlWebpackPlugin({
filename: 'index.html',
template: 'static/index.webos.html',
}),
new HtmlWebpackPlugin({
filename: 'page2.html',
template: 'page2.html',
}),
new HtmlInlineScriptPlugin({
scriptMatchPattern: [/runtime~.+[.]js$/, /app~.+[.]js$/],
htmlMatchPattern: [/index.html$/],
}),
],
};
```
##### Process any script files but preserve `main.js` from build assets
```js
const HtmlWebpackPlugin = require('html-webpack-plugin');
const HtmlInlineScriptPlugin = require('html-inline-script-webpack-plugin');
module.exports = {
plugins: [
new HtmlWebpackPlugin(),
new HtmlInlineScriptPlugin({
assetPreservePattern: [/main.js$/],
}),
],
};
```
## Known limitations
1. 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.
2. 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.
3. This plugin does not support inlining scripts that are dynamically imported (the `import()` syntax). The reason is explained in [this issue](https://github.com/icelam/html-inline-script-webpack-plugin/issues/494#issuecomment-2016902280).
## Contributors
Thanks goes to these wonderful people:
