browserstack-cypress-cli - npm Package Compare versions

Comparing version 1.1.5 to 1.1.6

bin/helpers/archiver.js

@@ -11,3 +11,3 @@ 'use strict';
 
-    var cypressFolderPath = runSettings.cypress_proj_dir
+    var cypressFolderPath = runSettings.cypress_proj_dir;
 
@@ -40,7 +40,13 @@ var archive = archiver('zip', {
 
+
     let allowedFileTypes = [ 'js', 'json', 'txt', 'ts' ]
     allowedFileTypes.forEach(fileType => {
-      archive.glob(`**/*.${fileType}`, { cwd: cypressFolderPath, matchBase: true, ignore: 'node_modules/**' });
+      archive.glob(`**/*.${fileType}`, { cwd: cypressFolderPath, matchBase: true, ignore: ['node_modules/**', 'package-lock.json', 'package.json', 'browserstack-package.json'] });
     });
 
+    if (typeof runSettings.npm_dependencies === 'object') {
+      var packageJSON = JSON.stringify({devDependencies: runSettings.npm_dependencies}, null, 4);
+      archive.append(packageJSON, { name: 'browserstack-package.json' });
+    }
+
     archive.finalize();
@@ -47,0 +53,0 @@ });

bin/templates/configTemplate.js

@@ -17,3 +17,5 @@ module.exports = function () {
       "project_name": "project-name",
-      "build_name": "build-name"
+      "build_name": "build-name",
+      "npm_dependencies": {
+      }
     },
@@ -20,0 +22,0 @@ "connection_settings": {

package.json

 {
   "name": "browserstack-cypress-cli",
-  "version": "1.1.5",
+  "version": "1.1.6",
   "description": "BrowserStack Cypress CLI for Cypress integration with BrowserStack's remote devices.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -51,2 +51,5 @@ # BrowserStack Cypress CLI
 
+Make sure you specify the npm packages that your tests need to run using the
+`npm_dependencies` option in `run_settings`.
+
 Then, run your tests on BrowserStack:
@@ -79,4 +82,4 @@
         "browser": "chrome",
-        "os": "OS X Catalina",
-        "versions": ["69","66"]
+        "os": "Windows 10",
+        "versions": ["79","78"]
       }
@@ -87,3 +90,7 @@ ],
       "project_name": "my first project",
-      "build_name": "build 1"
+      "build_name": "build 1",
+      "npm_dependencies": {
+        "npm-package-you-need-to-run-tests-1": "^1.2.1",
+        "npm-package-you-need-to-run-tests-2": "^7.1.6-beta.13",
+      }
     },
@@ -103,3 +110,3 @@ "connection_settings": {
 You can use the `auth` option to specify your username and access keys. You
-can find them in your [Automate dashboard](https://automate.browserstack.com/)                                                                        
+can find them in your [Automate dashboard](https://automate.browserstack.com/)
 
@@ -127,7 +134,7 @@ | Option       | Description                   | Possible values |
 
-| Option     | Description                                    | Possible values                                                |
-| ---------- | ---------------------------------------------- | -------------------------------------------------------------- |
-| `os`       | Operating system you want to run the tests on. | `Windows 10`, `OS X Mojave` and `OS X Catalina`                |
-| `browser`  | Browser you want to run the tests on.          | `chrome`, `firefox` and `edge`                                 |
-| `versions` | A list of supported browser versions.          | Chrome: `66` to `80` <br/>Firefox: `60` to `72`<br/>Edge: `80` |
+| Option     | Description                                    | Possible values                                                       |
+| ---------- | ---------------------------------------------- | --------------------------------------------------------------------- |
+| `os`       | Operating system you want to run the tests on. | `Windows 10`                                                          |
+| `browser`  | Browser you want to run the tests on.          | `chrome`, `firefox` and `edge`                                        |
+| `versions` | A list of supported browser versions.          | Chrome: `66` to `81` <br/>Firefox: `60` to `75`<br/>Edge: `80` & `81` |
 
@@ -141,6 +148,6 @@ Example:
       "browser": "chrome",
-      "versions": ["69", "66"]
+      "versions": ["79", "78"]
     },
     {
-      "os": "OS X Mojave",
+      "os": "Windows 10",
       "browser": "firefox",
@@ -163,2 +170,3 @@ "versions": ["69", "66"]
 | `build_name`       | Name of your build / CI run. You'll be able to search & filter your tests on the dashboard using this. username. | -               |
+| `npm_dependencies` | A list  of NPM packages that are required to run your Cypress tests along with their version numbers.            | -               |
 
@@ -172,3 +180,7 @@ Example:
     "project_name": "my first project",
-    "build_name": "build 1"
+    "build_name": "build 1",
+    "npm_dependencies": {
+      "npm-package-you-need-to-run-tests-1": "^1.2.1",
+      "npm-package-you-need-to-run-tests-2": "^7.1.6-beta.13",
+    }
   }
@@ -423,4 +435,4 @@ }
     the moment. You can use `http://bs-local.com` instead, to replace `localhost`
--   Installing npm packages that your tests might require to run the tests are
-    not supported at this moment.
+-   Installing npm packages using `npm_dependencies` is not supported for tests
+    running on macOS.
 
@@ -427,0 +439,0 @@ ## License

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

51609

increased by1.74%

Lines of code

1073

increased by0.56%

Number of lines in readme file

434

increased by2.84%

No dependency changes