vite-plugin-wext-manifest
Vite Plugin for Webextension manifest
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](https://github.com/abhijithvijayan/vite-plugin-wext-manifest/stargazers) or [Tweet](https://twitter.com/intent/tweet?text=Check%20out%20vite-plugin-wext-manifest%21%20by%20%40_abhijithv%0A%0AVite%20Plugin%20for%20Webextension%20manifest%0Ahttps%3A%2F%2Fgithub.com%2Fabhijithvijayan%2Fvite-plugin-wext-manifest%0A%0A%23vite%20%23plugin%20%23manifest%20%23javascript%20%23webextensions%20) about it.
## Table of Contents
- [Browser Support](#browser-support)
- [Installation](#installation)
- [Usage](#usage)
- [FAQs](#faqs)
- [Issues](#issues)
- [🐛 Bugs](#-bugs)
- [LICENSE](#license)
## Browser Support
| [](/) | [](/) | [](/) | [](/) |
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ✔ | ✔ | ✔ | ✔ |
This loader will take a definition input for the manifest, and return you content for the specified browser.
### Looking for Web Extension starter
Checkout [web-extension-starter](https://github.com/abhijithvijayan/web-extension-starter) that uses this package
## Installation
Ensure you have [Node.js](https://nodejs.org) 18 or later installed. Then run the following:
```sh
# via npm
npm install --save-dev vite-plugin-wext-manifest
# or yarn
yarn add vite-plugin-wext-manifest --dev
```
## Usage
You can easily use this module to output the `manifest.json` as part of your build process with auto rebundling on file change.
**Note:** Make sure you pass a **TARGET_BROWSER** env variable with one of `chrome/firefox/edge/brave/opera/vivaldi/arc/yandex` value
#### Sample manifest with vendor prefixed keys
> **vite.config.ts**
```js
// ... other plugins
import vitePluginWextManifest from "./vite-plugin-wext-manifest";
export default defineConfig(({ mode }) => {
const sourcePath = path.resolve(__dirname, "source");
return {
root: sourcePath,
plugins: [
vitePluginWextManifest({
manifestPath: "manifest.json",
usePackageJSONVersion: true,
}),
// ...
],
}
});
```
## Options
### `manifestPath`
Type: `String`
Path to the manifest.json to transform.
### `usePackageJSONVersion`
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.
## FAQs
### 1.What are vendor prefixed manifest keys
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"
}
```
### 2. How can I conditionally set keys based on environment
```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](https://github.com/abhijithvijayan/vite-plugin-wext-manifest/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22)
label._
### 🐛 Bugs
Please file an issue [here](https://github.com/abhijithvijayan/vite-plugin-wext-manifest/issues/new) for bugs, missing documentation, or unexpected behavior.
[**See Bugs**](https://github.com/abhijithvijayan/vite-plugin-wext-manifest/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22type%3A+bug%22)
### Linting & TypeScript Config
- Shared Eslint & Prettier Configuration - [`@abhijithvijayan/eslint-config`](https://www.npmjs.com/package/@abhijithvijayan/eslint-config)
- Shared TypeScript Configuration - [`@abhijithvijayan/tsconfig`](https://www.npmjs.com/package/@abhijithvijayan/tsconfig)
## License
MIT © [Abhijith Vijayan](https://abhijithvijayan.in)
