@bufbuild/protoplugin/dist/esm/parameter.d.ts

Helps to create your own Protocol Buffers code generators.

import type { RewriteImports } from "./import-path.js";
/**
 * Represents possible values of the plugin option `target`.
 */
export type Target = "js" | "ts" | "dts";
/**
 * Possible values of the plugin option `import_extension`.
 */
export type ImportExtension = "none" | "js" | "ts";
/**
 * Standard plugin options that every ECMAScript plugin supports.
 */
export interface EcmaScriptPluginOptions {
    /**
     * Controls whether the plugin generates JavaScript, TypeScript,
     * or TypeScript declaration files.
     *
     * The default is ["js", "dts].
     */
    targets: Target[];
    /**
     * Add an extension to every import: "js" or "ts".
     *
     * The default is "none".
     */
    importExtension: ImportExtension;
    /**
     * Generate `import` statements or `require()` calls.
     *
     * The default is "module".
     */
    jsImportStyle: "module" | "legacy_commonjs";
    /**
     * Generate an annotation at the top of each file to skip type checks:
     * `// @ts-nocheck`.
     *
     * The default is false.
     */
    tsNocheck: boolean;
    /**
     * Prune empty files from the output.
     *
     * The default is false.
     */
    keepEmptyFiles: boolean;
    /**
     * @private
     */
    bootstrapWkt: boolean;
    /**
     * @private
     */
    rewriteImports: RewriteImports;
}
export interface ParsedParameter<T> {
    parsed: T & EcmaScriptPluginOptions;
    sanitized: string;
}
/**
 * Raw options to parse.
 *
 * For example, if a plugin is run with the options foo=123,bar,baz=a,baz=b
 * the raw options are:
 *
 * ```ts
 * [
 *   { key: "foo", value: "123" },
 *   { key: "bar", value: "" },
 *   { key: "baz", value: "a" },
 *   { key: "baz", value: "b" },
 * ]
 * ```
 *
 * If your plugin does not recognize an option, it must throw an Error in
 * parseOptions.
 */
export type RawPluginOptions = {
    key: string;
    value: string;
}[];
export declare function parseParameter<T extends object>(parameter: string, parseExtraOptions: ((rawOptions: RawPluginOptions) => T) | undefined): ParsedParameter<T>;