Skip to content

Commit

Permalink
fix: Update exports to expose create functions (#252)
Browse files Browse the repository at this point in the history
  • Loading branch information
Jason3S committed Mar 2, 2024
1 parent 349aa32 commit 110b979
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 8 deletions.
16 changes: 16 additions & 0 deletions README.md
Expand Up @@ -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`**
Expand Down
11 changes: 9 additions & 2 deletions src/index.ts
Expand Up @@ -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';
14 changes: 8 additions & 6 deletions 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,
Expand All @@ -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';

0 comments on commit 110b979

Please sign in to comment.