This is a Plasmo extension project bootstrapped with plasmo init.

Why you would want to use this example

This is an example which shows you how to run tests on the client side, using Tape, which can be used monitor the DOM your extension interacts with or any changes to intercepted fetch requests amongst many other potential usecases, to let you know about any changes that might break your extension.

This mainly helps to solve the problem of gradual rollouts from sites which may slowly roll out changes, which may break your extension and you may not be aware of the changes or be able to reproduce them locally.

Getting Started

First, run the development server:

pnpm dev
# or
npm run dev

Open your browser and load the appropriate development build. For example, if you are developing for the chrome browser, using manifest v3, use: build/chrome-mv3-dev.

You can start editing the popup by modifying popup.tsx. It should auto-update as you make changes. To add an options page, simply add a options.tsx file to the root of the project, with a react component default exported. Likewise to add a content page, add a content.ts file to the root of the project, importing some module and do some logic, then reload the extension on your browser.

For further guidance, visit our Documentation

Making production build

Run the following:

pnpm build
# or
npm run build

This should create a production bundle for your extension, ready to be zipped and published to the stores.

Submit to the webstores

The easiest way to deploy your Plasmo extension is to use the built-in bpp GitHub action. Prior to using this action however, make sure to build your extension and upload the first version to the store to establish the basic credentials. Then, simply follow this setup instruction and you should be on your way for automated submission!