@vscode/test-web 0.0.16 → 0.0.17

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # 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`

package/README.md

@@ -65,19 +65,22 @@ go()
 
 CLI options:
 
- |Option|Argument Description|
- |-----|-----|
- | --browserType | The browser to launch: `chromium` (default), `firefox` or `webkit` |
+|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. |
+| --extensionTestsPath | A path to a test module to run. |
 | --quality | `insiders` (default),  or `stable`. Ignored when sourcesPath is provided. |
-| --sourcesPath | If set, runs from VS Code sources located at the given path. Make sure the sources and extensions are compiled (`yarn compile` and `yarn compile-web`) |
-| --open-devtools|  If set, opens the dev tools  |
-| --headless|  If set, hides the browser. Defaults to true when an extensionTestsPath is provided, otherwise false. |
-| --hideServerLog| If set, hides the server log. 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.  |
+| --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.

package/out/index.d.ts

@@ -35,7 +35,7 @@ export interface Options {
      */
     quality?: VSCodeQuality;
     /**
-     * Deprecated. Use `quality` or `vsCodeDevPath` instead.
+     * @deprecated. Use `quality` or `vsCodeDevPath` instead.
      */
     version?: string;
     /**
@@ -79,7 +79,18 @@ export interface Options {
      * Absolute path pointing to VS Code sources to use.
      */
     vsCodeDevPath?: string;
+    /**
+     * Print out more information while the server is running, e.g. the console output in the browser
+     */
     verbose?: boolean;
+    /**
+     * The port to start the server on. Defaults to `3000`.
+     */
+    port?: number;
+    /**
+     * The host name to start the server on. Defaults to `localhost`
+     */
+    host?: string;
 }
 export interface Disposable {
     dispose(): void;

package/out/index.js

@@ -18,19 +18,21 @@ const path = require("path");
  * @param options The options defining browser type, extension and test location.
  */
 async function runTests(options) {
+    var _a, _b, _c;
     const config = {
         extensionDevelopmentPath: options.extensionDevelopmentPath,
         extensionTestsPath: options.extensionTestsPath,
         build: await getBuild(options),
         folderUri: options.folderUri,
         folderMountPath: options.folderPath,
-        hideServerLog: true,
+        hideServerLog: (_a = options.hideServerLog) !== null && _a !== void 0 ? _a : true,
         extensionPaths: options.extensionPaths
     };
-    const port = 3000;
-    const server = await (0, main_1.runServer)(port, config);
+    const host = (_b = options.host) !== null && _b !== void 0 ? _b : 'localhost';
+    const port = (_c = options.port) !== null && _c !== void 0 ? _c : 3000;
+    const server = await (0, main_1.runServer)(host, port, config);
     return new Promise(async (s, e) => {
-        const endpoint = `http://localhost:${port}`;
+        const endpoint = `http://${host}:${port}`;
         const context = await openBrowser(endpoint, options);
         context.once('close', () => server.close());
         await context.exposeFunction('codeAutomationLog', (type, args) => {
@@ -66,17 +68,20 @@ async function getBuild(options) {
     return await (0, download_1.downloadAndUnzipVSCode)(quality === 'stable' ? 'stable' : 'insider');
 }
 async function open(options) {
+    var _a, _b, _c;
     const config = {
         extensionDevelopmentPath: options.extensionDevelopmentPath,
         extensionTestsPath: options.extensionTestsPath,
         build: await getBuild(options),
         folderUri: options.folderUri,
         folderMountPath: options.folderPath,
+        hideServerLog: (_a = options.hideServerLog) !== null && _a !== void 0 ? _a : true,
         extensionPaths: options.extensionPaths
     };
-    const port = 3000;
-    const server = await (0, main_1.runServer)(port, config);
-    const endpoint = `http://localhost:${port}`;
+    const host = (_b = options.host) !== null && _b !== void 0 ? _b : 'localhost';
+    const port = (_c = options.port) !== null && _c !== void 0 ? _c : 3000;
+    const server = await (0, main_1.runServer)(host, port, config);
+    const endpoint = `http://${host}:${port}`;
     const context = await openBrowser(endpoint, options);
     context.once('close', () => server.close());
     return {
@@ -250,17 +255,21 @@ function validatePortNumber(port) {
 }
 function showHelp() {
     console.log('Usage:');
-    console.log(`  --browserType 'chromium' | 'firefox' | 'webkit': The browser to launch. [Optional, default 'chromium']`);
+    console.log(`  --browserType 'chromium' | 'firefox' | 'webkit': The browser to launch. [Optional, defaults to 'chromium']`);
     console.log(`  --extensionDevelopmentPath path: A path pointing to an extension under development to include. [Optional]`);
     console.log(`  --extensionTestsPath path: A path to a test module to run. [Optional]`);
     console.log(`  --quality 'insiders' | 'stable' [Optional, default 'insiders', ignored when running from sources]`);
     console.log(`  --sourcesPath path: If provided, running from VS Code sources at the given location [Optional]`);
     console.log(`  --open-devtools: If set, opens the dev tools  [Optional]`);
     console.log(`  --headless: Whether to hide the browser. Defaults to true when an extensionTestsPath is provided, otherwise false. [Optional]`);
-    console.log(`  --hideServerLog: Whether to hide the server log. Defaults to true when an extensionTestsPath is provided, otherwise false. [Optional]`);
     console.log(`  --permission: Permission granted in the opened browser: e.g. 'clipboard-read', 'clipboard-write':  [Optional, Multiple]`);
     console.log(`  --folder-uri: workspace to open VS Code on. Ignored when folderPath is provided [Optional]`);
     console.log(`  --extensionPath: A path pointing to a folder containing additional extensions to include [Optional, Multiple]`);
+    console.log(`  --host: The host name the server is opened on  [Optional, defaults to localhost]`);
+    console.log(`  --port: The port the server is opened on  [Optional, defaults to 3000]`);
+    console.log(`  --open-devtools: If set, opens the dev tools  [Optional]`);
+    console.log(`  --verbose: If set, prints out more information when running the server  [Optional]`);
+    console.log(`  --hideServerLog: Whether to hide the server log. Defaults to true when an extensionTestsPath is provided, otherwise false. [Optional]`);
     console.log(`  folderPath. A local folder to open VS Code on. The folder content will be available as a virtual file system. [Optional]`);
 }
 async function cliMain() {
@@ -268,7 +277,7 @@ async function cliMain() {
     const manifest = require('../package.json');
     console.log(`${manifest.name}: ${manifest.version}`);
     const options = {
-        string: ['extensionDevelopmentPath', 'extensionTestsPath', 'browserType', 'quality', 'version', 'waitForDebugger', 'folder-uri', 'permission', 'extensionPath', 'sourcesPath'],
+        string: ['extensionDevelopmentPath', 'extensionTestsPath', 'browserType', 'quality', 'version', 'waitForDebugger', 'folder-uri', 'permission', 'extensionPath', 'sourcesPath', 'host', 'port'],
         boolean: ['open-devtools', 'headless', 'hideServerLog', 'help', 'verbose'],
         unknown: arg => {
             if (arg.startsWith('-')) {
@@ -295,6 +304,8 @@ async function cliMain() {
     const permissions = valdiatePermissions(args.permission);
     const hideServerLog = validateBooleanOrUndefined(args, 'hideServerLog');
     const verbose = validateBooleanOrUndefined(args, 'verbose');
+    const port = validatePortNumber(args.port);
+    const host = validateStringOrUndefined(args, 'host');
     const waitForDebugger = validatePortNumber(args.waitForDebugger);
     let folderUri = validateStringOrUndefined(args, 'folder-uri');
     let folderPath;
@@ -324,7 +335,9 @@ async function cliMain() {
             permissions,
             extensionPaths,
             vsCodeDevPath,
-            verbose
+            verbose,
+            host,
+            port
         });
     }
     else {
@@ -341,7 +354,9 @@ async function cliMain() {
             permissions,
             extensionPaths,
             vsCodeDevPath,
-            verbose
+            verbose,
+            host,
+            port
         });
     }
 }

package/out/server/main.js

@@ -6,10 +6,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.runServer = void 0;
 const app_1 = require("./app");
-async function runServer(port, config) {
+async function runServer(host, port, config) {
     const app = await (0, app_1.default)(config);
-    const server = app.listen(port);
-    console.log(`Listening on http://localhost:${port}`);
+    const server = app.listen(port, host);
+    console.log(`Listening on http://${host}:${port}`);
     return server;
 }
 exports.runServer = runServer;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vscode/test-web",
-  "version": "0.0.16",
+  "version": "0.0.17",
   "scripts": {
     "install-extensions": "yarn --cwd=fs-provider && yarn --cwd=sample",
     "compile": "tsc -p ./ && yarn compile-fs-provider",