Added wiki pages to the repo (#948)

.github/workflows/publish-wiki.yml

@@ -0,0 +1,21 @@
+name: Publish wiki
+on:
+  push:
+    branches: [ main ]
+    paths:
+      - wiki/**
+      - .github/workflows/publish-wiki.yml
+
+concurrency:
+  group: publish-wiki
+  cancel-in-progress: true
+
+permissions:
+  contents: write
+
+jobs:
+  publish-wiki:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: Andrew-Chen-Wang/github-wiki-action@v4

wiki/ActionsControl.md

@@ -0,0 +1,28 @@
+![actionControl](https://user-images.githubusercontent.com/4181232/56589258-27bb1900-65e5-11e9-9aef-7643f44697f4.png)
+
+#### Look up the ActionsControl by title
+Import and find the control through activity bar 
+```typescript
+import { ActivityBar, ActionsControl } from 'vscode-extension-tester';
+...
+// get actions control for 'Manage'
+const control: ActionsControl = new ActivityBar().getGlobalAction('Manage');
+```
+
+#### Open action menu
+Click the action control to open its context menu
+```typescript
+const menu = await control.openActionMenu();
+```
+
+#### Get title
+Get the control's title
+```typescript
+const title = control.getTitle();
+```
+
+#### Open context menu
+Left click on the control to open the context menu (in this case has the same effect as openActionMenu)
+```typescript
+const menu = await control.openContextMenu();
+```

wiki/ActivityBar.md

@@ -0,0 +1,40 @@
+![activityBar](https://user-images.githubusercontent.com/4181232/56586855-c133fc00-65e0-11e9-9317-158d7fcedd43.png)
+
+#### Look up the Activity Bar
+Import and find the activity bar 
+```typescript
+import { ActivityBar } from 'vscode-extension-tester';
+...
+const activityBar = new ActivityBar();
+```
+
+#### Get view controls
+Get handles for all view controls/buttons that operate the view containers
+```typescript
+const controls = await activityBar.getViewControls();
+```
+
+#### Get view control by title
+Find a view control/button in the activity bar by its title
+```typescript
+// get Explorer view control
+const controls = await activityBar.getViewControl('Explorer');
+```
+
+#### Get global actions
+Get handles for all global actions buttons on the bottom of the action bar
+```typescript
+const actions = await activityBar.getGlobalActions();
+```
+
+#### Get global action by title
+Find global actions button by title
+```typescript
+const actions = await activityBar.getGlobalAction('Manage');
+```
+
+#### Open context menu
+Left click on the activity bar to open the context menu
+```typescript
+const menu = await activityBar.openContextMenu();
+```

wiki/BottomBarPanel.md

@@ -0,0 +1,30 @@
+![bottomBar](https://user-images.githubusercontent.com/4181232/56640335-099bfa00-6673-11e9-957f-37c47db20ff4.png)
+
+#### Lookup
+```typescript
+import { BottomBarPanel } from 'vscode-extension-tester';
+...
+const bottomBar = new BottomBarPanel();
+```
+
+#### Open/Close the panel
+```typescript
+// open
+await bottomBar.toggle(true);
+// close
+await bottomBar.toggle(false);
+```
+
+#### Maximize/Restore the panel
+```typescript
+await bottomBar.maximize();
+await bottomBar.restore();
+```
+
+#### Open specific view in the bottom panel
+```typescript
+const problemsView = await bottomBar.openProblemsView();
+const outputView = await bottomBar.openOutputView();
+const debugConsoleView = await bottomBar.openDebugConsoleView();
+const terminalView = await bottomBar.openTerminalView();
+```

wiki/ContentAssist.md

@@ -0,0 +1,23 @@
+![codeAssist](https://user-images.githubusercontent.com/4181232/56645020-20474e80-667d-11e9-9ebb-4f84c45d9080.png)
+
+#### Open/Lookup
+```typescript
+import { TextEditor, ContentAssist } from 'vscode-extension-tester';
+...
+const contentAssist = await new TextEditor().toggleContentAssist(true);
+```
+
+#### Get Items
+```typescript
+// find if an item with given label is present
+const hasItem = await contentAssist.hasItem('Get');
+// get an item by label
+const item = await contentAssist.getItem('Get');
+// get all visible items
+const items = await contentAssist.getItems();
+```
+
+#### Select an Item
+```typescript
+await contentAssist.getItem('Get').click();
+```

wiki/ContextMenu.md

@@ -0,0 +1,28 @@
+![contextMenu](https://user-images.githubusercontent.com/4181232/56651979-88e8f800-668a-11e9-97f6-0a3a7b582a8d.png)
+Page object for any context menu opened by left-clicking an element that has a context menu. Title bar items also produce context menus when clicked.
+
+#### Open/Lookup
+Typically, a context menu is opened by calling ```openContextMenu``` on elements that support it. For example:
+```typescript
+import { ActivityBar, ContextMenu } from 'vscode-extension-tester';
+...
+const menu = await new ActivityBar().openContextMenu();
+```
+
+#### Retrieve Items
+```typescript
+// find if an item with title exists
+const exists = await menu.hasItem('Copy');
+// get a handle for an item
+const item = await menu.getItem('Copy');
+// get all displayed items
+const items = await menu.getItems();
+```
+
+#### Select Item
+```typescript
+// recursively select an item in nested submenus
+await menu.select('File', 'Preferences', 'Settings');
+// select an item that has a child submenu
+const submenu = await menu.select('File', 'Preferences');
+```

wiki/ContextMenuItem.md

@@ -0,0 +1,28 @@
+![contextMenuItem](https://user-images.githubusercontent.com/4181232/56653068-26ddc200-668d-11e9-820e-dffb39000fea.png)
+
+#### Lookup
+One can retrieve an item from an open context menu, much like follows:
+```typescript
+import { ActivityBar } from 'vscode-extension-tester';
+...
+const menu = await new ActivityBar().openContextMenu();
+const item = await menu.getItem('References');
+```
+
+#### Select/Click
+```typescript
+// if item has no children
+await item.select();
+// if there is a submenu under the item
+const submenu = await item.select();
+```
+
+#### Get Parent Menu
+```typescript
+const parentMenu = item.getParent();
+```
+
+#### Get Label
+```typescript
+const label = await item.getLabel();
+```

wiki/CustomEditor.md

@@ -0,0 +1,30 @@
+In case your extension contributes a `CustomEditor`/`CustomTextEditor`. Both are based on a webview, and the page object is a combination of a `Webview` and common editor functionality.
+
+#### Lookup
+```typescript
+import { CustomEditor } from 'vscode-extension-tester'
+...
+// make sure the editor is opened by now
+const editor = new CustomEditor();
+```
+
+#### Webview
+The whole editor is serviced by a [[WebView]], we just need to get a reference to it.
+```typescript
+const webview = editor.getWebView();
+```
+
+#### Common Functionality
+Most editors share this:
+```typescript
+// check if there are unsaved changes
+const dirty = await editor.isDirty();
+// save
+await editor.save();
+// open 'save as' prompt
+const prompt = await editor.saveAs();
+// get title
+const title = await editor.getTitle();
+// get the editor tab
+const tab = await editor.getTab();
+```

wiki/CustomTreeSection.md

@@ -0,0 +1,27 @@
+![customTree](https://user-images.githubusercontent.com/4181232/65507524-6e7fa880-dece-11e9-93a5-e6ead75afc4e.png)
+
+The 'custom' tree section, usually contributed by extensions as TreeView. All The behaviour is defined by the general [[ViewSection]] class.
+
+#### Lookup
+```typescript
+import { SideBarView, CustomTreeSection } from 'vscode-extension-tester';
+...
+// Type is inferred automatically, the type cast here is used to be more explicit
+const section = await new SideBarView().getContent().getSection('servers') as CustomTreeSection;
+```
+
+#### Get Welcome Content
+Some sections may provide a welcome content when their tree is empty.
+```typescript
+// find welcome content, return undefined if not present
+const welcome: WelcomeContentSection = await section.findWelcomeContent();
+
+// get all the possible buttons and paragraphs in a list
+const contents = await welcome.getContents();
+
+// get all buttons 
+const btns = await welcome.getButtons();
+
+// get paragraphs as strings in a list
+const text = await welcome.getTextSections();
+```

wiki/DebugConsoleView.md

@@ -0,0 +1,28 @@
+Page object needs extending, currently minimal support.
+
+#### Lookup
+```typescript
+import { BottomBarPanel, DebugConsoleView } from 'vscode-extension-tester';
+...
+const debugView = await new BottomBarPanel().openDebugConsoleView();
+```
+
+#### Text Handling
+```typescript
+// get all text as string
+const text = await debugView.getText();
+// clear the text
+await debugView.clearText();
+```
+
+#### Expressions
+```typescript
+// type an expression
+await debugView.setExpression('expression');
+// evaluate an existing expression
+await debugView.evaluateExpression();
+// type and evaluate an expression
+await debugView.evaluateExpression('expression');
+// get a handle for content assist
+const assist = await debugView.getContentAssist();
+```

wiki/DebugToolbar.md

@@ -0,0 +1,30 @@
+![toolbar](https://user-images.githubusercontent.com/4181232/122540755-3bc5fe00-d029-11eb-8b74-77ee740acdad.png)
+
+#### Lookup
+```typescript
+// get a handle for existing toolbar (i.e. debug session needs to be in progress)
+const bar = await DebugToolbar.create();
+```
+
+#### Buttons
+```typescript
+// continue
+await bar.continue();
+// pause
+await bar.pause();
+// step over
+await bar.stepOver();
+// step into
+await bar.stepInto();
+// step out
+await bar.stepOut();
+// restart
+await bar.restart();
+// stop
+await bar.stop();
+```
+
+#### Wait for code to pause again
+```typescript
+await bar.waitForBreakPoint();
+```

wiki/DebugView.md

@@ -0,0 +1,24 @@
+![debugview](https://user-images.githubusercontent.com/4181232/122539414-e0dfd700-d027-11eb-9c72-f1745d7bb3c7.png)
+
+#### Lookup
+```typescript
+// open the view using the icon in the view container
+const btn = await new ActivityBar().getViewControl('Run');
+const debugView = (await btn.openView()) as DebugView;
+```
+
+#### Launch Configurations
+```typescript
+// get title of current launch configuration
+const config = await debugView.getLaunchConfiguration();
+// get titles of all available laynch configurations
+const configs = await debugView.getLaunchConfigurations();
+// select launch configuration by title
+await debugConfiguration.selectLaunchConfiguration('Test Launch');
+```
+
+#### Launch
+```typescript
+// start selected launch configuration
+await debugView.start();
+```