@g_package/jest-cucumber-fusion 2.0.0 → 3.0.0

package/.prettierignore

@@ -1,16 +0,0 @@
-# Ignore artifacts:
-.git
-.github
-build
-coverage
-docs
-node_modules
-
-.gitignore
-.npmignore
-.prettierignore
-.prettierrc.json
-LICENSE
-package.json
-package-lock.json
-README.md

package/codecov.SHA256SUM

@@ -1 +0,0 @@
-ca1d64196d2d34771084afe76ea657d581bf628e31d993ff8e52ea09cc88a56d  codecov

package/codecov.SHA256SUM.sig

@@ -1,16 +0,0 @@
------BEGIN PGP SIGNATURE-----
-
-iQIzBAABCgAdFiEEJwNOf9uFDgu8LGL/gGuyiu13mGkFAmpO+3UACgkQgGuyiu13
-mGm0UxAAne5/lA7YQHQlWt455twIGwZgcSX13LTQw45+goIfZC7IGDQ7J6/kLyJG
-sGvkfSmYEODgsgo6474CWcm16VPMZa3QWa4z6EdfyNHhDo5nNe358ZPA1dOemMKZ
-eV2/9WpDcIEIAhsCj8HKjNjsLBcGrAQRbOw2tABg2dbE8Yg94SMdEqjMCswOQn3i
-OPsybWDjbAdqUVIWylUXbned5/hVnzNAMeo6WvC5+LNw1iS+8rzSIUu5iSxCz9jV
-XBe0ZNZ/z1jLZ0NHQXWoOWVT6aHI3Aml/V+ttduuSPwVqWUtqT+XWnnxXJlkt3fQ
-uB8Fy9NBkj5qkls81pUyt0Z9QuMvnI/OxWiUZ6jOEItiZMkK87ryPiheBoaU4kuf
-fcpoRz/EVNsAgcrHBFQCiam7I32h5R5O9orDiU4pKzahSdgelnvOPIZQzSKT5m/M
-50tuts7npVQib2op7XCv+6d3t8ZnUHzXnqiej6n/vWxE3nWJiw39a5ww7RDO1RQB
-8oNPX3qvPGpNmspXSf57oLyJqiSs4t7B9yIacCMPnlVDZt3MseXP/UHH7cXMmRuX
-bU2mkdieBgkGtkNkB76sp/ob5FWQmynW1+Q3ZcDGrGeysnRgDGWD2Yy92lcABZDc
-DXolC9kpvP+UrUXG5XSTIKksMbH4YacgNIKHzwyhOgViMLWBA4g=
-=fH2Y
------END PGP SIGNATURE-----

package/docs/AdditionalConfiguration.md

@@ -1,155 +0,0 @@
-# Configuration Options
-
-## Disabling scenario / step definition validation
-
-Cucumber's approach is to start with your feature file and execute the step definitions in the order defined in the feature file. In contrast, jest-cucumber scenarios are merely Jest tests. In order to provide the same ability as Cucumber to keep the feature files and step definitions in sync, jest-cucumber validates your step definitions against the feature file.
-
-By default, this step definition / feature file validation is enabled. If you have scenarios that are defined in the feature file, but not in your step definitions for that feature file, jest-cucumber will raise an error (and provide starter code). If you have scenarios defined in your step definitions for that aren't in your feature file, jest-cucumber will also raise an error. Additionally, jest-cucumber also validates that the steps you define within your scenarios match the steps that are defined in the feature file, and are in the same order. 
-
-If you would prefer not to have more control over what validation occurs the following options are available:
-
-```javascript
-const { Given, When, Then, And, But, Fusion } = require( 'jest-cucumber-fusion' )
-
-
-//your javascript tests
-//....
-//Given( ...
-// 
-
-
-Fusion( 'rocket-launching.feature', {
-  errors: {
-    missingScenarioInStepDefinitions: true, // Error when a scenario is in the feature file, but not in the step definition
-    missingStepInStepDefinitions: true, // Error when a step is in the feature file, but not in the step definitions
-    missingScenarioInFeature: true, // Error when a scenario is in the step definitions, but not in the feature
-    missingStepInFeature: true, // Error when a step is in the step definitions, but not in the feature
-  }
-} )
-```
-
-## Tag filtering
-
-You can specify a tag filter. Tag filters will cause any scenario that is filtered out via a tag filter to be skipped.
-
-For example, consider the following feature file:
-
-```gherkin
-Feature: Tagged scenarios
-
-  @included
-  Scenario: Tagged scenario that is included
-    Given my scenario has a tag that is included in my jest-cucumber step definitions tag filter
-    But I don't have that scenario defined in my step definitions
-    When I execute my jest-cucumber scenarios
-    Then jest-cucumber should show me an error
-  
-  @excluded
-  Scenario: Tagged scenario that is not included
-    Given my scenario has a tag that is NOT included in my jest-cucumber step definitions tag filter
-    But I don't have that scenario defined in my step definitions
-    When I execute my jest-cucumber scenarios
-    Then jest-cucumber should NOT show me an error
-```
-
-Consider the following step definitions file:
-
-```javascript
-const { Given, When, Then, And, But, Fusion } = require( 'jest-cucumber-fusion' )
-
-
-//your javascript tests
-//....
-//Given( ...
-// 
-
-
-Fusion( 'rocket-launching.feature', { tagFilter: '@included and not @excluded' } )
-```
-
-In this case, the scenario tagged `@included` will be run, and the scenario tagged `@excluded` will be skipped. The tag filtering expressions are very powerful and can include `not`, `and`, `or`, as well as parenthesis.
-
-## Scenario title templates
-
-In some cases, having more control over the scenario titles is desired. For example, imagine scenarios that are tagged with with issue ids like so:
-
-```
-Feature: Tagged scenarios
-
-    @issue-1234
-    Scenario: Scenario tagged with issue
-        ...
-        ...
-        ...        
-```
-
-Use a `scenarioNameTemplate` function to be provided to generate the scenario title as desired. For example:
-
-```javascript
-const { Given, When, Then, And, But, Fusion } = require( 'jest-cucumber-fusion' )
-
-
-//your javascript tests
-//....
-//Given( ...
-// 
-
-
-Fusion( 'rocket-launching.feature', {
-    scenarioNameTemplate: (vars) => {
-        return `${vars.scenarioTitle} (${vars.scenarioTags.join(',')})`
-    }
-} )
-```
-
-The output scenario title in this case would be `Scenario tagged with issue (issue-1234)`.
-
-The following info is available in the `vars` argument:
-
-* `featureTitle` - string
-* `featureTags` - string[]
-* `scenarioTitle` - string
-* `scenarioTags` - string[]
-
-## Relative feature file paths
-
-It might feel more natural to load feature files with paths relative to the file loading the feature, instead of relative to the project root. This is possible with help of the `loadRelativePath` flag:
-
-```javascript
-Fusion( 'rocket-launching.feature', { loadRelativePath: true } )
-```
-
-Please note that the path will be relative to the file that calls `Fusion`, so if you use helper files which call `Fusion` for you this might lead to unexpected results.
-Like all other flags you can set the flag globally to always use relative imports.
-
-## Global configuration
-
-To avoid repeating the same configuration settings in every step definition file, it is also possible to specify configuration parameters globally. Note that configuration settings specified in step definition files take precedence over global configuration.
-
-To enable global configuration, you have to use the jest-cucumber global configuration.
-First specify a configuration JavaScript file in your the `setupFiles` section of your Jest configuration like so:
-
-```javascript
-{
-  ...
-  "setupFiles": [
-    "./jest-cucumber-config"
-  ],
-  ...
-}
-```
-
-And setup the configuration JavaScript file, like so:
-
-```javascript
-//jest-cucumber-config.js
-
-const setJestCucumberConfiguration = require('jest-cucumber').setJestCucumberConfiguration;
-
-setJestCucumberConfiguration({
-  tagFilter: '@ui and not @slow',
-  scenarioNameTemplate: (vars) => {
-      return ` ${vars.featureTitle} - ${vars.scenarioTitle}}`;
-  }
-});
-```

package/docs/GherkinTables.md

@@ -1,61 +0,0 @@
-# Gherkin tables
-
-```gherkin
-Feature: Todo List
-
-Scenario: Adding an item to my todo list
-  Given my todo list currently looks as follows:
-  | TaskName            | Priority |
-  | Fix bugs in my code | medium   |
-  | Document my hours   | medium   |
-  When I add the following task:
-  | TaskName                              | Priority |
-  | Watch cat videos on YouTube all day   | high     |
-  Then I should see the following todo list:
-  | TaskName                              | Priority |  
-  | Watch cat videos on YouTube all day   | high     |
-  | Sign up for unemployment              | high     |
-```
-
-```javascript
-const { Before, After, Given, When, Then, Fusion } = require( 'jest-cucumber-fusion' )
-
-const { TodoList } = require( '../../src/todo-list' )
-let todoList
-
-
-Before( () => { todoList = new TodoList(); } )
-
-Given( 'my todo list currently looks as follows:', table => {
-    table.forEach(row => {
-        todoList.add( {
-            name: row.TaskName,
-            priority: row.Priority
-        } )
-    } )
-} )
-
-When( 'I add the following task:', table => {
-    todoList.add({
-        name: table[0].TaskName,
-        priority: table[0].Priority
-    })
-})
-
-Then( 'I should see the following todo list:', table => {
-    expect(todoList.items.length).toBe(table.length)
-
-    table.forEach((row, index) => {
-        expect(todoList.items[index].name).toBe(table[index].TaskName)
-        expect(todoList.items[index].priority).toBe(table[index].Priority)
-    } )
-} )
-
-After( () => {
-    const emptyTodo = new TodoList()
-    emptyTodo.add( { name: 'Empty on purpose', priority: 'so low' } )
-} )
-
-
-Fusion( '../features/using-gherkin-tables.feature' )
-```

package/docs/Language.md

@@ -1,76 +0,0 @@
-# Language
-
-You can use different languages in jest-cucumber-fusion by adding a `# language:` header, 
-for example `# language: nl` for dutch. 
-If you don't set any header the default language will be English (`en`).
-
-Ghenkin has translated over 70 [languages](https://cucumber.io/docs/gherkin/languages/).
-
-An example of a feature file in the dutch (nl) language:
-
-```gherkin
-# language: nl
-
-Functionaliteit: Online verkopen
-
-    Scenario: t-shirt verkopen
-        Gegeven ik heb een t-shirt
-        Als ik een t-shirt wil verkopen
-        Dan ontvang ik €22
-        En ben ik blij
-        Maar heb ik geen t-shirts over
-```
-Most modern IDE's (or plugin) will support this feature and autocomplete keywords when using with a language.
-
-The step-file can be defined as normal like:
-
-```javascript
-const { Before, Given, When, Then, Fusion, And, But } = require('../../../../src')
-
-const { OnlineSales } = require('../../../src/online-sales')
-
-let onlineSales
-let salesPrice
-
-Before(() => { onlineSales = new OnlineSales() })
-
-Given(/^ik heb een t-shirt$/, item => {
-    onlineSales.listItem('Rick Astley t-shirt')
-})
-
-When(/^ik een t-shirt wil verkopen$/, item => {
-    salesPrice = onlineSales.sellItem('Rick Astley t-shirt')
-})
-...
-```
-
-Optionally you can also translate the keywords in your step-files like so:
-
-```javascript
-import {
-    Before, 
-    Given as Gegeven, 
-    When as Wanneer, 
-    Then as Dan, 
-    Fusion, 
-    And as En, 
-    But as Maar
-} from '../../../../src'
-
-const { OnlineSales } = require('../../../src/online-sales')
-
-let onlineSales
-let salesPrice
-
-Before(() => { onlineSales = new OnlineSales() })
-
-Given(/^ik heb een t-shirt$/, item => {
-    onlineSales.listItem('Rick Astley t-shirt')
-})
-
-When(/^ik een t-shirt wil verkopen$/, item => {
-    salesPrice = onlineSales.sellItem('Rick Astley t-shirt')
-})
-...
-```
-This example used `import` which requires ES6.

package/docs/ReusingStepDefinitions.md

@@ -1,110 +0,0 @@
-# Re-using step definitions
-
-One of the advantage of using jest-cucumber-fusion is that it will manage your test suite scope inside its execution
-Your automation code easy to read: it reads pretty much like your feature file. 
-You can then reuse the same steps repeatedly in multiple scenarios.
-
-It is normally recommended that your test code contain as little logic as possible, with common setup logic abstracted into other modules (e.g., test data creation), so there really shouldn't be much duplicated code in the first place. To further reduce duplicated code, you could do something like this:
-```gherkin
-# reuse-rocket.feature
-Feature: Rocket reuse
-
-Scenario: Reusing a SpaceX rocket
-  Given I am Elon Musk and I launched a rocket in space already
-  Then I'm happy
-```
-
-Write you step definitions as usual but require (or import) your shared step definition file
-```javascript
-// reuse-rocket.steps.js
-const { Given, Fusion } = require( 'jest-cucumber-fusion' )
-
-
-
-Given( 'I am Elon Musk and I launched a rocket in space already', () => {
-    const hasLaunchedARocket = true
-    expect( hasLaunchedARocket ).toBe( true )
-} )
-
-///
-///This is our shared test code
-///
-require( './reuse-code' )
-
-
-Fusion( '../reuse-rocket.feature' )
-```
-
-Place you shared step definitions in a shared step definition file, jest-cucumber-fusion takes care of the rest
-```javascript
-// reuse-code.js
-const { Then } = require( 'jest-cucumber-fusion' )
-
-Then( 'I\'m happy', () => {
-    const localHappy = true
-    expect( localHappy ).toBe( true )
-} )
-```
-
-
-### Managing dependencies
-Though it is not best practice, you sometime need to pass value to the shared step definitions file, like in this example:
-
-```gherkin
-# reuse-rocket.feature
-Feature: Rocket reuse
-
-Scenario: Reusing a SpaceX rocket
-  Given I am Elon Musk and I launched a rocket in space already
-  When I relaunch the rocket
-  Then the rocket end up in space again
-  And I drop my mic
-```
-
-
-You will now need to encapsulate the variables in an accessor function and pass the accessor to the constructor/init of your file
-```javascript
-// reuse-rocket.steps.js
-const { Given, Fusion } = require( 'jest-cucumber-fusion' )
-
-const { Rocket } = require( '../../../src/rocket' )
-
-let rocket
-function getCurrentRocket() {
-	return rocket
-}
-
-Given( 'I am Elon Musk and I launched a rocket in space already', () => {
-	rocket = new Rocket()
-} )
-
-
-require( './reuse-code' )( getCurrentRocket )
-
-
-Fusion( '../reuse-definition.feature' )
-```
-
-
-Inside you shared step file, be careful to call the accessor inside your test step function not outside
-```javascript
-// reuse-code.js
-const { When, Then, And } = require( 'jest-cucumber-fusion' )
-
-And( 'I drop my mic', () => {  
-    const micDropped = true
-    expect( micDropped ).toBe( true )
-} )
-
-module.exports = exports = function( fnRocket ) {
-	When( 'I relaunch the rocket', () => {
-            const rocketUsed = fnRocket()
-            rocketUsed.launch()
-	} )
-	
-	Then( 'the rocket end up in space again', () => {
-            const rocketUsed = fnRocket()
-            expect( rocketUsed.isInSpace ).toBe(true)
-	} )
-}
-```

package/docs/RunningTheExamples.md

@@ -1,16 +0,0 @@
-# Running the examples
-
-Note that examples are provided in both ECMAScript and TypeScript.
-
-First, build jest-cucumber-fusion: 
-
-```
-$ npm install
-```
-
-## Running examples from the CMD line
-
-
-```
-$ npm test
-```

package/docs/ScenarioOutlines.md

@@ -1,43 +0,0 @@
-# Scenario outlines
-
-```gherkin
-Feature: Online sales
-
-Scenario Outline: Selling an item
-  Given I have a(n) <Item>
-  When I sell the <Item>
-  Then I should get $<Amount>
-
-  Examples:
-
-  | Item                                           | Amount |
-  | Autographed Neil deGrasse Tyson book           | 100    |
-  | Rick Astley t-shirt                            | 22     |
-  | An idea to replace EVERYTHING with blockchains | $0     |
-```
-
-```javascript
-const { Before, Given, When, Then, Fusion } = require( '../../../../src' )
-
-const { OnlineSales } = require( '../../../src/online-sales' )
-let onlineSales
-let salesPrice
-
-
-Before( () => { onlineSales = new OnlineSales() } )
-
-Given( /^I have a\(n\) (.*)$/, item => {
-    onlineSales.listItem(item)
-} )
-
-When( /^I sell the (.*)$/, item => {
-    salesPrice = onlineSales.sellItem(item)
-} )
-
-Then( /^I should get \$(\d+)$/, expectedSalesPrice => {
-    expect(salesPrice).toBe(parseInt(expectedSalesPrice))
-} )
-
-
-Fusion( '../scenario-outlines.feature' )
-```

package/docs/StepDefinitionArguments.md

@@ -1,37 +0,0 @@
-## Step definition arguments
-
-```gherkin
-Feature: Getting rich writing software
-
-Scenario: Depositing a paycheck
-  Given my account balance is $10
-  When I get paid $1000000 for writing some awesome code
-  Then my account balance should be $1000010
-```
-
-```javascript
-const { Before, Given, When, Then, Fusion } = require( '../../../../src' )
-
-const { BankAccount } = require( '../../../src/bank-account' )
-let myAccount
-
-
-Before( () => { myAccount = new BankAccount() } )
-
-
-Given(/^my account balance is \$(\d+)$/, balance => {
-    myAccount.deposit(parseInt(balance))
-} )
-
-When(/^I get paid \$(\d+) for writing some awesome code$/, paycheck => {
-    myAccount.deposit(parseInt(paycheck))
-} )
-
-Then(/^my account balance should be \$(\d+)$/, expectedBalance => {
-    expect(myAccount.balance).toBe(parseInt(expectedBalance))
-} )
-
-
-Fusion( '../using-dynamic-values.feature' )
-
-```