Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Update exports to expose create functions #252

Merged
merged 1 commit into from Mar 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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';