Skip to content

craft-hub / WorkspaceImportService

Class: WorkspaceImportService

Defined in: packages/craft-hub/src/workspace-import.ts:28

Convert external workspace documents into user-owned Craft Hub workspaces.

Constructors

Constructor

new WorkspaceImportService(projects, workspaces): WorkspaceImportService

Defined in: packages/craft-hub/src/workspace-import.ts:29

Parameters

projects

ProjectRegistry

workspaces

WorkspaceService

Returns

WorkspaceImportService

Methods

importVscodeDirectory()

importVscodeDirectory(inputDirectory, groupName, expectedRevision, ownerScopeId?): Promise<WorkspaceImportResult>

Defined in: packages/craft-hub/src/workspace-import.ts:96

Import each top-level .code-workspace file once after validating the exact preview revision.

Parameters

inputDirectory

string

groupName

string | undefined

expectedRevision

string

ownerScopeId?

string = PERSONAL_OWNER_SCOPE_ID

Returns

Promise<WorkspaceImportResult>


previewVscodeDirectory()

previewVscodeDirectory(inputDirectory, groupName?, ownerScopeId?): Promise<WorkspaceImportPreview>

Defined in: packages/craft-hub/src/workspace-import.ts:35

Validate a one-time VS Code workspace import without changing Craft Hub state.

Parameters

inputDirectory

string

groupName?

string

ownerScopeId?

string = PERSONAL_OWNER_SCOPE_ID

Returns

Promise<WorkspaceImportPreview>

Released under the MIT License.