vscode-test - npm Package Compare versions

Comparing version 0.4.2 to 0.4.3

CHANGELOG.md

 # Changelog
 
+### 0.4.3 | 2019-05-30
+
+- Improved API documentation.
+
 ### 0.4.2 | 2019-05-24
@@ -4,0 +8,0 @@

out/runTest.d.ts

@@ -19,14 +19,18 @@ export interface TestOptions {
     /**
-     * Absolute path to the extension root. Must include a `package.json`
-     * Extension Manifest.
+     * Absolute path to the extension root. Passed to `--extensionDevelopmentPath`.
+     * Must include a `package.json` Extension Manifest.
      */
     extensionPath: string;
     /**
-     * Absolute path to the test suite folder. Must include an `index.js` that
-     * exports a test runner, such as:
+     * Absolute path to the test runner. Passed to `--extensionTestsPath`.
+     * Can be either a file path or a directory path that contains an `index.js`.
+     * Must export a `run` function of the following signature:
      *
      * ```ts
-     * import * as testRunner from 'vscode/lib/testrunner';
-     * module.exports = testRunner;
+     * function run(testsRoot: string, cb: (error: any, failures?: number) => void): void;
      * ```
+     *
+     * When running integration test, the Extension Development Host will call this function
+     * that runs the test suite. The `cb` function should be called when the test suite finishes.
+     *
      */
@@ -41,3 +45,8 @@ testRunnerPath: string;
     /**
-     * Absolute path of the fixture workspace to launch for testing
+     * Absolute path of the fixture workspace to launch for testing.
+     * Passed as the first argument to `code` executable and can be:
+     *
+     * - File path: Open file on test start
+     * - Folder path: Open folder on test start
+     * - Workspace file path: Open workspace on test start
      */
@@ -44,0 +53,0 @@ testWorkspace?: string;

package.json

 {
   "name": "vscode-test",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "scripts": {
@@ -5,0 +5,0 @@ "compile": "tsc -p ./",

README.md

@@ -6,4 +6,4 @@ <p>
 <p align="center">
-  <a href="https://dev.azure.com/vscode/VSCode/_build?definitionId=14">
-    <img src="https://img.shields.io/azure-devops/build/vscode/a4cdce18-a05c-4bb8-9476-5d07e63bfd76/14.svg?label=Azure%20DevOps&logo=Azure%20Devops&style=flat-square">
+  <a href="https://dev.azure.com/vscode/vscode-test/_build?definitionId=15">
+    <img src="https://img.shields.io/azure-devops/build/vscode/350ef5c4-15fc-411a-9a5e-0622da4da69c/15.svg?label=Azure%20DevOps&logo=Azure%20Devops&style=flat-square">
   </a>
@@ -17,3 +17,3 @@ </p>
 - Node >= 8.x
-- Windows > Windows Server 2012+ / Win10+ (anything with Powershell > 5.0)
+- Windows >= Windows Server 2012+ / Win10+ (anything with Powershell >= 5.0)
 - macOS
@@ -20,0 +20,0 @@ - Linux

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

49333

increased by1.3%

Lines of code

610

increased by1.5%

No dependency changes