wext-manifest-loader

Webpack Loader for Webextension manifest

🙋‍♂️ Made by @abhijithvijayan

Donate:
PayPal,
Patreon

Generate browser tailored manifest.json for Web Extensions that you specify properties to appear only in specific browsers.

❤️ it? ⭐️ it on GitHub or Tweet about it.

Table of Contents

- Browser Support
- Installation
- Usage
- FAQs
- Issues
- 🐛 Bugs
- LICENSE

Browser Support

|  |  |  |  |
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ✔ | ✔ | ✔ | ✔ |

This loader will take a definition input for the manifest, and return you content for the specified browser.

$3

Checkout web-extension-starter that uses this package

Installation

Ensure you have Node.js 10 or later installed. Then run the following:

``sh


via npm

You can easily use this module together with the wext-manifest-webpack-plugin to output the manifest.json as part of your build process without any additional js bundle and with auto rebundling on file change.

Note: Make sure you pass a TARGET_BROWSER env variable with one of chrome/firefox/edge/opera value

#### Sample manifest with vendor prefixed keys

> webpack.config.js

`js
// ... other plugins
const WextManifestWebpackPlugin = require("wext-manifest-webpack-plugin");

const targetBrowser = process.env.TARGET_BROWSER;
const destPath = path.join(__dirname, 'extension');

module.exports = {
entry: {
manifest: './src/manifest.json',
// ...
},

output: {
path: path.join(destPath, targetBrowser),
filename: 'js/[name].bundle.js',
},

module: {
rules: [
{
type: 'javascript/auto', // prevent webpack handling json with its own loaders,
test: /manifest\.json$/,
use: 'wext-manifest-loader',
exclude: /node_modules/,
},
]
},

plugins: [
new WextManifestWebpackPlugin(),
// ...
],
};
`

Options

$3

Type: Boolean
Default: false

If true, updates manifest.json version field with package.json version. It is often useful for easy release of web-extension.

webpack.config.js

`js
module.exports = {
module: {
rules: [
{
type: 'javascript/auto', // prevent webpack handling json with its own loaders,
test: /manifest\.json$/,
use: {
loader: 'wext-manifest-loader',
options: {
usePackageJSONVersion: true,
},
},
exclude: /node_modules/,
},
],
},
};
`

FAQs

$3

Vendor prefixed manifest keys allow you to write one manifest.json for multiple vendors.

`js
{
"__chrome__name": "AwesomeChrome",
"__firefox__name": "AwesomeFirefox",
"__edge__name": "AwesomeEdge",
"__opera__name": "AwesomeOpera"
}
`

if the TARGET_BROWSER is chrome this compiles to:

`js
{
"name": "AwesomeChrome",
}
`

---

Add keys to multiple vendors by seperating them with | in the prefix

`
{
__chrome|opera__name: "AwesomeExtension"
}
`

if the vendor is chrome or opera, this compiles to:

`
{
"name": "AwesomeExtension"
}
`

$3

`js
{
"__dev__name": "NameInDevelopment",
"__prod__name": "NameInProduction",
"__chrome|firefox|dev__description": "DescriptionInDevelopmentForSetOfBrowsers",
"__chrome|firefox|prod__description": "DescriptionInProductionForSetOfBrowsers"
}
`

if the NODE_ENV is production and the TARGET_BROWSER is chrome this compiles to:

`js
{
"name": "NameInProduction",
"description": "DescriptionInProductionForSetOfBrowsers"
}
`

else

`js
{
"name": "NameInDevelopment",
"description": "DescriptionInDevelopmentForSetOfBrowsers"
}
`

Issues

_Looking to contribute? Look for the Good First Issue
label._

$3

Please file an issue here for bugs, missing documentation, or unexpected behavior.

See Bugs

$3

- Shared Eslint & Prettier Configuration - @abhijithvijayan/eslint-config
- Shared TypeScript Configuration - @abhijithvijayan/tsconfig

Credits

Thanks to @fregante for suggesting to convert initial (wext-manifest) module to webpack loader(wext-manifest-loader`)

License

MIT © Abhijith Vijayan