Skip to content
popii

PopiiPluginMeta

Popii

Popii / PopiiPluginMeta

Interface: PopiiPluginMeta

Section titled “Interface: PopiiPluginMeta”

Defined in: types.ts:485

Metadata exported by community plugins for marketplace discovery. Place this in the "popii" field of your plugin’s package.json.

Properties

Section titled “Properties”

displayName

Section titled “displayName”

displayName: string

Defined in: types.ts:486

description

Section titled “description”

description: string

Defined in: types.ts:487

category?

Section titled “category?”

optional category?: "core" | "features" | "integrations" | "utilities" | "ui"

Defined in: types.ts:488

keywords?

Section titled “keywords?”

optional keywords?: string[]

Defined in: types.ts:489

export?

Section titled “export?”

optional export?: string

Defined in: types.ts:491

Named export of the plugin factory function. Defaults to "default".

requires?

Section titled “requires?”

optional requires?: string[]

Defined in: types.ts:492

conflicts?

Section titled “conflicts?”

optional conflicts?: string[]

Defined in: types.ts:493

configSchema?

Section titled “configSchema?”

optional configSchema?: Record<string, PopiiPluginConfigField>

Defined in: types.ts:494

init?

Section titled “init?”

optional init?: object

Defined in: types.ts:496

Optional scaffolding metadata used by popii init and dashboard onboarding.

onboardingPath?

Section titled “onboardingPath?”

optional onboardingPath?: string

optionalDependencies?

Section titled “optionalDependencies?”

optional optionalDependencies?: Record<string, string>

environment?

Section titled “environment?”

optional environment?: object[]

pendingSetup?

Section titled “pendingSetup?”

optional pendingSetup?: string[]

codeDriven?

Section titled “codeDriven?”

optional codeDriven?: boolean