analyzeWorkspace

function analyzeWorkspace(
   config,
   rootDir,
outputDirOverride?): Promise<WorkspaceAnalysisResult>;

Defined in: packages/analyzer/src/workspace/workspace-orchestrator.ts:36

Parameters

Parameter	Type
config	{ defaults?: { allowPartial?: boolean; componentLayout?: "flat" | "auto" | "directory-per-component"; prefix?: string; }; libraries?: { componentLayout?: "flat" | "auto" | "directory-per-component"; docs?: string; framework?: "angular" | "react"; importAlias?: string; importPrefix?: string; name?: string; path: string; prefix?: string; storybook?: string; }[]; outputDir?: string; scan?: { dir: string; exclude?: string[]; }[]; }
config.defaults?	{ allowPartial?: boolean; componentLayout?: "flat" | "auto" | "directory-per-component"; prefix?: string; }
config.defaults.allowPartial?	boolean
config.defaults.componentLayout?	"flat" | "auto" | "directory-per-component"
config.defaults.prefix?	string
config.libraries?	{ componentLayout?: "flat" | "auto" | "directory-per-component"; docs?: string; framework?: "angular" | "react"; importAlias?: string; importPrefix?: string; name?: string; path: string; prefix?: string; storybook?: string; }[]
config.outputDir?	string
config.scan?	{ dir: string; exclude?: string[]; }[]
rootDir?	string
outputDirOverride?	string

Returns

Promise<WorkspaceAnalysisResult>