sealights-cucumber-plugin - npm Package Compare versions

Comparing version 2.0.60 to 2.0.66

package.json

 {
   "name": "sealights-cucumber-plugin",
-  "version": "2.0.60",
+  "version": "2.0.66",
   "description": "Cucumber integration for sealights ",
@@ -46,3 +46,3 @@ "author": "Roni Segal <[e-mail]>",
   },
-  "gitHead": "819bddf4c6e7e902eeb8ff54d8e9c634f3f3febd"
+  "gitHead": "5460a818879b2a0405e9542d7747f34b6d76ba8c"
 }

README.md

@@ -13,23 +13,74 @@ # `sealights-cucumber-plugin`
 
-Require this package using `--require` argument to the cucumber command
+Pass `path-to-plugin` as `require` option of cucumber command
 ```
-node_modules/.bin/cucumber-js ./features --require sealights-cucumber-plugin
+npx cucumber-js ./features ... --require <path-to-plugin>
 ```
-## Usage in protractor.conf
 
-Require this package using `--require` argument to the cucumber command
+Or set it in config file
 ```
+// cucumber.js
+module.exports = {
+  default: {
+    ...
+    require: [
+      './features/support/*',
+      '<path-to-plugin>',
+    ]
+  }
+};
+```
+
+Note: Usage of `--require` option override default definition of path to step definitions.
+Pass it explicitly if you don't do it yet. Example:
+```
+npx cucumber-js ./features --require ./src/steps/*.steps.ts --require <path-to-plugin>
+```
+
+## Resolve path to plugin
+Resolve path to plugin dynamically
+
+### CommonJs
+```
+const pathToPlugin = require.resolve('sealights-cucumber-plugin');
+```
+
+### ESM
+```
+import url from 'node:url';
+
+const pluginUrl = import.meta.resolve('sealights-cucumber-plugin');
+const pathToPlugin = url.fileURLToPath(new URL(pluginUrl));
+```
+
+### Resolve in CLI
+Execution of next command allow to resolve path in CLI if node available on machine
+
+Unix:
+```
+SL_PACKAGE=$(node -p "require.resolve('sealights-cucumber-plugin')")
+```
+
+PowerShell:
+```
+$Env:SL_PACKAGE = node -p "require.resolve('sealights-cucumber-plugin')"
+```
+
+If any of this option don't work for you can use static path to plugin
+`./node_modules/sealight-cucumber/plugin/tsOutputs/lib/cucumber-integration.js`
+But it is not recommended and it can be changed.
+
+## Usage in protractor.conf or wdio.conf
+
+Pass `path-to-plugin` as `require` option of cucumber command
+
+```
 cucumberOpts: {
     require: [
       './src/steps/*.steps.ts',
-      require.resolve('sealights-cucumber-plugin')
+      '<path-to-plugin>'
     ]
   },
 ```
-### Passing parameters to reporter via CLI
-From the command line add sealights parameters with '--sl-' prefix
 
-```
-protractor protractor.conf.js --sl-tokenfile <path/to/token-file>  --sl-buildsessionidfile <path/to/buildSessionId-file> --sl-testStage e2e
-```
+## Passing parameters
 
@@ -47,2 +98,13 @@ ### Passing parameters to plugin via config file
 
+### Passing parameters to reporter via CLI
+
+!!! Not recommended. This case won`t work in the latest version of cucumber, use file config instead
+
+From the command line add sealights parameters with `--sl-` prefix
+
+```
+npx cucumber-js ./features --sl-tokenfile <path/to/token-file>  --sl-buildsessionidfile <path/to/buildSessionId-file> --sl-testStage e2e
+```
+
+
 ### Supported parameters
@@ -56,3 +118,4 @@ * token - Sealights token
 * proxy - Proxy server (optional)
+
 ## Author
 Sealights

tsOutputs/lib/version.d.ts

@@ -1,1 +0,1 @@
-export declare const version = "2.0.60";
+export declare const version = "2.0.66";

tsOutputs/lib/version.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
-exports.version = "2.0.60";
+exports.version = "2.0.66";
 //# sourceMappingURL=version.js.map

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

26957

increased by5.05%

Number of lines in readme file

119

increased by112.5%

No dependency changes