@vscode/test-web 0.0.14 → 0.0.15

package/README.md

@@ -1,15 +1,17 @@
 # @vscode/test-web
 
-This module helps testing [VS Code web extensions](https://code.visualstudio.com/api/extension-guides/web-extensions) locally.
+This module helps testing VS Code 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.
+See the [web extensions guide](https://code.visualstudio.com/api/extension-guides/web-extensions) to learn about web extensions.
 
-The node module providers a command line as well as an API.
+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
 
@@ -39,19 +41,23 @@ 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()
@@ -59,8 +65,8 @@ go()
 
 CLI options:
 
- |Option|Argument Description||
- |-----|-----|----|
+ |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. |

package/fs-provider/package.json

@@ -24,10 +24,10 @@
 	},
 	"devDependencies": {
 		"@types/vscode": "^1.55.0",
-		"@types/webpack-env": "^1.16.0",
-		"ts-loader": "^9.2.3",
-		"webpack": "^5.40.0",
-		"webpack-cli": "^4.7.2",
+		"@types/webpack-env": "^1.16.2",
+		"ts-loader": "^9.2.6",
+		"webpack": "^5.55.0",
+		"webpack-cli": "^4.8.0",
 		"process": "^0.11.10",
 		"path-browserify": "^1.0.1",
 		"request-light": "^0.5.3",

package/out/index.js

@@ -241,18 +241,26 @@ function showHelp() {
     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() {
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    const manifest = require('../package.json');
+    console.log(`${manifest.name}: ${manifest.version}`);
     const options = {
         string: ['extensionDevelopmentPath', 'extensionTestsPath', 'browserType', 'version', 'waitForDebugger', 'folder-uri', 'permission', 'extensionPath'],
-        boolean: ['open-devtools', 'headless', 'hideServerLog'],
+        boolean: ['open-devtools', 'headless', 'hideServerLog', 'help'],
         unknown: arg => {
             if (arg.startsWith('-')) {
                 console.log(`Unknown argument ${arg}`);
+                showHelp();
                 return false;
             }
             return true;
         }
     };
     const args = minimist(process.argv.slice(2), options);
+    if (args.help) {
+        showHelp();
+        process.exit();
+    }
     const browserType = valdiateBrowserType(args.browserType);
     const extensionTestsPath = await validatePathOrUndefined(args, 'extensionTestsPath', true);
     const extensionDevelopmentPath = await validatePathOrUndefined(args, 'extensionDevelopmentPath');

package/out/server/download.js

@@ -70,7 +70,7 @@ async function downloadAndUnzipVSCode(quality) {
     const folderName = `vscode-web-${quality}-${info.version}`;
     const downloadedPath = path.resolve(vscodeTestDir, folderName);
     if ((0, fs_1.existsSync)(downloadedPath) && (0, fs_1.existsSync)(path.join(downloadedPath, 'version'))) {
-        return { type: 'static', location: downloadedPath };
+        return { type: 'static', location: downloadedPath, quality, version: info.version };
     }
     if ((0, fs_1.existsSync)(vscodeTestDir)) {
         await fs_1.promises.rmdir(vscodeTestDir, { recursive: true, maxRetries: 5 });
@@ -95,7 +95,7 @@ async function downloadAndUnzipVSCode(quality) {
             // ignore
         }
     }
-    return { type: 'static', location: downloadedPath };
+    return { type: 'static', location: downloadedPath, quality, version: info.version };
 }
 exports.downloadAndUnzipVSCode = downloadAndUnzipVSCode;
 async function fetch(api) {

package/package.json

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