RFC: Official CRXJS Plugin API

[jacksteamdev]

CRXJS plugins are possible, in fact, CRXJS is a collection of plugins with special hooks.

RFC

What use cases do you have for CRXJS plugins? How could we improve the API design in an official plugin API?

Unofficial plugin instructions

Plugins are not documented yet, as I haven't yet finalized a public plugin API. You can look at the types here.

1. (optional) Use type CrxPlugin from @crxjs/vite-plugin
2. (required) Prefix the plugin name with crx: so CRXJS uses the CRXJS hooks
3. Use transformCrxManifest or renderCrxManifest hooks to modify the manifest

• transformCrxManifest modifies the input manifest at the beginning of the transform hook
• renderCrxManifest modifies the output manifest at the end of the generateBundle hook

You can add a CRXJS hook to a plugin like this:

export const renameFile = (source, destination): CrxPlugin => {
  if (typeof source !== 'string' || typeof destination !== 'string') {
    return
  }

  return {
    name: 'crx:rename-file',
    enforce: 'post',
    generateBundle(options, bundle) {
      bundle[source].fileName = destination;
    },
    renderCrxManifest(manifest) {
      manifest.short_name = "with renamed files";
      return manifest;
    },
  }
};