web-ext-option-types

Type definitions for the web-ext CLI options.

This package is updated automatically when a new web-ext version is released, using a custom script that parses the source code of web-ext, extracts the CLI options from the AST, and emits a .d.ts file. This script periodically runs within a GitHub Actions workflow.

Usage

import { RunOptions } from 'web-ext-cli-options'

const options: RunOptions = {
  target: ['firefox-desktop', 'chromium'],
  firefoxBinary: '/path/to/firefox',
  chromiumBinary: '/path/to/chromium',
}

// Do something with the options…

The following types are included:

RunOptions for web-ext run (Learn more)
BuildOptions for web-ext build (Learn more)
SignOptions for web-ext sign (Learn more)

Contributing

Generating the types

pnpm install
pnpm build
node dist/web-ext-types.js generate 8.3.0 -o index.d.ts

Releasing a new version

The release script will:

Generate the types for the latest version of web-ext
Bump the version in package.json
Commit the changes
Except when --dry-run is passed:
- Push the changes
- Publish to npm

pnpm run release