@dev-blinq/cucumber-js 1.0.3 → 1.0.4

package/README.md

@@ -1,124 +1,68 @@
 <h1 align="center">
-  <img src="./docs/images/logo.svg" alt="">
+  <img src="./docs/images/icon.png" style="width:150px;height:150px;" alt="">
   <br>
-  Cucumber
+  Cucumber - Blinq.io
 </h1>
 <p align="center">
-  <b>Automated tests in plain language, for Node.js</b>
+  <b>Cucumber.js with Blinq.io adaptation</b>
 </p>
 
-[![#StandWithUkraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://vshymanskyy.github.io/StandWithUkraine)
-[![npm](https://img.shields.io/npm/v/@cucumber/cucumber.svg)](https://www.npmjs.com/package/@cucumber/cucumber)
-[![build](https://github.com/cucumber/cucumber-js/workflows/Build/badge.svg)](https://github.com/cucumber/cucumber-js/actions)
-[![coverage](https://coveralls.io/repos/github/cucumber/cucumber-js/badge.svg?branch=master)](https://coveralls.io/github/cucumber/cucumber-js?branch=master)
-[![backers](https://opencollective.com/cucumber/backers/badge.svg)](https://opencollective.com/cucumber)
-[![sponsors](https://opencollective.com/cucumber/sponsors/badge.svg)](https://opencollective.com/cucumber)
-
-[Cucumber](https://github.com/cucumber) is a tool for running automated tests written in plain language. Because they're
-written in plain language, they can be read by anyone on your team. Because they can be
-read by anyone, you can use them to help improve communication, collaboration and trust on
-your team.
-
-This is the JavaScript implementation of Cucumber. It runs on [maintained versions](https://github.com/nodejs/Release) of Node.js. You can [quickly try it via CodeSandbox](https://codesandbox.io/s/cucumber-js-demo-2p3vrl?file=/features/greeting.feature), or read on to get started locally in a couple of minutes.
-
-Looking to contribute? Read our [code of conduct](https://github.com/cucumber/.github/blob/main/CODE_OF_CONDUCT.md) first, then check the [contributing guide](./CONTRIBUTING.md) to get up and running.
+We took the regular old [Cucumber](https://github.com/cucumber) (A tool for running automated tests) and made improvements 
+that could be helpful when working with data that should be saved or when we want to generate fake data for testing 
+purposes in our Gherkin feature file.
 
 ## Install
 
-Cucumber is [available on npm](https://www.npmjs.com/package/@cucumber/cucumber):
+@dev-blinq/cucumber-js is [available on npm](https://www.npmjs.com/package/@dev-blinq/cucumber-js):
 
 ```shell
-$ npm install @cucumber/cucumber
+$ npm install @dev-blinq/cucumber-js
 ```
 
 ## Get Started
 
-Let's take this example of something to test:
-
-
-First, write your main code in `src/index.js`:
-
-```js
-class Greeter {
-  sayHello() {
-    return 'hello'
-  }
-}
-
-module.exports = {
-  Greeter
-}
-```
-
-Then, write your feature in `features/greeting.feature`:
+Before, we used to write Gherkin feature files like this -
 
 ```gherkin
-Feature: Greeting
-
-  Scenario: Say hello
-    When the greeter says hello
-    Then I should have heard "hello"
+Feature: Github
+    Scenario Outline: Create a new repository
+        Given Create a new repository name "<repo>"
+        Examples:
+            | repo                
+            | random_repo_name
 ```
 
-Next, implement your steps in `features/support/steps.js`:
+Now, instead of picking a random name by ourselfs, we could fake data using the [faker](https://www.npmjs.com/package/@faker-js/faker) library and get a random value -
 
-```js
-const assert = require('assert')
-const { When, Then } = require('@cucumber/cucumber')
-const { Greeter } = require('../../src')
-
-When('the greeter says hello', function () {
-  this.whatIHeard = new Greeter().sayHello()
-});
-
-Then('I should have heard {string}', function (expectedResponse) {
-  assert.equal(this.whatIHeard, expectedResponse)
-});
+```gherkin
+Feature: Github
+    Scenario Outline: Create a new repository
+        Given Create a new repository name "<repo>"
+        Examples:
+            | repo                
+            | {{string.alpha(10)}}
 ```
 
-Finally, run Cucumber:
+We could also save our fake data (or any data really) as a variable for future use using the equals (=) sign -
 
-```shell
-$ npx cucumber-js
+```gherkin
+Feature: Github
+    Scenario Outline: Create a new repository
+        Given Create a new repository name "<repo>"
+        Examples:
+            |  repo                 
+            | {{repo=string.alpha(10)}}
+
+    Scenario Outline: Create a second repository
+        Given Create a new repository with the same name as before "<repo>"
+        Examples:
+            |  repo                 
+            | {{repo}}
 ```
 
-And see the output:
-
-![Terminal output showing a successful test run with 1 scenario and 2 steps, all passing](./docs/images/readme-output.png)
-
-If you learn best by example, we have [a repo with several example projects](https://github.com/cucumber/cucumber-js-examples), that might help you get going.
+In that example, we saved repo as a variable with a value of some fake data and used it again as the second repo
+value, both repos will have the same fake value.
 
 ## Documentation
 
-The following documentation is for `main`, which might contain some unreleased features. See [documentation for older versions](./docs/older_versions.md) if you need it.
-
-* [Installation](./docs/installation.md)
-* [CLI](./docs/cli.md)
-* [Configuration](./docs/configuration.md)
-* Support Code
-  * [API Reference](./docs/support_files/api_reference.md)
-  * [Attachments](./docs/support_files/attachments.md)
-  * [Data Tables](./docs/support_files/data_table_interface.md)
-  * [Hooks](./docs/support_files/hooks.md)
-  * [Step Definitions](./docs/support_files/step_definitions.md)
-  * [Timeouts](./docs/support_files/timeouts.md)
-  * [World](./docs/support_files/world.md)
-* Guides
-  * [Debugging](./docs/debugging.md)
-  * [Dry run](./docs/dry_run.md)
-  * [ES Modules](./docs/esm.md)
-  * [Failing fast](./docs/fail_fast.md)
-  * [Filtering which scenarios run](./docs/filtering.md)
-  * [Formatters for feedback and reporting](./docs/formatters.md)
-  * [Parallel running for speed](./docs/parallel.md)
-  * [Profiles for composable configuration](./docs/profiles.md)
-  * [Rerunning just failures](./docs/rerun.md)
-  * [Retrying flaky scenarios](./docs/retry.md)
-  * [JavaScript API for running programmatically](./docs/javascript_api.md)
-  * [Snippets for undefined steps](./docs/snippets.md)
-  * [Transpiling (from TypeScript etc)](./docs/transpiling.md)
-* [FAQ](./docs/faq.md)
-
-## Support
-
-Support is [available from the community](https://cucumber.io/tools/cucumber-open/support/) if you need it.
+See documentation for the [Blinq.io](https://docs.blinq.io) app.

package/lib/version.d.ts

@@ -1 +1 @@
-export declare const version = "1.0.3";
+export declare const version = "1.0.4";

package/lib/version.js

@@ -2,5 +2,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
 // Generated by genversion.
-exports.version = '1.0.3';
+exports.version = '1.0.4';
 //# sourceMappingURL=version.js.map

package/lib/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":";;;AAAA,2BAA2B;AACd,QAAA,OAAO,GAAG,OAAO,CAAA","sourcesContent":["// Generated by genversion.\nexport const version = '1.0.3'\n"]}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":";;;AAAA,2BAA2B;AACd,QAAA,OAAO,GAAG,OAAO,CAAA","sourcesContent":["// Generated by genversion.\nexport const version = '1.0.4'\n"]}

package/package.json

@@ -8,7 +8,7 @@
     "gherkin",
     "tests"
   ],
-  "version": "1.0.3",
+  "version": "1.0.4",
   "homepage": "https://github.com/blinq-io/cucumber-js",
   "author": "blinq.io",
   "contributors": [