parse

function parse(
   file,
   filepath,
   root,
   config,
data): Promise<string>;

Defined in: core/auto-readme/src/pipeline.ts:17

Parameters

file

string

filepath

string

root

string

config

Config

data

( | { action: "ACTION"; actionYaml: ActionYaml; body?: undefined; catalogs?: undefined; isPnpm?: undefined; parameters: string[]; pkgJson?: undefined; root?: undefined; workspaces?: undefined; } | { action: "PKG" | "BADGE"; actionYaml?: undefined; body?: undefined; catalogs: { catalogs: undefined | Record<string, Catalog>; default: undefined | Catalog; }; isPnpm?: undefined; parameters: string[]; pkgJson: PackageJson; root?: undefined; workspaces?: undefined; } | { action: "USAGE"; actionYaml?: undefined; body?: undefined; catalogs?: undefined; isPnpm?: undefined; parameters: string[]; pkgJson?: undefined; root?: undefined; workspaces?: undefined; } | { action: "WORKSPACE"; actionYaml?: undefined; body?: undefined; catalogs?: undefined; isPnpm: boolean; parameters: string[]; pkgJson?: undefined; root: string; workspaces: Packages; } | { action: "ZOD"; actionYaml?: undefined; body: string; catalogs?: undefined; isPnpm?: undefined; parameters: string[]; pkgJson?: undefined; root?: undefined; workspaces?: undefined; })[]

Returns

Promise<string>