craft-hub / PluginCommandContributions

Interface: PluginCommandContributions

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

One installed plugin's declarative command contributions.

Properties

packageLinks?

optional packageLinks?: object[]

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

description?

optional description?: string | {[key: string]: string; default: string; }

id

id: string

package

package: object = commandPackageMatcherSchema

package.allFiles

allFiles: string[]

package.anyFiles

anyFiles: string[]

title

title: string | {[key: string]: string; default: string; } = contributionLocalizedTextSchema

toolGroup?

optional toolGroup?: string

urlTemplate

urlTemplate: string = secureUrlTemplateSchema

value

value: object

value.files

files: string[]

value.key

key: string

---

packageQuickActions?

optional packageQuickActions?: object[]

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

capabilities

capabilities: string[]

id

id: string

package

package: object = commandPackageMatcherSchema

package.allFiles

allFiles: string[]

package.anyFiles

anyFiles: string[]

---

packageToolGroups?

optional packageToolGroups?: object[]

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

description?

optional description?: string | {[key: string]: string; default: string; }

id

id: string

package

package: object = commandPackageMatcherSchema

package.allFiles

allFiles: string[]

package.anyFiles

anyFiles: string[]

title

title: string | {[key: string]: string; default: string; } = contributionLocalizedTextSchema

---

pluginId

pluginId: string

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

---

presets

presets: object[]

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

applyToCommands

applyToCommands: boolean

Whether this reusable preset also enhances matching repository-owned commands.

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[]; icon?: 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: "positional"; default?: string; description?: string | {[key: string]: string; default: string; }; flag?: undefined; label?: string | {[key: string]: string; default: string; }; options: (string | { arguments?: string[]; icon?: 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: "positional"; default?: string; description?: string | {[key: string]: string; default: string; }; flag?: undefined; 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; }; omitArgument?: false; options?: undefined; pattern?: undefined; private?: boolean; redactInHistory?: boolean; required?: boolean; requiredWhen?: { equals: string; input: string; } | object[]; type: "boolean"; visibleWhen?: { equals: string; input: string; } | object[]; } | { argumentStyle?: undefined; default?: "true" | "false"; description?: string | {[key: string]: string; default: string; }; flag?: undefined; label?: string | {[key: string]: string; default: string; }; omitArgument: true; options?: undefined; pattern?: undefined; private?: boolean; redactInHistory?: boolean; required?: boolean; requiredWhen?: { equals: string; input: string; } | object[]; type: "boolean"; visibleWhen?: { equals: string; input: string; } | object[]; }>

optionSources

optionSources: Record<string, { files: string[]; labelKey?: string; path: string[]; type: "package-json-array"; valueKey?: string; } | { key: string; type: "user-setting"; }>

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:142

---

templates

templates: object[]

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

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[]; icon?: 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: "positional"; default?: string; description?: string | {[key: string]: string; default: string; }; flag?: undefined; label?: string | {[key: string]: string; default: string; }; options: (string | { arguments?: string[]; icon?: 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: "positional"; default?: string; description?: string | {[key: string]: string; default: string; }; flag?: undefined; 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; }; omitArgument?: false; options?: undefined; pattern?: undefined; private?: boolean; redactInHistory?: boolean; required?: boolean; requiredWhen?: { equals: string; input: string; } | object[]; type: "boolean"; visibleWhen?: { equals: string; input: string; } | object[]; } | { argumentStyle?: undefined; default?: "true" | "false"; description?: string | {[key: string]: string; default: string; }; flag?: undefined; label?: string | {[key: string]: string; default: string; }; omitArgument: true; 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[]

prerequisites

prerequisites: object[]

requiredEnv

requiredEnv: string[]

toolGroup?

optional toolGroup?: string

unlessCommands

unlessCommands: string[]