@pumpkin-plugins/docs API / info / PluginInfo

Interface: PluginInfo<Name>

Defined in: tools/docs/src/info.ts:72

What a plugin says about itself. One object feeds both the plugin's Pumpkin metadata and its generated README.

Type Parameters

Name

Name extends string = string

Properties

blocks?

optional blocks?: Readonly<Record<string, string>>

Defined in: tools/docs/src/info.ts:88

More generated README blocks, by name: the markdown goes between <!-- docs:begin NAME --> and <!-- docs:end NAME -->. For content that comes from the plugin's code, such as a list of routers it refuses. A name the README doesn't have markers for is skipped, and the built-in names (summary, permissions, commands, config) are taken.

---

commands?

optional commands?: readonly CommandInfo<`${Name}:${string}`>[]

Defined in: tools/docs/src/info.ts:80

The commands, normally commandInfos(commands) of the tree that registers them.

---

name

name: Name

Defined in: tools/docs/src/info.ts:74

Pumpkin plugin name. Also the data folder name: plugins/data/<name>/.

---

permissions?

optional permissions?: readonly PermissionInfo<PumpkinPermission>[]

Defined in: tools/docs/src/info.ts:78

The Pumpkin permissions the plugin asks for.