diff --git a/README.md b/README.md index 3930e92..3fb5380 100644 --- a/README.md +++ b/README.md @@ -198,6 +198,22 @@ Here are a few of items that have been implemented. Most of them are based upon - workspace - WorkspaceEdit +## Migrating from 2.x to 3.x + +Migration is only necessary if you used any of the following: + +```js +new MockWorkspace(...) +new MockTabGroups(...) +new MockTextEditor(...) +``` + +It is now necessary to use a create function. + +- `new MockWorkspace(...)` -> `createWorkspace(...)` +- `new MockTabGroups(...)` -> `createMockTabGroups(...)` +- `new MockTextEditor(...)` -> `createMockTextEditor(...)` + ## Migrating from 1.x to 2.x **`__mocks__/vscode.js`** diff --git a/src/index.ts b/src/index.ts index 2f45b0e..9c1c2ff 100644 --- a/src/index.ts +++ b/src/index.ts @@ -4,11 +4,18 @@ export { createLanguages, createMockFileSystem, createMockFileSystemProvider, - createMockWorkspaceConfiguration, + createMockTabGroups, createMockTextEditor, + createMockWorkspaceConfiguration, createWindow, createWorkspace, } from './vscode'; -export type { MockWorkspaceConfigurationData } from './vscode'; +export type { + MockTabGroups, + MockTextDocument, + MockTextEditor, + MockWorkspace, + MockWorkspaceConfigurationData, +} from './vscode'; export { createVSCodeMock } from './vscode-mock'; export { createTextDocument, readTextDocument } from './vscodeTypesHelper'; diff --git a/src/vscode/index.ts b/src/vscode/index.ts index 95deb89..a0f00c5 100644 --- a/src/vscode/index.ts +++ b/src/vscode/index.ts @@ -1,7 +1,12 @@ export * from './CodeAction'; export { FileSystemError } from './FileSystemError'; export * from './MarkdownString'; +export { createMockTabGroups } from './TabGroups'; +export type { MockTabGroups } from './TabGroups'; export * from './TextDocument'; +export { createMockTextEditor } from './TextEditor'; +export type { MockTextEditor } from './TextEditor'; +export { TypeHierarchyItem } from './TypeHierarchyItem'; export { MockWorkspaceConfiguration, MockWorkspaceConfigurationData, @@ -11,11 +16,8 @@ export { export * from './baseTypes'; export * from './extHostTypes'; export { createMockFileSystem, createMockFileSystemProvider } from './fs'; +export { Languages, createLanguages } from './languages'; export * from './uri'; +export { createWindow } from './window'; +export type { Window } from './window'; export { MockWorkspace, Workspace, createWorkspace } from './workspace'; - -export type { MockTextEditor } from './TextEditor'; -export { createMockTextEditor } from './TextEditor'; -export { TypeHierarchyItem } from './TypeHierarchyItem'; -export { Languages, createLanguages } from './languages'; -export { Window, createWindow } from './window';