@vscode/test-web 0.0.13 → 0.0.17

package/.yarnrc

@@ -0,0 +1 @@
+--ignore-engines true

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## 0.0.17
+ * new options `--host` and `--port`: If provided runs the server from the given host and port.
+ * new option `--verbose` to print out the browser console log.
+
+## 0.0.16
+ * new option `--sourcesPath`: If provided, runs the server from VS Code sources at the given location.
+ * option `--version` is deprecated and replaced with `quality`. Supported values: `stable`, `insiders`. Instead of `sources` use `--insiders`
+
+## 0.0.14
+ * new option `--extensionPath` : A path pointing to a folder containing additional extensions to include. Argument can be provided multiple times.
+ * new option `--permission`: Permission granted to the opened browser: e.g. clipboard-read, clipboard-write. See full list of options [here](https://playwright.dev/docs/1.14/emulation#permissions). Argument can be provided multiple times.
+ * new option `--hideServerLog`: If set, hides the server log. Defaults to true when an extensionTestsPath is provided, otherwise false.
+ * close server when browser is closed
+
+## 0.0.9
+
+ * new option `folderPath`:	A local folder to open VS Code on. The folder content will be available as a virtual file system and opened as workspace.
+
+
 ### 0.0.1 |
 
 - Initial version

package/README.md

@@ -1,12 +1,17 @@
 # @vscode/test-web
 
-![Test Status Badge](https://github.com/microsoft/vscode-test-web/workflows/Tests/badge.svg)
+This module helps testing VS Code web extensions locally.
 
-This module helps testing [VS Code web extensions](https://code.visualstudio.com/api/extension-guides/web-extensions) locally.
+[![Test Status Badge](https://github.com/microsoft/vscode-test-web/workflows/Tests/badge.svg)](https://github.com/microsoft/vscode-test-web/actions/workflows/tests.yml)
+[![npm Package](https://img.shields.io/npm/v/@vscode/test-web.svg?style=flat-square)](https://www.npmjs.org/package/@vscode/test-web)
+[![NPM Downloads](https://img.shields.io/npm/dm/@vscode/test-web.svg)](https://npmjs.org/package/@vscode/test-web)
 
-The node module runs a local web server that serves VS Code for the browser including the extensions located at the given local path. Additionally the extension tests are automatically run.
 
-The node module providers a command line as well as an API.
+See the [web extensions guide](https://code.visualstudio.com/api/extension-guides/web-extensions) to learn about web extensions.
+
+The node module runs a local web server that serves VS Code in the browser including the extension under development. Additionally the extension tests are automatically run.
+
+The node module provides a command line as well as an API.
 
 ## Usage
 
@@ -30,47 +35,59 @@ Open VS Code in the Browser on a folder with test data from the local disk:
 vscode-test-web --browserType=chromium --extensionDevelopmentPath=$extensionLocation $testDataLocation
 ```
 
-VS Code Browser will open on a virtual workspace (scheme `vscode-test-web`), backed by a file system provider that gets the file/folder data from the local disk. Changes to the file system are kept in memory and are not written back to disk.
+VS Code for the Web will open on a virtual workspace (scheme `vscode-test-web`), backed by a file system provider that gets the file/folder data from the local disk. Changes to the file system are kept in memory and are not written back to disk.
 
 Via API:
 
 ```ts
 async function go() {
-	try {
-		// The folder containing the Extension Manifest package.json
-		const extensionDevelopmentPath = path.resolve(__dirname, '../../../');
-
-		// The path to module with the test runner and tests
-		const extensionTestsPath = path.resolve(__dirname, './suite/index');
-
-		// Start a web server that serves VSCode in a browser, run the tests
-		await runTests({ browserType: 'chromium', extensionDevelopmentPath, extensionTestsPath });
-	} catch (err) {
-		console.error('Failed to run tests');
-		process.exit(1);
-	}
+  try {
+    // The folder containing the Extension Manifest package.json
+    const extensionDevelopmentPath = path.resolve(__dirname, '../../../');
+
+    // The path to module with the test runner and tests
+    const extensionTestsPath = path.resolve(__dirname, './suite/index');
+
+    // Start a web server that serves VSCode in a browser, run the tests
+    await runTests({
+		browserType: 'chromium',
+		extensionDevelopmentPath
+		extensionTestsPath
+	});
+  } catch (err) {
+    console.error('Failed to run tests');
+    process.exit(1);
+  }
 }
 
 go()
 ```
 
 CLI options:
-```
-  --browserType 'chromium' | 'firefox' | 'webkit': The browser to launch
-  --extensionDevelopmentPath path. [Optional]: A path pointing to a extension to include.
-  --extensionTestsPath path.  [Optional]: A path to a test module to run
-  --version. 'insiders' (Default) | 'stable' | 'sources' [Optional]
-  --open-devtools. Opens the dev tools  [Optional]
-  --headless. Whether to show the browser. Defaults to true when an extensionTestsPath is provided, otherwise false. [Optional]
-  folderPath. A local folder to open VS Code on. The folder content will be available as a virtual file system`
 
-```
+|Option|Argument Description|
+|-----|-----|
+| --browserType | The browser to launch: `chromium` (default), `firefox` or `webkit` |
+| --extensionDevelopmentPath | A path pointing to an extension under development to include. |
+| --extensionTestsPath | A path to a test module to run. |
+| --quality | `insiders` (default),  or `stable`. Ignored when sourcesPath is provided. |
+| --sourcesPath | If set, runs the server from VS Code sources located at the given path. Make sure the sources and extensions are compiled (`yarn compile` and `yarn compile-web`) |
+| --headless | If set, hides the browser. Defaults to true when an extensionTestsPath is provided, otherwise false. |
+| --permission | Permission granted to the opened browser: e.g. `clipboard-read`, `clipboard-write`.  See [full list of options](https://playwright.dev/docs/api/class-browsercontext#browser-context-grant-permissions). Argument can be provided multiple times.  |
+| --folder-uri | URI of the workspace to open VS Code on. Ignored when `folderPath` is provided |
+| --extensionPath | A path pointing to a folder containing additional extensions to include. Argument can be provided multiple times. |
+| --host | The host name the server is opened on. Defaults to `localhost` |
+| --port | The port the server is opened on. Defaults to `3000` |
+| --open-devtools | If set, opens the dev tools in the browser |
+| --verbose | If set, prints out more information when running the server |
+| --hideServerLog | If set, hides the server log. Defaults to true when an extensionTestsPath is provided, otherwise false. |
+| folderPath |  A local folder to open VS Code on. The folder content will be available as a virtual file system and opened as workspace. |
 
 Corresponding options are available in the API.
 
 ## Development
 
-- `yarn install`
+- `yarn && yarn install-extensions`
 - Make necessary changes in [`src`](./src)
 - `yarn compile` (or `yarn watch`)