Skip to content

craft-hub / LocalPlugin

Interface: LocalPlugin ​

Defined in: packages/craft-hub/src/marketplace.ts:289

A plugin loaded directly from a local package directory.

Extends ​

Properties ​

enabled ​

enabled: boolean

Defined in: packages/craft-hub/src/marketplace.ts:280

Inherited from ​

InstalledPlugin.enabled


error? ​

optional error?: string

Defined in: packages/craft-hub/src/marketplace.ts:285

Inherited from ​

InstalledPlugin.error


installedAt ​

installedAt: string

Defined in: packages/craft-hub/src/marketplace.ts:279

Inherited from ​

InstalledPlugin.installedAt


integrity? ​

optional integrity?: string

Defined in: packages/craft-hub/src/marketplace.ts:278

Inherited from ​

InstalledPlugin.integrity


linkedAt ​

linkedAt: string

Defined in: packages/craft-hub/src/marketplace.ts:292


manifest ​

manifest: object

Defined in: packages/craft-hub/src/marketplace.ts:282

contributes ​

contributes: object

contributes.commandPresets ​

commandPresets: object[]

contributes.commands ​

commands: object[]

contributes.commandTemplates ​

commandTemplates: object[]

contributes.integrations ​

integrations: object[]

contributes.navigationPanels ​

navigationPanels: object[]

packageLinks: object[]

contributes.packageQuickActions ​

packageQuickActions: object[]

contributes.packageToolGroups ​

packageToolGroups: object[]

contributes.projectTemplates ​

projectTemplates: object[]

contributes.skills ​

skills: object[]

contributes.workbenches ​

workbenches: object[]

craftHub ​

craftHub: object

craftHub.minVersion? ​

optional minVersion?: string

description? ​

optional description?: string

displayName ​

displayName: string

icon? ​

optional icon?: string

id ​

id: string

includesPlugins ​

includesPlugins: object[]

optional links?: object

optional documentation?: string

optional feedback?: string

optional homepage?: string

optional repository?: string

localizations? ​

optional localizations?: Record<string, { description?: string; displayName?: string; permissionReasons?: Record<string, string>; }>

maintainers? ​

optional maintainers?: object[]

permissionReasons? ​

optional permissionReasons?: Record<string, string>

permissions ​

permissions: ("local-read" | "local-write" | "remote-read" | "remote-write" | "commands" | "command-presets" | "read-project-files" | "read-user-settings")[]

projectFiles ​

projectFiles: string[]

requiresPlugins ​

requiresPlugins: object[]

schemaVersion ​

schemaVersion: 1

slug? ​

optional slug?: string

Inherited from ​

InstalledPlugin.manifest


origin ​

origin: "local"

Defined in: packages/craft-hub/src/marketplace.ts:291

Overrides ​

InstalledPlugin.origin


package ​

package: string

Defined in: packages/craft-hub/src/marketplace.ts:274

Inherited from ​

InstalledPlugin.package


packagePath ​

packagePath: string

Defined in: packages/craft-hub/src/marketplace.ts:281

Inherited from ​

InstalledPlugin.packagePath


previousVersion? ​

optional previousVersion?: string

Defined in: packages/craft-hub/src/marketplace.ts:284

Inherited from ​

InstalledPlugin.previousVersion


registry? ​

optional registry?: string

Defined in: packages/craft-hub/src/marketplace.ts:277

Inherited from ​

InstalledPlugin.registry


sourceId ​

sourceId: "local"

Defined in: packages/craft-hub/src/marketplace.ts:290

Overrides ​

InstalledPlugin.sourceId


version ​

version: string

Defined in: packages/craft-hub/src/marketplace.ts:275

Inherited from ​

InstalledPlugin.version

Released under the MIT License.