UNPKG

@report-toolkit/cli

Version:

See docs at [https://ibm.github.io/report-toolkit](https://ibm.github.io/report-toolkit)

111 lines (110 loc) 3.54 kB
/** * * @param {string[]|string} filepaths * @param {Partial<import('@report-toolkit/core/src/observable').ToReportFromObjectOptions>} opts */ export function fromFilepathsToReports(filepaths: string[] | string, opts?: Partial<import('@report-toolkit/core/src/observable').ToReportFromObjectOptions>): observable.Observable<Readonly<import("../../../diff/node_modules/@report-toolkit/common/src/report.js").Report>>; export namespace GROUPS { export const FILTER: string; export const FILTER_TRANSFORM: string; export const JSON_TRANSFORM: string; export const OUTPUT: string; export const TABLE_TRANSFORM: string; } export namespace OPTIONS { export namespace FILTER_TRANSFORM_1 { export const exclude: { coerce: <T>(value: import("lodash").Many<T>) => T[]; /** @type {string[]} */ default: string[]; description: string; group: string; nargs: number; type: string; }; export const include: { coerce: <T>(value: import("lodash").Many<T>) => T[]; /** @type {string[]} */ default: string[]; description: string; group: string; nargs: number; type: string; }; } export { FILTER_TRANSFORM_1 as FILTER_TRANSFORM }; export namespace JSON_TRANSFORM_1 { export const pretty: { description: string; group: string; type: string; }; } export { JSON_TRANSFORM_1 as JSON_TRANSFORM }; const OUTPUT_1: { output: { alias: string; description: string; group: string; normalize: boolean; requiresArg: boolean; type: string; }; 'show-secrets-unsafe': { description: string; group: string; type: string; }; }; export { OUTPUT_1 as OUTPUT }; const TABLE_TRANSFORM_1: { 'max-width': { default: number; defaultDescription: string; description: string; group: string; type: string; }; truncate: { default: boolean; description: string; group: string; type: string; }; }; export { TABLE_TRANSFORM_1 as TABLE_TRANSFORM }; export const TRANSFORM: { alias: string; choices: readonly string[]; coerce: <T>(value: import("lodash").Many<T>) => T[]; default: string; description: string; group: string; nargs: number; type: string; }; } export function getTransformerOptions({ sourceType, defaultTransformer, omit, extra }?: Partial<GetTransformerOptionsOptions>): any; export function mergeCommandConfig(commandName: string, argv?: object, defaultConfig?: object): object; /** * Yes, yes, I know. */ export type GetTransformerOptionsOptions = { /** * - Whether the transformer source is a report or an object */ sourceType: 'report' | 'object'; /** * - Name of default transformer */ defaultTransformer: string; /** * - Merge these into the result; use this to override specific values (e.g., default behavior of a transformer) */ extra: object; /** * - List of transformers to explicitly omit, if any */ omit: string[]; }; import { observable } from "../../../diff/node_modules/@report-toolkit/common/src/index.js";