A Webpack4+ plugin for userscript projects. 🙈
The package has been renamed from
- Combine your userscript development with Webpack
With powerful Webpack support, you can even package everything in your userscript, e.g. icons and json data.
- Ability to generate userscript headers
- Ability to generate both
.meta.jsis used for update check containing headers only.
- Properly track files in watch mode
Including external header files and package.json.
- Helper mode to integrate with Webpack Dev Server and TamperMonkey.
Additionally ouput proxy scripts along with main userscripts, which looks similar with
*.meta.jsbut with additional
@requiremeta field to include the main userscript, then you can set your TamperMonkey not to cache external files. It's useful when the script is under development.
- Support generating SRIs for
@resourceURLs if the protocol is either
npm i webpack-userscript -D
Include the plugin in the
webpack.config.js as the following example.
const WebpackUserscript =moduleexports =plugins:
The following example can be used in development mode with the help of
webpack-dev-server will build the userscript in watch mode. Each time the project is built, the
buildNo variable will increase by 1.
buildNowill be reset to 0 if the dev server is terminated. In this case, if you expect the build version to be persisted during dev server restarting, you can use the
In the following configuration, a portion of the
version contains the
buildNo; therefore, each time there is a build, the
version is also increased so as to indicate a new update available for the script engine like Tampermonkey or GreaseMonkey.
After the first time starting the
webpack-dev-server, you can install the script via
http://localhost:8080/<project-name>.user.js (the URL is actually refered to your configuration of
webpack-dev-server). Once installed, there is no need to manually reinstall the script until you stop the server. To update the script, the script engine has an update button on the GUI for you.
const path =const WebpackUserscript =const dev = processenvNODE_ENV === 'development'moduleexports =mode: dev ? 'development' : 'production'entry: pathoutput:path: pathfilename: '<project-name>.user.js'devServer:contentBase: pathplugins:headers:version: dev ? `[version]-build.[buildNo]` : `[version]`
Integration with Webpack Dev Server and TamperMonkey
If you feel tired with firing the update button on TamperMonkey GUI, maybe you can have a try at proxy script.
A proxy script actually looks similar with the content of
*.meta.js except that it contains additional
@require field to include the main userscript. A proxy script is used since TamperMonkey has an option that makes external scripts always be update-to-date without caching, and external scripts are included into userscripts via the
@require meta field. (You may also want to read this issue, Tampermonkey/tampermonkey#767)
To avoid caching and make the main script always be updated after each page refresh, we have to make our main script "an external resource". That is where the proxy script comes in, it provides TamperMonkey with a
@require pointint to the URL of the main script on the dev server, and each time you reload your testing page, it will trigger the update.
Actually it requires 2 reloads for each change to take effect on the page. The first reload trigger the update of external script but without execution (it runs the legacy version of the script), the second reload will start to run the updated script.
I have no idea why TamperMonkey is desinged this way. But..., it's up to you!
To enable the proxy script, provide a
proxyScript configuration to the plugin constructor.
true will always enable proxy script, or you can provide a function that returns boolean. In the example below, the proxy script is enabled if the environment contains a variable,
LOCAL_DEV, which is equal to
baseUrl should be the base URL of the dev server, and the
filename is for the proxy script.
After starting the dev server, you can find your proxy script under
<baseUrl>/<filename>. In the example below, assume the entry filename is
index.js, you should visit
http://127.0.0.1:12345/index.proxy.user.js to install the proxy script on TamperMonkey.
Notes that the leaf values of
proxyScriptwith also be interpolated; that is, template variables which can be found here are also supported inside these string settings.
// <...your other configs...>,proxyScript:baseUrl: ''filename: '[basename].proxy.user.js'processenvLOCAL_DEV === '1'
Other examples can be found under the test fixture folder.
WebpackUserscript constructor has the following signature.
Also see the schema of options.
A path to a js or json file which exports a header object or a header provider function.
A function that returns a header object.
A header object, whose leaves are webpack-like template strings in
[<var_name>] format. Available variables can be found at DataObject.
Local variables used to interpolate the templates of a HeaderObject.
Also see template-strings/webpack.config.js.