craft-hub / PluginCommandContributions

Interface: PluginCommandContributions

Defined in: packages/craft-hub/src/command-contributions.ts:53

One installed plugin's declarative command contributions.

Properties

pluginId

pluginId: string

Defined in: packages/craft-hub/src/command-contributions.ts:54

---

presets

presets: object[]

Defined in: packages/craft-hub/src/command-contributions.ts:56

commands

commands: string[]

id

id: string

inputs

inputs: Record<string, { argumentStyle?: "equals" | "separate"; default?: string; description?: string | {[key: string]: string; default: string; }; flag: string; label?: string | {[key: string]: string; default: string; }; options: (string | { arguments?: string[]; label?: string | {[key: string]: string; default: string; }; omitArgument?: boolean; value: string; })[]; pattern?: string; private?: boolean; redactInHistory?: boolean; required?: boolean; requiredWhen?: { equals: string; input: string; } | object[]; type: "select"; visibleWhen?: { equals: string; input: string; } | object[]; } | { argumentStyle?: "equals" | "separate"; default?: string; description?: string | {[key: string]: string; default: string; }; flag: string; label?: string | {[key: string]: string; default: string; }; options?: undefined; pattern?: string; private?: boolean; redactInHistory?: boolean; required?: boolean; requiredWhen?: { equals: string; input: string; } | object[]; type: "text"; visibleWhen?: { equals: string; input: string; } | object[]; } | { argumentStyle?: undefined; default?: "true" | "false"; description?: string | {[key: string]: string; default: string; }; flag: string; label?: string | {[key: string]: string; default: string; }; options?: undefined; pattern?: undefined; private?: boolean; redactInHistory?: boolean; required?: boolean; requiredWhen?: { equals: string; input: string; } | object[]; type: "boolean"; visibleWhen?: { equals: string; input: string; } | object[]; }>

package

package: object = commandPackageMatcherSchema

package.allFiles

allFiles: string[]

package.anyFiles

anyFiles: string[]

unlessCommands

unlessCommands: string[]

---

source

source: string

Defined in: packages/craft-hub/src/command-contributions.ts:55

---

templates

templates: object[]

Defined in: packages/craft-hub/src/command-contributions.ts:57

args

args: string[]

category?

optional category?: "build" | "preview" | "test" | "deploy" | "develop" | "other" | "quality"

command

command: string

description?

optional description?: string

id

id: string

inputPreset?

optional inputPreset?: string

inputs

inputs: Record<string, { argumentStyle?: "equals" | "separate"; default?: string; description?: string | {[key: string]: string; default: string; }; flag: string; label?: string | {[key: string]: string; default: string; }; options: (string | { arguments?: string[]; label?: string | {[key: string]: string; default: string; }; omitArgument?: boolean; value: string; })[]; pattern?: string; private?: boolean; redactInHistory?: boolean; required?: boolean; requiredWhen?: { equals: string; input: string; } | object[]; type: "select"; visibleWhen?: { equals: string; input: string; } | object[]; } | { argumentStyle?: "equals" | "separate"; default?: string; description?: string | {[key: string]: string; default: string; }; flag: string; label?: string | {[key: string]: string; default: string; }; options?: undefined; pattern?: string; private?: boolean; redactInHistory?: boolean; required?: boolean; requiredWhen?: { equals: string; input: string; } | object[]; type: "text"; visibleWhen?: { equals: string; input: string; } | object[]; } | { argumentStyle?: undefined; default?: "true" | "false"; description?: string | {[key: string]: string; default: string; }; flag: string; label?: string | {[key: string]: string; default: string; }; options?: undefined; pattern?: undefined; private?: boolean; redactInHistory?: boolean; required?: boolean; requiredWhen?: { equals: string; input: string; } | object[]; type: "boolean"; visibleWhen?: { equals: string; input: string; } | object[]; }>

name

name: string

package

package: object = commandPackageMatcherSchema

package.allFiles

allFiles: string[]

package.anyFiles

anyFiles: string[]

requiredEnv

requiredEnv: string[]

unlessCommands

unlessCommands: string[]