Skip to content
Simply SF logoSimply SF logoSimply Plugins Core

getPluginConfig

getPluginConfig<T>(source, keyPath): T | undefined

Defined in: packages/simply-core/src/project/sfdxProject.ts:120

Read a value out of sfdx-project.json by dot-delimited path, without casting through the intervening objects.

sfdx-project.json is the conventional home for per-plugin settings, nested under plugins.<name>, and reading one means walking several optional levels that may each be absent in a valid project file.

Type Parameters

Section titled “Type Parameters”

T

Section titled “T”

T

Parameters

Section titled “Parameters”

source

Section titled “source”

Record<string, unknown>

The parsed project manifest, or any object to walk.

keyPath

Section titled “keyPath”

string

Dot-delimited path, e.g. plugins.simply.dependencies.ignore.

Returns

Section titled “Returns”

T | undefined

The value at keyPath, or undefined if any segment along the way is missing or isn’t an object. The return type is unchecked — the caller asserts what it expects to find.