Manifest and locales API
Manifest generation, validation, locale parsing, and target metadata.
#buildManifest
#function buildManifest(
baseManifest: ManifestInput,
browser: ResolvedBrowser,
options?: BuildManifestOptions,
): BuiltManifest;
interface BuildManifestOptions {
outdir?: string;
checkFiles?: boolean;
availableFiles?: Iterable<string>;
mode?: 'development' | 'production';
command?: string;
defaults?: ManifestDefaults;
entrypoints?: readonly ResolvedEntrypoint[];
convertManifest?: boolean;
iconDir?: string;
contentScriptCss?: ReadonlyMap<string, readonly string[]>;
locales?: LocaleCollection;
}
interface BuiltManifest {
manifest: Record<string, unknown>;
diagnostics: readonly Diagnostic[];
hasErrors: boolean;
}
Generates entrypoint fields, applies defaults and icons, converts versions, and
validates. When checkFiles is true, pass either outdir or availableFiles.
resolveManifestObject
#function resolveManifestObject(
input: ManifestInput,
browser: ResolvedBrowser,
options?: BuildManifestOptions,
): Record<string, unknown>;
Resolves a static manifest or calls a manifest function with browser, manifest version, mode, and command.
writeManifest
#function writeManifest(
outdir: string,
manifest: Readonly<Record<string, unknown>>,
): string;
Writes formatted manifest.json and returns its path.
collectLocales
#function collectLocales(options: CollectLocalesOptions): LocaleCollection;
interface CollectLocalesOptions {
root: string;
srcDir: string;
publicDir: string;
defaultLocale?: string;
}
Reads public/_locales and src/<srcDir>/_locales, normalizing flat and standard
layouts.
validateManifestLocales
#function validateManifestLocales(
manifest: Readonly<Record<string, unknown>>,
collection?: LocaleCollection,
): readonly Diagnostic[];
Checks default_locale, locale codes, and __MSG_*__ references.
collectManifestMessageReferences
#function collectManifestMessageReferences(
manifest: Readonly<Record<string, unknown>>,
): readonly ManifestMessageReference[];
Returns every __MSG_key__ occurrence with field, key, and token.
parseI18nMessages and parseMessagesJson
#function parseI18nMessages(
source: string,
file: string,
severity?: DiagnosticSeverity,
): LocaleParseResult;
function parseMessagesJson(
source: string,
file: string,
severity?: DiagnosticSeverity,
): LocaleParseResult;
Parse Chrome .i18n or JSON messages. Default severity is warning.
formatLocaleMessages
#function formatLocaleMessages(messages: LocaleMessages): string;
Serializes messages as JSON with a trailing newline.
isValidLocaleCode
#function isValidLocaleCode(locale: string): boolean;
Accepts forms such as en, en-US, and zh_CN.
Targets
#const BROWSER_TARGET_INFO: Record<BrowserTarget, BrowserTargetInfo>;
function getBrowserTargetInfo(target: BrowserTarget): BrowserTargetInfo;
function supportsManifestVersion(target: BrowserTarget, version: ManifestVersion): boolean;
interface BrowserTargetInfo {
target: BrowserTarget;
displayName: string;
defaultManifestVersion: 2 | 3;
supportedManifestVersions: readonly (2 | 3)[];
deprecatedManifestVersions: readonly (2 | 3)[];
supportsBrowserSpecificSettings: boolean;
supportsSidebarAction: boolean;
}
Browser API integration
#const BROWSER_API_SUBPATHS: readonly string[];
function assertBrowserApiInstalled(root: string, config: ResolvedBrowserApiConfig): void;
function getBrowserApiBundlerSettings(
root: string,
config: ResolvedBrowserApiConfig,
): BrowserApiBundlerSettings;