html-rspack-tags-plugin

v0.0.3

Published

a month ago

lets you define html tags to inject with HtmlRspackPlugin

Downloads

130

0High
0Medium
0Low

harpsealjs

rspack plugin html tags inject include assets

html-rspack-tags-plugin

Enhances rspack.HtmlRspackPlugin by letting you specify script or link tags to inject.

Notice

This plugin is forked from jharris4/html-webpack-tags-plugin.

Change list:

Rename package to html-rspack-tags-plugin
Rename plugin to HtmlRspackTagsPlugin
Remove webpack dependency and use @rspack/core instead
Remove HtmlRspackPlugin dependency and use rspack.HtmlRspackPlugin instead
Remove copy-webpack-plugin dev dependency and use rspack.CopyRspackPlugin instead
Remove mini-css-extract-plugin dev dependency and use rspack.CssExtractRspackPlugin instead

Motivation

When using a plugin such as CopyRspackPlugin you may have assets output to your build directory that are not detected/output by the HtmlRspackPlugin.

This plugin lets you manually resolve such issues, and also lets you inject the rspack publicPath or compilation hash into your tag paths if you so choose.

Installation

You must be running rspack on node 16.x or higher

Install the plugin with npm:

$ npm install --save-dev html-rspack-tags-plugin

Basic Usage

Require the plugin in your rspack config:

var HtmlRspackTagsPlugin = require('html-rspack-tags-plugin');
var rspack = require('@rspack/core');

Add the plugin to your rspack config:

output: {
  publicPath: '/abc/'
},
plugins: [
  new rspack.HtmlRspackPlugin(),
  new HtmlRspackTagsPlugin({ tags: ['a.js', 'b.css'], append: true })
]

Which will generate html like this:

<head>
  <!-- other head content -->
  <link rel="stylesheet" href="/abc/b.css"/>
</head>
<body>
  <!-- other body content -->
  <script type="text/javascript" src="/abc/a.js"></script>
</body>

Configuration

Default Options

This plugin will run and do nothing if no options are provided.

The default options for this plugin are shown below:

const url = require('url');

const DEFAULT_OPTIONS = {
  append: true,
  prependExternals: true,
  jsExtensions: ['.js'],
  cssExtensions: ['.css'],
  useHash: false,
  addHash: (assetPath, hash) => assetPath + '?' + hash,
  hash: undefined,
  usePublicPath: true,
  addPublicPath: (assetPath, publicPath) => url.resolve(publicPath, assetPath),
  publicPath: undefined,
  tags: [],
  links: [],
  scripts: [],
  metas: undefined
};

Options

All options for this plugin are validated as soon as the plugin is instantiated.

The available options are:

|Name|Type|Default|Description| |:--:|:--:|:-----:|:----------| |append|{Boolean}|true|Whether to prepend or append the injected tags relative to any existing or rspack bundle tags (should be set to false when using any script tag external) | |prependExternals|{Boolean}|true|Whether to default append to false for any <script> tag that has an external option specified| |files|{Array<String>}|[]|If specified this plugin will only inject tags into the HtmlRspackPlugin instances that are injecting into these files (uses minimatch)| |jsExtensions|{String\|Array<String>}|['.js']|The file extensions to use when determining if a tag in the tags option is a script| |cssExtensions|{String\|Array<String>}|['.css']|The file extensions to use when determining if a tag in the tags option is a link| |useHash|{Boolean}|false|Whether to inject the rspack compilation.hash into the tag paths| |addHash|{Function(assetPath:String, hash:String):String}|see above|The function to call when injecting the hash into the tag paths| |hash|{Boolean\|String\|Function}|undefined|Shortcut to specifying useHash and addHash| |usePublicPath|{Boolean}|true|Whether to inject the (rspack) publicPath into the tag paths| |addPublicPath|{Function(assetPath:String, publicPath:String):String}|see above|Whether to inject the publicPath into the tag paths| |publicPath|{Boolean\|String\|Function}|undefined|Shortcut to specifying usePublicPath and addPublicPath| |links|{String\|Object\|Array<String\|Object>}|[]|The tags to inject as <link> html tags| |scripts|{String\|Object\|Array<String\|Object>}|[]|The tags to inject as <script> html tags| |tags|{String\|Object\|Array<String\|Object>}|[]|The tags to inject as <link> or <script> html tags depending on the tag type| |metas|{Object\|Array<Object>}|undefined|The tags to inject as <meta> html tags|

The append option controls whether tags are injected before or after rspack or template tags.

If multiple plugins are used with append set to false then the tags will be injected in reverse order.

This option has no effect on meta tags.

This sample index.html template:

<html>
  <head><link href="template-link"></head>
  <body><script src="template-script"></script></body>
</html>

And this sample rspack config:

{
  entry: {
    'app': 'app.js',
    'style': 'style.css' // also generates style.js
  },
  plugins: [
    new HtmlRspackTagsPlugin({
      append: false, links: 'plugin-a-link', scripts: 'plugin-a-script'
    }),
    new HtmlRspackTagsPlugin({
      append: false, links: 'plugin-b-link', scripts: 'plugin-b-script'
    }),
    new HtmlRspackTagsPlugin({
      append: true, links: 'plugin-c-link', scripts: 'plugin-c-script'
    }),
    new HtmlRspackTagsPlugin({
      append: true, links: 'plugin-d-link', scripts: 'plugin-d-script'
    })
  ]
}

Will generate approximately this html:

<head>
  <link href="plugin-b-link">
  <link href="plugin-a-link">
  <link href="template-link">
  <link href="style.css">
  <link href="plugin-c-link">
  <link href="plugin-d-link">
</head>
<body>
  <script src="plugin-b-script"></script>
  <script src="plugin-a-script"></script>
  <script src="template-script"></script>
  <script src="app.js"></script>
  <script src="style.js"></script>
  <script src="plugin-c-link"></script>
  <script src="plugin-d-link"></script>
</body>

The hash option is a shortcut that overrides the useHash and addHash options:

const shortcutFunction = {
  hash: (path, hash) => path + '?' + hash
}
const isTheSameAsFunction = {
  useHash: true,
  addHash: (path, hash) => path + '?' + hash
}

const shortcutDisabled = {
  hash: false
}
const isTheSameAsDisabled = {
  useHash: false,
}

The publicPath option is a shortcut that overrides the usePublicPath and addPublicPath options:

const shortcutFunction = {
  publicPath: (path, publicPath) => publicPath + path
}
const isTheSameAsFunction = {
  usePublicPath: true,
  addPublicPath: (path, publicPath) => publicPath + path
}

const shortcutDisabled = {
  publicPath: false
}
const isTheSameAsDisabled = {
  usePublicPath: false,
}

const shortcutString = {
  publicPath: 'myValue'
}
const isTheSameAsString = {
  usePublicPath: true,
  addPublicPath: (path) => 'myValue' + path
}

When the tags option is used the type of the specified tag(s) is inferred either from the file extension or an optional type option that may be one of: 'js' \| 'css'|

The inferred type is used to split the tags option into tagLinks and tagScripts that are injected before any specified links or scripts options.

The following are functionally equivalent:

new HtmlRspackTagsPlugin({
  tags: [
    'style-1.css',
    { path: 'script-2.js' },
    { path: 'script-3-not-js.css', type: 'js' },
    'style-4.css'
  ]
});

new HtmlRspackTagsPlugin({
  links: [
    'style-1.css',
    'style-4.css'
  ],
  scripts: [
    { path: 'script-2.js' },
    { path: 'script-3-not-js.css' }
  ]
});

The value of the tags, links or scripts options can be specified in several ways:

as a String:

new HtmlRspackTagsPlugin({ tags: 'style.css' });

as an Object:

new HtmlRspackTagsPlugin({ links: { path: 'style.css' } });

as an Array of Strings or Objects:

new HtmlRspackTagsPlugin({
  scripts: [
    'aScript.js',
    {
      path: 'bScript.js'
    },
    'cScript.js'
  ]
});

When tags are specified as Objects, the following tag object options are available:

|Name|Type|Default|Description| |:--:|:--:|:-----:|:----------| |path|{String}|required*|The tag file path (used for <link href /> or <script src /> or <meta content />) (* not required for meta tags)| |append|{Boolean}|undefined| This can be used to override the plugin level append option at a tag level| |type|{'js'\|'css'}|undefined|For tags assets this may be used to specify whether the tag is a link or a script| |glob, globPath|{String, String}|undefined|Together these two options specify a glob to run, inserting a tag with path for each match result| |globFlatten|{Boolean}|false|When used with glob and globPath this flag controls whether glob-matched files are output with with full path (false) or just the filename (true)| |attributes|{Object}|undefined|The attributes to be injected into the html tags. Some attributes are filtered out by HtmlRspackPlugin. (Recommended: set HtmlRspackPlugin option: { inject: true })| |sourcePath|{String}|undefined|Specify a source path to be added as an entry to HtmlRspackPlugin. Useful to trigger rspack recompilation after the asset has changed| |hash|{Boolean\|String\|Function}|undefined|Whether & how to inject the the rspack compilation.hash into the tag's path| |publicPath|{Boolean\|String\|Function}|undefined|Whether & how to inject the (rspack) publicPath into the tag's path| |external|{Object({ packageName: String, variableName: String})}|undefined|When specified for script tags causes { packageName: variableName } to be added to the rspack config's externals|

The tag object hash option may be used to override the main hash option:

const pluginOptions = {
  hash: true,
  tags: [
    {
      path: 'will-have-hash-injected'
    },
    {
      path: 'will-NOT-have-hash-injected',
      hash: false
    },
    {
      path: 'will-be-sandwhiched-by-hash',
      hash: (path, hash) => hash + path + hash
    }
  ]
}
// or
const pluginOptionsDisabled = {
  hash: false,
  tags: [
    {
      path: 'will-NOT-have-hash-injected'
    },
    {
      path: 'will-have-hash-injected',
      hash: true
    },
  ]
}

The tag object publicPath option may be used to override the main publicPath option:

const pluginOptions = {
  publicPath: true,
  tags: [
    {
      path: 'will-have-public-path-injected'
    },
    {
      path: 'will-NOT-have-public-path-injected',
      publicPath: false
    },
    {
      path: 'will-be-sandwhiched-by-public-path',
      publicPath: (path, publicPath) => publicPath + path + publicPath
    }
  ]
}
// or
const pluginOptionsDisabled = {
  publicPath: false,
  tags: [
    {
      path: 'will-NOT-have-public-path-injected'
    },
    {
      path: 'will-have-public-path-injected',
      publicPath: true
    },
  ]
}

Examples

Using HtmlRspackTagsPlugin and CopyRspackPlugin to inject copied assets from a node_modules package:

plugins: [
  new rspack.CopyRspackPlugin([
    { from: 'node_modules/bootstrap/dist/css', to: 'css/'},
    { from: 'node_modules/bootstrap/dist/fonts', to: 'fonts/'}
  ]),
  new rspack.HtmlRspackPlugin(),
  new HtmlRspackTagsPlugin({
    links: ['css/bootstrap.min.css', 'css/bootstrap-theme.min.css']
  })
]

Using the append option set to true and false at the same time:

Note on Plugin Ordering

When append is set to false and there are multiple instances of this plugins, the second plugin's tags will be inserted before the first plugin's tags.

plugins: [
  new rspack.CopyRspackPlugin([
    { from: 'node_modules/bootstrap/dist/css', to: 'css/'},
    { from: 'node_modules/bootstrap/dist/fonts', to: 'fonts/'}
  ]),
  new rspack.HtmlRspackPlugin(),
  new HtmlRspackTagsPlugin({
    links: ['css/bootstrap.min.css', 'css/bootstrap-theme.min.css'],
    append: false
  }),
  new HtmlRspackTagsPlugin({
    links: ['css/custom.css'],
    append: true
  })
]

Using custom jsExtensions:

plugins: [
  new rspack.HtmlRspackPlugin(),
  new HtmlRspackTagsPlugin({
    tags: ['dist/output.js', 'lib/content.jsx'],
    jsExtensions: ['.js', '.jsx']
  })
]

Using custom publicPath:

plugins: [
  new rspack.CopyRspackPlugin([
    { from: 'node_modules/bootstrap/dist/css', to: 'css/'},
    { from: 'node_modules/bootstrap/dist/fonts', to: 'fonts/'}
  ]),
  new rspack.HtmlRspackPlugin(),
  new HtmlRspackTagsPlugin({
    tags: ['css/bootstrap.min.css', 'css/bootstrap-theme.min.css'],
    publicPath: 'myPublicPath/'
  })
]

This will override rspack's publicPath setting for the purposes of path prefixing.

Or to inject tag objects without prepending the publicPath:

plugins: [
  new rspack.HtmlRspackPlugin(),
  new HtmlRspackTagsPlugin({
    tags: ['css/no-public-path.min.css', 'http://some.domain.com.js'],
    publicPath: false
  })
]

Manually specifying a tag tag object type:

plugins: [
  new rspack.CopyRspackPlugin([
    { from: 'node_modules/bootstrap/dist/js', to: 'js/'},
    { from: 'node_modules/bootstrap/dist/css', to: 'css/'},
    { from: 'node_modules/bootstrap/dist/fonts', to: 'fonts/'}
  ]),
  new rspack.HtmlRspackPlugin(),
  new HtmlRspackTagsPlugin({
    tags: [
      '/js/bootstrap.min.js',
      '/css/bootstrap.min.css',
      '/css/bootstrap-theme.min.css',
      {
        path: 'https://fonts.googleapis.com/css?family=Material+Icons',
        type: 'css'
      }
    ]
  })
]

Adding custom attributes to tag objects:

The bootstrap-theme <link> tag will be given an id="bootstrapTheme" attribute.

plugins: [
  new rspack.CopyRspackPlugin([
    { from: 'node_modules/bootstrap/dist/css', to: 'css/'},
    { from: 'node_modules/bootstrap/dist/fonts', to: 'fonts/'}
  ]),
  new rspack.HtmlRspackPlugin(),
  new HtmlRspackTagsPlugin({
    tags: [
      '/css/bootstrap.min.css',
      { path: '/css/bootstrap-theme.min.css', attributes: { id: 'bootstrapTheme' } }
    ],
    append: false,
    publicPath: ''
  })
]

Using the hash option to inject the rspack compilation hash:

When the hash option is set to true, tag paths will be injected with a hash value.

The addHash option can be used to control how the hash is injected.

  plugins: [
    new rspack.CopyRspackPlugin([
      { from: 'node_modules/bootstrap/dist/css', to: 'css/'},
      { from: 'node_modules/bootstrap/dist/fonts', to: 'fonts/'}
    ]),
    new rspack.HtmlRspackPlugin(),
    new HtmlRspackTagsPlugin({
      tags: ['css/bootstrap.min.css', 'css/bootstrap-theme.min.css'],
      append: false,
      hash: true
    })
  ]

Using the hash option to customize the injection of the rspack compilation hash:

When the hash option is set to a function, tag paths will be replaced with the result of executing that function.

plugins: [
  new rspack.CopyRspackPlugin([
    { from: 'somepath/somejsfile.js', to: 'js/somejsfile.[hash].js' },
    { from: 'somepath/somecssfile.css', to: 'css/somecssfile.[hash].css' }
  ]),
  new rspack.HtmlRspackPlugin(),
  new HtmlRspackTagsPlugin({
    tags: [{ path: 'js', glob: '*.js', globPath: 'somepath' }],
    tags: [{ path: 'css', glob: '*.css', globPath: 'somepath' }],
    append: false,
    hash: function(assetName, hash) {
      assetName = assetName.replace(/\.js$/, '.' + hash + '.js');
      assetName = assetName.replace(/\.css$/, '.' + hash + '.css');
      return assetName;
    }
  })
]

Specifying specific HtmlRspackPlugin instances to inject to with the files option:

plugins: [
  new rspack.CopyRspackPlugin([
    { from: 'node_modules/bootstrap/dist/css', to: 'css/'},
    { from: 'node_modules/bootstrap/dist/fonts', to: 'fonts/'}
  ]),
  new rspack.HtmlRspackPlugin({
    filename: 'a/index.html'
  }),
  new rspack.HtmlRspackPlugin({
    filename: 'b/index.html'
  }),
  new HtmlRspackTagsPlugin({
    files: ['a/**/*.html'],
    tags: ['css/a.css'],
    append: true
  }),
  new HtmlRspackTagsPlugin({
    files: ['b/**/*.html'],
    tags: ['css/b.css'],
    append: true
  })
]

Specifying tag object path searches usings a glob:

Note that since CopyRspackPlugin does not actually copy the files to rspack's output directory until after HtmlRspackPlugin has completed, it is necessary to use the globPath to retrieve filename matches relative to the original location of any such files.

plugins: [
  new rspack.CopyRspackPlugin([
    { from: 'node_modules/bootstrap/dist/css', to: 'css/'},
    { from: 'node_modules/bootstrap/dist/fonts', to: 'fonts/'}
  ]),
  new rspack.HtmlRspackPlugin(),
  new HtmlRspackTagsPlugin({
    tags: [{ path: 'css', glob: '*.css', globPath: 'node_modules/bootstrap/dist/css/' }],
    append: true
  })
]

Using the links option to inject link tags:

output: {
  publicPath: '/my-public-path/'
},
plugins: [
  new rspack.CopyRspackPlugin([
    { from: 'node_modules/bootstrap/dist/css', to: 'css/'},
    { from: 'node_modules/bootstrap/dist/fonts', to: 'fonts/'}
  ]),
  new rspack.HtmlRspackPlugin(),
  new HtmlRspackTagsPlugin({
    tags: [],
    links: [
      {
        path: 'asset/path',
        attributes: {
          rel: 'icon'
        }
      },
      {
        path: '/absolute/asset/path',
        publicPath: false,
        attributes: {
          rel: 'manifest'
        }
      }
    ]
  })
]

Will append the following <link> elements into the index template html

<head>
  <!-- previous header content -->
  <link rel="icon" href="/my-public-path/asset/path">
  <link rel="manifest" href="/absolute/asset/path">
</head>

Note that the second link's href was not prefixed with the rspack publicPath because the second link asset's publicPath was set to false.

Using the scripts option to inject script tags:

output: {
  publicPath: '/my-public-path/'
},
plugins: [
  new rspack.CopyRspackPlugin([
    { from: 'node_modules/bootstrap/dist/js', to: 'js/'}
  ]),
  new rspack.HtmlRspackPlugin(),
  new HtmlRspackTagsPlugin({
    tags: [],
    scripts: [
      {
        path: 'asset/path',
        attributes: {
          type: 'text/javascript'
        }
      }
    ]
  })
]

Will append the following <script> element into the index template html

<body>
  <!-- previous body content -->
  <script src="/my-public-path/asset/path" type="text/javascript"></script>
</body>

Specifying scripts with external options:

output: {
  publicPath: '/my-public-path/'
},
plugins: [
  new rspack.CopyRspackPlugin([
    { from: 'node_modules/bootstrap/dist/js', to: 'js/'}
  ]),
  new rspack.HtmlRspackPlugin(),
  new HtmlRspackTagsPlugin({
    tags: [],
    scripts: [
      {
        path: 'asset/path',
        external: {
          packageName: 'react',
          variableName: 'React'
        },
        attributes: {
          type: 'text/javascript'
        }
      }
    ]
  })
]

Will add the following properties to the rspack.compilation.options.externals:

const compilationConfig = {
  ...otherProperties,
  externals: {
    "react": "React"
  }
};

This can be useful to control which packages rspack is bundling versus ones you can serve from a CDN.

Note that script tags with external specified need to be placed before the rspack bundle tags.

This means that you should always set append to false when using the script external option.

The prependExternals option was added in 2.0.10 to handle this case automatically.

Using the metas option to inject meta tags:

output: {
  publicPath: '/my-public-path/'
},
plugins: [
  new rspack.CopyRspackPlugin([
    { from: 'node_modules/bootstrap/dist/js', to: 'js/'}
  ]),
  new rspack.HtmlRspackPlugin(),
  new HtmlRspackTagsPlugin({
    metas: [
      {
        path: 'asset/path',
        attributes: {
          name: 'the-meta-name'
        }
      }
    ]
  })
]

Will inject the following <meta> element into the index template html

<head>
  <!-- previous header content -->
  <meta content="/my-public-path/asset/path" name="the-meta-name">
</head>

Note that the append settings has no effect on how the <meta> elements are injected.

Caveats

Plugin Ordering

Some users have encountered issues with plugin ordering.

It is advisable to always place any HtmlRspackPlugin plugins before any HtmlRspackTagsPlugin plugins in your rspack config.
When append is false tags are injected before any other tags. This means that if you have two instances of this plugin both with append set to false, then the second plugin's tags will be injected before the first plugin's tags.

rspack `externals`

Setting the external option for a script tag object requires caution to ensure that the scripts are in the correct order.

It is advisable to always set append to false so that external <script> tags are always inserted before the rspack bundle <script> tags.
The order that you use when you specify a list of external links matters. For example, <script src="react.js"/> should come before <script src="react-router.s"/> if react-router has a peer dependency on react.

HtmlRspackPlugin `inject` option

Changing HtmlRspackPlugin inject option from its default value of true may cause issues.

This plugin recommends that the HtmlRspackPlugin inject option to be true for attribute injection to work.

Disabling injection means that you are agreeing to template how the tags should be generated in your templates/index.html file like this:

<html>
  <head>
    <!-- other head content -->
    <% for (var cssIndex = 0; cssIndex < htmlRspackPlugin.files.css.length; cssIndex++) { %>
    <link rel="stylesheet" href="<%= htmlRspackPlugin.files.css[cssIndex] %>">
    <% } %>
  </head>
  <body>
    <!-- other body content -->
    <% for (var jsIndex = 0; jsIndex < htmlRspackPlugin.files.js.length; jsIndex++) { %>
    <script src="<%= htmlRspackPlugin.files.js[jsIndex] %>"></script>
    <% } %>
  </body>
</html>

The default templating engine for HtmlRspackPlugin seems to be based on lodash.

With the above template we might use the following rspack config which disables inject:

output: {
  publicPath: '/the-public-path/'
},
plugins: [
  new rspack.HtmlRspackPlugin({ <b>inject: false</b> }),
  new HtmlRspackTagsPlugin({
    tags: [{ path: 'css/bootstrap-theme.min.css', attributes: { id: 'bootstrapTheme' } }],
    links: [{ href: 'the-ref', attributes: { rel: 'icon' } }],
    append: true
  })
]

The problem is that the template syntax does not seem to allow injection of more than one attribute value, namely the path (href or src)

This means it will generate an index.html that is missing all of the script attributes like this:

<head>
  <link href="/the-public-path/css/bootstrap-theme.min.css">
  <link href="/the-public-path/the-ref">
</head>

If the templating engine supports injection of entire tags instead of just the href/src attribute value then working with inject set to false may be possible.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

html-rspack-tags-plugin

Notice

Motivation

Installation

Basic Usage

Configuration

Default Options

Options

Examples

Note on Plugin Ordering

Caveats

Plugin Ordering

rspack externals

HtmlRspackPlugin inject option

rspack `externals`

HtmlRspackPlugin `inject` option