Skip to content

Add support for Scenario Outline and Examples#13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DannyBen merged 1 commit into from
Jul 11, 2026
Merged

Add support for Scenario Outline and Examples#13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@ Implemented pieces include:
- `Background`, `Scenario`, `Given` / `When` / `Then`, `And` / `But`, and `*`
- doc strings via Gherkin-style `"""` blocks exposed as `DOC_STRING`
- data tables exposed as `TABLE_HEADER` and `TABLE_ROWS` arrays
- `Scenario Outline` expansion from one `Examples` table
- colored terminal output and scenario summary

### Gherkin Feature Support
Expand All@@ -88,9 +89,9 @@ Implemented pieces include:
| `Before`, `After` hooks | Supported |
| `BeforeAll`, `AfterAll` hooks | Supported |
| Data tables | Supported |
| `Scenario Outline` | Supported |
| `Examples` | Supported |
| `Rule` | Unsupported |
| `Scenario Outline` | Unsupported |
| `Examples` | Unsupported |

Tags can be selected with `--tag` / `-t` and skipped with `--exclude-tag` / `-x`.
`@Before` and `@After` hooks are declared in step definition files and may be
Expand Down
30 changes: 26 additions & 4 deletions doc/shellkin-feature.5
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,8 @@ Shellkin currently supports these Gherkin keywords:
.IP \(bu 2
\f[B]Scenario\f[R]
.IP \(bu 2
\f[B]Scenario Outline\f[R], \f[B]Examples\f[R]
.IP \(bu 2
\f[B]Given\f[R], \f[B]When\f[R], \f[B]Then\f[R]
.IP \(bu 2
\f[B]And\f[R], \f[B]But\f[R], \f[B]*\f[R]
Expand DownExpand Up@@ -53,6 +55,30 @@ in the feature.
Background:
Given I am in a temp directory
.EE
.SS Scenario Outline
Use \f[B]Scenario Outline:\f[R] with one \f[B]Examples:\f[R] table to
run the same scenario with several values.
Each Examples row is a separate scenario.
.IP
.EX
Scenario Outline: Creating <name> as <role>
When I register user \(aq<name>\(aq with role \(aq<role>\(aq
Then user \(aq<name>\(aq should have role \(aq<role>\(aq

Examples:
| name | role |
| Alice | admin |
| Bob | member |
.EE
.PP
Placeholders may appear in the scenario name, steps, doc strings, and
data table cells.
Every placeholder must have a matching Examples column.
Examples headings must be unique, and all rows must have the same number
of cells.
.PP
Shellkin currently supports one Examples block per Scenario Outline.
Tags on Examples blocks are not supported.
.SS Steps
Supported step keywords are \f[B]Given\f[R], \f[B]When\f[R],
\f[B]Then\f[R], \f[B]And\f[R], \f[B]But\f[R], and \f[B]*\f[R].
Expand DownExpand Up@@ -147,10 +173,6 @@ Escaped pipe characters in cells are not currently supported.
The following common Gherkin constructs are not currently supported:
.IP \(bu 2
\f[B]Rule\f[R]
.IP \(bu 2
\f[B]Scenario Outline\f[R]
.IP \(bu 2
\f[B]Examples\f[R]
.SH EXAMPLE
.IP
.EX
Expand Down
27 changes: 25 additions & 2 deletions doc/shellkin-feature.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ Shellkin currently supports these Gherkin keywords:
- **Feature**
- **Background**
- **Scenario**
- **Scenario Outline**, **Examples**
- **Given**, **When**, **Then**
- **And**, **But**, **\***
- data tables
Expand DownExpand Up@@ -72,6 +73,30 @@ Background:
Given I am in a temp directory
```

Scenario Outline
--------------------------------------------------

Use **Scenario Outline:** with one **Examples:** table to run the same scenario
with several values. Each Examples row is a separate scenario.

```gherkin
Scenario Outline: Creating <name> as <role>
When I register user '<name>' with role '<role>'
Then user '<name>' should have role '<role>'

Examples:
| name | role |
| Alice | admin |
| Bob | member |
```

Placeholders may appear in the scenario name, steps, doc strings, and data
table cells. Every placeholder must have a matching Examples column. Examples
headings must be unique, and all rows must have the same number of cells.

Shellkin currently supports one Examples block per Scenario Outline. Tags on
Examples blocks are not supported.

Steps
--------------------------------------------------

Expand DownExpand Up@@ -177,8 +202,6 @@ UNSUPPORTED CONSTRUCTS
The following common Gherkin constructs are not currently supported:

- **Rule**
- **Scenario Outline**
- **Examples**

EXAMPLE
==================================================
Expand Down
14 changes: 14 additions & 0 deletions features/fixtures/scenario_outlines/scenario_outlines.feature
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
Feature: scenario outlines
Run the same scenario with several examples

Background:
Given the user registry is empty

Scenario Outline: Creating <name> as <role>
When I register user '<name>' with role '<role>'
Then user '<name>' should have role '<role>'

Examples:
| name | role |
| Alice | admin |
| Bob | member |
17 changes: 17 additions & 0 deletions features/fixtures/scenario_outlines/step_definitions/core.sh
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
@Given the user registry is empty
USER_NAMES=()
USER_ROLES=()

@When I register user '{name}' with role '{role}'
USER_NAMES+=("$name")
USER_ROLES+=("$role")

@Then user '{name}' should have role '{role}'
for index in "${!USER_NAMES[@]}"; do
if [[ ${USER_NAMES[$index]} == "$name" ]]; then
[[ ${USER_ROLES[$index]} == "$role" ]]
return
fi
done

fail "user not found: $name"
15 changes: 15 additions & 0 deletions features/test.feature
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,21 @@ Scenario: Running a feature that uses a data table
And the output should include '1 scenario, 0 failing'
And the exit code should mean success

Scenario: Running a scenario outline
When I run 'shellkin features/fixtures/scenario_outlines'
Then the output should include 'Feature: scenario outlines'
And the output should include 'Scenario 1: Creating Alice as admin'
And the output should include 'Scenario 2: Creating Bob as member'
And the output should include '2 scenarios, 0 failing'
And the exit code should mean success

Scenario: Selecting one expanded scenario outline row
When I run 'shellkin features/fixtures/scenario_outlines:2'
Then the output should include 'Scenario 2: Creating Bob as member'
And the output should not include 'Creating Alice as admin'
And the output should include '1 scenario, 0 failing'
And the exit code should mean success

Scenario: Running a failing test
When I run 'shellkin features/fixtures/selective/failing.feature'
Then the output should include 'Feature: two'
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Add support for `Scenario Outline` and `Examples` by DannyBen · Pull Request #13 · DannyBen/shellkin · GitHub
Skip to content
Add support for Scenario Outline and Examples#13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

DannyBen
merged 1 commit into

from

Jul 11, 2026
 Merged


Add support for Scenario Outline and Examples#13
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 3 additions & 2 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@ Implemented pieces include:
- `Background`, `Scenario`, `Given` / `When` / `Then`, `And` / `But`, and `*`
- doc strings via Gherkin-style `"""` blocks exposed as `DOC_STRING`
- data tables exposed as `TABLE_HEADER` and `TABLE_ROWS` arrays
- `Scenario Outline` expansion from one `Examples` table
- colored terminal output and scenario summary

### Gherkin Feature Support
Expand All@@ -88,9 +89,9 @@ Implemented pieces include:
| `Before`, `After` hooks | Supported |
| `BeforeAll`, `AfterAll` hooks | Supported |
| Data tables | Supported |
| `Scenario Outline` | Supported |
| `Examples` | Supported |
| `Rule` | Unsupported |
| `Scenario Outline` | Unsupported |
| `Examples` | Unsupported |

Tags can be selected with `--tag` / `-t` and skipped with `--exclude-tag` / `-x`.
`@Before` and `@After` hooks are declared in step definition files and may be
Expand Down

30 changes: 26 additions & 4 deletions
doc/shellkin-feature.5

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,8 @@ Shellkin currently supports these Gherkin keywords:
.IP \(bu 2
\f[B]Scenario\f[R]
.IP \(bu 2
\f[B]Scenario Outline\f[R], \f[B]Examples\f[R]
.IP \(bu 2
\f[B]Given\f[R], \f[B]When\f[R], \f[B]Then\f[R]
.IP \(bu 2
\f[B]And\f[R], \f[B]But\f[R], \f[B]*\f[R]
Expand DownExpand Up@@ -53,6 +55,30 @@ in the feature.
Background:
 Given I am in a temp directory
.EE
.SS Scenario Outline
Use \f[B]Scenario Outline:\f[R] with one \f[B]Examples:\f[R] table to
run the same scenario with several values.
Each Examples row is a separate scenario.
.IP
.EX
Scenario Outline: Creating <name> as <role>
 When I register user \(aq<name>\(aq with role \(aq<role>\(aq
 Then user \(aq<name>\(aq should have role \(aq<role>\(aq

Examples:
 | name | role |
 | Alice | admin |
 | Bob | member |
.EE
.PP
Placeholders may appear in the scenario name, steps, doc strings, and
data table cells.
Every placeholder must have a matching Examples column.
Examples headings must be unique, and all rows must have the same number
of cells.
.PP
Shellkin currently supports one Examples block per Scenario Outline.
Tags on Examples blocks are not supported.
.SS Steps
Supported step keywords are \f[B]Given\f[R], \f[B]When\f[R],
\f[B]Then\f[R], \f[B]And\f[R], \f[B]But\f[R], and \f[B]*\f[R].
Expand DownExpand Up@@ -147,10 +173,6 @@ Escaped pipe characters in cells are not currently supported.
The following common Gherkin constructs are not currently supported:
.IP \(bu 2
\f[B]Rule\f[R]
.IP \(bu 2
\f[B]Scenario Outline\f[R]
.IP \(bu 2
\f[B]Examples\f[R]
.SH EXAMPLE
.IP
.EX
Expand Down

27 changes: 25 additions & 2 deletions
doc/shellkin-feature.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ Shellkin currently supports these Gherkin keywords:
- **Feature**
- **Background**
- **Scenario**
- **Scenario Outline**, **Examples**
- **Given**, **When**, **Then**
- **And**, **But**, **\***
- data tables
Expand DownExpand Up@@ -72,6 +73,30 @@ Background:
 Given I am in a temp directory
```

Scenario Outline
--------------------------------------------------

Use **Scenario Outline:** with one **Examples:** table to run the same scenario
with several values. Each Examples row is a separate scenario.

```gherkin
Scenario Outline: Creating <name> as <role>
 When I register user '<name>' with role '<role>'
 Then user '<name>' should have role '<role>'

Examples:
 | name | role |
 | Alice | admin |
 | Bob | member |
```

Placeholders may appear in the scenario name, steps, doc strings, and data
table cells. Every placeholder must have a matching Examples column. Examples
headings must be unique, and all rows must have the same number of cells.

Shellkin currently supports one Examples block per Scenario Outline. Tags on
Examples blocks are not supported.

Steps
--------------------------------------------------

Expand DownExpand Up@@ -177,8 +202,6 @@ UNSUPPORTED CONSTRUCTS
The following common Gherkin constructs are not currently supported:

- **Rule**
- **Scenario Outline**
- **Examples**

EXAMPLE
==================================================
Expand Down

14 changes: 14 additions & 0 deletions
features/fixtures/scenario_outlines/scenario_outlines.feature

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
Feature: scenario outlines
 Run the same scenario with several examples

Background:
 Given the user registry is empty

Scenario Outline: Creating <name> as <role>
 When I register user '<name>' with role '<role>'
 Then user '<name>' should have role '<role>'

Examples:
 | name | role |
 | Alice | admin |
 | Bob | member |

17 changes: 17 additions & 0 deletions
features/fixtures/scenario_outlines/step_definitions/core.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
@Given the user registry is empty
 USER_NAMES=()
 USER_ROLES=()

@When I register user '{name}' with role '{role}'
 USER_NAMES+=("$name")
 USER_ROLES+=("$role")

@Then user '{name}' should have role '{role}'
 for index in "${!USER_NAMES[@]}"; do
 if [[ ${USER_NAMES[$index]} == "$name" ]]; then
 [[ ${USER_ROLES[$index]} == "$role" ]]
 return
 fi
 done

 fail "user not found: $name"

15 changes: 15 additions & 0 deletions
features/test.feature

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,21 @@ Scenario: Running a feature that uses a data table
 And the output should include '1 scenario, 0 failing'
 And the exit code should mean success

Scenario: Running a scenario outline
 When I run 'shellkin features/fixtures/scenario_outlines'
 Then the output should include 'Feature: scenario outlines'
 And the output should include 'Scenario 1: Creating Alice as admin'
 And the output should include 'Scenario 2: Creating Bob as member'
 And the output should include '2 scenarios, 0 failing'
 And the exit code should mean success

Scenario: Selecting one expanded scenario outline row
 When I run 'shellkin features/fixtures/scenario_outlines:2'
 Then the output should include 'Scenario 2: Creating Bob as member'
 And the output should not include 'Creating Alice as admin'
 And the output should include '1 scenario, 0 failing'
 And the exit code should mean success

Scenario: Running a failing test
 When I run 'shellkin features/fixtures/selective/failing.feature'
 Then the output should include 'Feature: two'
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add support for `Scenario Outline` and `Examples` by DannyBen · Pull Request #13 · DannyBen/shellkin · GitHub
Skip to content
Add support for Scenario Outline and Examples#13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

DannyBen
merged 1 commit into

from

Jul 11, 2026
 Merged


Add support for Scenario Outline and Examples#13
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 3 additions & 2 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@ Implemented pieces include:
- `Background`, `Scenario`, `Given` / `When` / `Then`, `And` / `But`, and `*`
- doc strings via Gherkin-style `"""` blocks exposed as `DOC_STRING`
- data tables exposed as `TABLE_HEADER` and `TABLE_ROWS` arrays
- `Scenario Outline` expansion from one `Examples` table
- colored terminal output and scenario summary

### Gherkin Feature Support
Expand All@@ -88,9 +89,9 @@ Implemented pieces include:
| `Before`, `After` hooks | Supported |
| `BeforeAll`, `AfterAll` hooks | Supported |
| Data tables | Supported |
| `Scenario Outline` | Supported |
| `Examples` | Supported |
| `Rule` | Unsupported |
| `Scenario Outline` | Unsupported |
| `Examples` | Unsupported |

Tags can be selected with `--tag` / `-t` and skipped with `--exclude-tag` / `-x`.
`@Before` and `@After` hooks are declared in step definition files and may be
Expand Down

30 changes: 26 additions & 4 deletions
doc/shellkin-feature.5

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,8 @@ Shellkin currently supports these Gherkin keywords:
.IP \(bu 2
\f[B]Scenario\f[R]
.IP \(bu 2
\f[B]Scenario Outline\f[R], \f[B]Examples\f[R]
.IP \(bu 2
\f[B]Given\f[R], \f[B]When\f[R], \f[B]Then\f[R]
.IP \(bu 2
\f[B]And\f[R], \f[B]But\f[R], \f[B]*\f[R]
Expand DownExpand Up@@ -53,6 +55,30 @@ in the feature.
Background:
 Given I am in a temp directory
.EE
.SS Scenario Outline
Use \f[B]Scenario Outline:\f[R] with one \f[B]Examples:\f[R] table to
run the same scenario with several values.
Each Examples row is a separate scenario.
.IP
.EX
Scenario Outline: Creating <name> as <role>
 When I register user \(aq<name>\(aq with role \(aq<role>\(aq
 Then user \(aq<name>\(aq should have role \(aq<role>\(aq

Examples:
 | name | role |
 | Alice | admin |
 | Bob | member |
.EE
.PP
Placeholders may appear in the scenario name, steps, doc strings, and
data table cells.
Every placeholder must have a matching Examples column.
Examples headings must be unique, and all rows must have the same number
of cells.
.PP
Shellkin currently supports one Examples block per Scenario Outline.
Tags on Examples blocks are not supported.
.SS Steps
Supported step keywords are \f[B]Given\f[R], \f[B]When\f[R],
\f[B]Then\f[R], \f[B]And\f[R], \f[B]But\f[R], and \f[B]*\f[R].
Expand DownExpand Up@@ -147,10 +173,6 @@ Escaped pipe characters in cells are not currently supported.
The following common Gherkin constructs are not currently supported:
.IP \(bu 2
\f[B]Rule\f[R]
.IP \(bu 2
\f[B]Scenario Outline\f[R]
.IP \(bu 2
\f[B]Examples\f[R]
.SH EXAMPLE
.IP
.EX
Expand Down

27 changes: 25 additions & 2 deletions
doc/shellkin-feature.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ Shellkin currently supports these Gherkin keywords:
- **Feature**
- **Background**
- **Scenario**
- **Scenario Outline**, **Examples**
- **Given**, **When**, **Then**
- **And**, **But**, **\***
- data tables
Expand DownExpand Up@@ -72,6 +73,30 @@ Background:
 Given I am in a temp directory
```

Scenario Outline
--------------------------------------------------

Use **Scenario Outline:** with one **Examples:** table to run the same scenario
with several values. Each Examples row is a separate scenario.

```gherkin
Scenario Outline: Creating <name> as <role>
 When I register user '<name>' with role '<role>'
 Then user '<name>' should have role '<role>'

Examples:
 | name | role |
 | Alice | admin |
 | Bob | member |
```

Placeholders may appear in the scenario name, steps, doc strings, and data
table cells. Every placeholder must have a matching Examples column. Examples
headings must be unique, and all rows must have the same number of cells.

Shellkin currently supports one Examples block per Scenario Outline. Tags on
Examples blocks are not supported.

Steps
--------------------------------------------------

Expand DownExpand Up@@ -177,8 +202,6 @@ UNSUPPORTED CONSTRUCTS
The following common Gherkin constructs are not currently supported:

- **Rule**
- **Scenario Outline**
- **Examples**

EXAMPLE
==================================================
Expand Down

14 changes: 14 additions & 0 deletions
features/fixtures/scenario_outlines/scenario_outlines.feature

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
Feature: scenario outlines
 Run the same scenario with several examples

Background:
 Given the user registry is empty

Scenario Outline: Creating <name> as <role>
 When I register user '<name>' with role '<role>'
 Then user '<name>' should have role '<role>'

Examples:
 | name | role |
 | Alice | admin |
 | Bob | member |

17 changes: 17 additions & 0 deletions
features/fixtures/scenario_outlines/step_definitions/core.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
@Given the user registry is empty
 USER_NAMES=()
 USER_ROLES=()

@When I register user '{name}' with role '{role}'
 USER_NAMES+=("$name")
 USER_ROLES+=("$role")

@Then user '{name}' should have role '{role}'
 for index in "${!USER_NAMES[@]}"; do
 if [[ ${USER_NAMES[$index]} == "$name" ]]; then
 [[ ${USER_ROLES[$index]} == "$role" ]]
 return
 fi
 done

 fail "user not found: $name"

15 changes: 15 additions & 0 deletions
features/test.feature

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,21 @@ Scenario: Running a feature that uses a data table
 And the output should include '1 scenario, 0 failing'
 And the exit code should mean success

Scenario: Running a scenario outline
 When I run 'shellkin features/fixtures/scenario_outlines'
 Then the output should include 'Feature: scenario outlines'
 And the output should include 'Scenario 1: Creating Alice as admin'
 And the output should include 'Scenario 2: Creating Bob as member'
 And the output should include '2 scenarios, 0 failing'
 And the exit code should mean success

Scenario: Selecting one expanded scenario outline row
 When I run 'shellkin features/fixtures/scenario_outlines:2'
 Then the output should include 'Scenario 2: Creating Bob as member'
 And the output should not include 'Creating Alice as admin'
 And the output should include '1 scenario, 0 failing'
 And the exit code should mean success

Scenario: Running a failing test
 When I run 'shellkin features/fixtures/selective/failing.feature'
 Then the output should include 'Feature: two'
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add support for `Scenario Outline` and `Examples` by DannyBen · Pull Request #13 · DannyBen/shellkin · GitHub
Skip to content
Add support for Scenario Outline and Examples#13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

DannyBen
merged 1 commit into

from

Jul 11, 2026
 Merged


Add support for Scenario Outline and Examples#13
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 3 additions & 2 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@ Implemented pieces include:
- `Background`, `Scenario`, `Given` / `When` / `Then`, `And` / `But`, and `*`
- doc strings via Gherkin-style `"""` blocks exposed as `DOC_STRING`
- data tables exposed as `TABLE_HEADER` and `TABLE_ROWS` arrays
- `Scenario Outline` expansion from one `Examples` table
- colored terminal output and scenario summary

### Gherkin Feature Support
Expand All@@ -88,9 +89,9 @@ Implemented pieces include:
| `Before`, `After` hooks | Supported |
| `BeforeAll`, `AfterAll` hooks | Supported |
| Data tables | Supported |
| `Scenario Outline` | Supported |
| `Examples` | Supported |
| `Rule` | Unsupported |
| `Scenario Outline` | Unsupported |
| `Examples` | Unsupported |

Tags can be selected with `--tag` / `-t` and skipped with `--exclude-tag` / `-x`.
`@Before` and `@After` hooks are declared in step definition files and may be
Expand Down

30 changes: 26 additions & 4 deletions
doc/shellkin-feature.5

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,8 @@ Shellkin currently supports these Gherkin keywords:
.IP \(bu 2
\f[B]Scenario\f[R]
.IP \(bu 2
\f[B]Scenario Outline\f[R], \f[B]Examples\f[R]
.IP \(bu 2
\f[B]Given\f[R], \f[B]When\f[R], \f[B]Then\f[R]
.IP \(bu 2
\f[B]And\f[R], \f[B]But\f[R], \f[B]*\f[R]
Expand DownExpand Up@@ -53,6 +55,30 @@ in the feature.
Background:
 Given I am in a temp directory
.EE
.SS Scenario Outline
Use \f[B]Scenario Outline:\f[R] with one \f[B]Examples:\f[R] table to
run the same scenario with several values.
Each Examples row is a separate scenario.
.IP
.EX
Scenario Outline: Creating <name> as <role>
 When I register user \(aq<name>\(aq with role \(aq<role>\(aq
 Then user \(aq<name>\(aq should have role \(aq<role>\(aq

Examples:
 | name | role |
 | Alice | admin |
 | Bob | member |
.EE
.PP
Placeholders may appear in the scenario name, steps, doc strings, and
data table cells.
Every placeholder must have a matching Examples column.
Examples headings must be unique, and all rows must have the same number
of cells.
.PP
Shellkin currently supports one Examples block per Scenario Outline.
Tags on Examples blocks are not supported.
.SS Steps
Supported step keywords are \f[B]Given\f[R], \f[B]When\f[R],
\f[B]Then\f[R], \f[B]And\f[R], \f[B]But\f[R], and \f[B]*\f[R].
Expand DownExpand Up@@ -147,10 +173,6 @@ Escaped pipe characters in cells are not currently supported.
The following common Gherkin constructs are not currently supported:
.IP \(bu 2
\f[B]Rule\f[R]
.IP \(bu 2
\f[B]Scenario Outline\f[R]
.IP \(bu 2
\f[B]Examples\f[R]
.SH EXAMPLE
.IP
.EX
Expand Down

27 changes: 25 additions & 2 deletions
doc/shellkin-feature.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ Shellkin currently supports these Gherkin keywords:
- **Feature**
- **Background**
- **Scenario**
- **Scenario Outline**, **Examples**
- **Given**, **When**, **Then**
- **And**, **But**, **\***
- data tables
Expand DownExpand Up@@ -72,6 +73,30 @@ Background:
 Given I am in a temp directory
```

Scenario Outline
--------------------------------------------------

Use **Scenario Outline:** with one **Examples:** table to run the same scenario
with several values. Each Examples row is a separate scenario.

```gherkin
Scenario Outline: Creating <name> as <role>
 When I register user '<name>' with role '<role>'
 Then user '<name>' should have role '<role>'

Examples:
 | name | role |
 | Alice | admin |
 | Bob | member |
```

Placeholders may appear in the scenario name, steps, doc strings, and data
table cells. Every placeholder must have a matching Examples column. Examples
headings must be unique, and all rows must have the same number of cells.

Shellkin currently supports one Examples block per Scenario Outline. Tags on
Examples blocks are not supported.

Steps
--------------------------------------------------

Expand DownExpand Up@@ -177,8 +202,6 @@ UNSUPPORTED CONSTRUCTS
The following common Gherkin constructs are not currently supported:

- **Rule**
- **Scenario Outline**
- **Examples**

EXAMPLE
==================================================
Expand Down

14 changes: 14 additions & 0 deletions
features/fixtures/scenario_outlines/scenario_outlines.feature

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
Feature: scenario outlines
 Run the same scenario with several examples

Background:
 Given the user registry is empty

Scenario Outline: Creating <name> as <role>
 When I register user '<name>' with role '<role>'
 Then user '<name>' should have role '<role>'

Examples:
 | name | role |
 | Alice | admin |
 | Bob | member |

17 changes: 17 additions & 0 deletions
features/fixtures/scenario_outlines/step_definitions/core.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
@Given the user registry is empty
 USER_NAMES=()
 USER_ROLES=()

@When I register user '{name}' with role '{role}'
 USER_NAMES+=("$name")
 USER_ROLES+=("$role")

@Then user '{name}' should have role '{role}'
 for index in "${!USER_NAMES[@]}"; do
 if [[ ${USER_NAMES[$index]} == "$name" ]]; then
 [[ ${USER_ROLES[$index]} == "$role" ]]
 return
 fi
 done

 fail "user not found: $name"

15 changes: 15 additions & 0 deletions
features/test.feature

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,21 @@ Scenario: Running a feature that uses a data table
 And the output should include '1 scenario, 0 failing'
 And the exit code should mean success

Scenario: Running a scenario outline
 When I run 'shellkin features/fixtures/scenario_outlines'
 Then the output should include 'Feature: scenario outlines'
 And the output should include 'Scenario 1: Creating Alice as admin'
 And the output should include 'Scenario 2: Creating Bob as member'
 And the output should include '2 scenarios, 0 failing'
 And the exit code should mean success

Scenario: Selecting one expanded scenario outline row
 When I run 'shellkin features/fixtures/scenario_outlines:2'
 Then the output should include 'Scenario 2: Creating Bob as member'
 And the output should not include 'Creating Alice as admin'
 And the output should include '1 scenario, 0 failing'
 And the exit code should mean success

Scenario: Running a failing test
 When I run 'shellkin features/fixtures/selective/failing.feature'
 Then the output should include 'Feature: two'
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Add support for `Scenario Outline` and `Examples` by DannyBen · Pull Request #13 · DannyBen/shellkin · GitHub
Skip to content
Add support for Scenario Outline and Examples#13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

DannyBen
merged 1 commit into

from

Jul 11, 2026
 Merged


Add support for Scenario Outline and Examples#13
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 3 additions & 2 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@ Implemented pieces include:
- `Background`, `Scenario`, `Given` / `When` / `Then`, `And` / `But`, and `*`
- doc strings via Gherkin-style `"""` blocks exposed as `DOC_STRING`
- data tables exposed as `TABLE_HEADER` and `TABLE_ROWS` arrays
- `Scenario Outline` expansion from one `Examples` table
- colored terminal output and scenario summary

### Gherkin Feature Support
Expand All@@ -88,9 +89,9 @@ Implemented pieces include:
| `Before`, `After` hooks | Supported |
| `BeforeAll`, `AfterAll` hooks | Supported |
| Data tables | Supported |
| `Scenario Outline` | Supported |
| `Examples` | Supported |
| `Rule` | Unsupported |
| `Scenario Outline` | Unsupported |
| `Examples` | Unsupported |

Tags can be selected with `--tag` / `-t` and skipped with `--exclude-tag` / `-x`.
`@Before` and `@After` hooks are declared in step definition files and may be
Expand Down

30 changes: 26 additions & 4 deletions
doc/shellkin-feature.5

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,8 @@ Shellkin currently supports these Gherkin keywords:
.IP \(bu 2
\f[B]Scenario\f[R]
.IP \(bu 2
\f[B]Scenario Outline\f[R], \f[B]Examples\f[R]
.IP \(bu 2
\f[B]Given\f[R], \f[B]When\f[R], \f[B]Then\f[R]
.IP \(bu 2
\f[B]And\f[R], \f[B]But\f[R], \f[B]*\f[R]
Expand DownExpand Up@@ -53,6 +55,30 @@ in the feature.
Background:
 Given I am in a temp directory
.EE
.SS Scenario Outline
Use \f[B]Scenario Outline:\f[R] with one \f[B]Examples:\f[R] table to
run the same scenario with several values.
Each Examples row is a separate scenario.
.IP
.EX
Scenario Outline: Creating <name> as <role>
 When I register user \(aq<name>\(aq with role \(aq<role>\(aq
 Then user \(aq<name>\(aq should have role \(aq<role>\(aq

Examples:
 | name | role |
 | Alice | admin |
 | Bob | member |
.EE
.PP
Placeholders may appear in the scenario name, steps, doc strings, and
data table cells.
Every placeholder must have a matching Examples column.
Examples headings must be unique, and all rows must have the same number
of cells.
.PP
Shellkin currently supports one Examples block per Scenario Outline.
Tags on Examples blocks are not supported.
.SS Steps
Supported step keywords are \f[B]Given\f[R], \f[B]When\f[R],
\f[B]Then\f[R], \f[B]And\f[R], \f[B]But\f[R], and \f[B]*\f[R].
Expand DownExpand Up@@ -147,10 +173,6 @@ Escaped pipe characters in cells are not currently supported.
The following common Gherkin constructs are not currently supported:
.IP \(bu 2
\f[B]Rule\f[R]
.IP \(bu 2
\f[B]Scenario Outline\f[R]
.IP \(bu 2
\f[B]Examples\f[R]
.SH EXAMPLE
.IP
.EX
Expand Down

27 changes: 25 additions & 2 deletions
doc/shellkin-feature.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ Shellkin currently supports these Gherkin keywords:
- **Feature**
- **Background**
- **Scenario**
- **Scenario Outline**, **Examples**
- **Given**, **When**, **Then**
- **And**, **But**, **\***
- data tables
Expand DownExpand Up@@ -72,6 +73,30 @@ Background:
 Given I am in a temp directory
```

Scenario Outline
--------------------------------------------------

Use **Scenario Outline:** with one **Examples:** table to run the same scenario
with several values. Each Examples row is a separate scenario.

```gherkin
Scenario Outline: Creating <name> as <role>
 When I register user '<name>' with role '<role>'
 Then user '<name>' should have role '<role>'

Examples:
 | name | role |
 | Alice | admin |
 | Bob | member |
```

Placeholders may appear in the scenario name, steps, doc strings, and data
table cells. Every placeholder must have a matching Examples column. Examples
headings must be unique, and all rows must have the same number of cells.

Shellkin currently supports one Examples block per Scenario Outline. Tags on
Examples blocks are not supported.

Steps
--------------------------------------------------

Expand DownExpand Up@@ -177,8 +202,6 @@ UNSUPPORTED CONSTRUCTS
The following common Gherkin constructs are not currently supported:

- **Rule**
- **Scenario Outline**
- **Examples**

EXAMPLE
==================================================
Expand Down

14 changes: 14 additions & 0 deletions
features/fixtures/scenario_outlines/scenario_outlines.feature

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
Feature: scenario outlines
 Run the same scenario with several examples

Background:
 Given the user registry is empty

Scenario Outline: Creating <name> as <role>
 When I register user '<name>' with role '<role>'
 Then user '<name>' should have role '<role>'

Examples:
 | name | role |
 | Alice | admin |
 | Bob | member |

17 changes: 17 additions & 0 deletions
features/fixtures/scenario_outlines/step_definitions/core.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
@Given the user registry is empty
 USER_NAMES=()
 USER_ROLES=()

@When I register user '{name}' with role '{role}'
 USER_NAMES+=("$name")
 USER_ROLES+=("$role")

@Then user '{name}' should have role '{role}'
 for index in "${!USER_NAMES[@]}"; do
 if [[ ${USER_NAMES[$index]} == "$name" ]]; then
 [[ ${USER_ROLES[$index]} == "$role" ]]
 return
 fi
 done

 fail "user not found: $name"

15 changes: 15 additions & 0 deletions
features/test.feature

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,21 @@ Scenario: Running a feature that uses a data table
 And the output should include '1 scenario, 0 failing'
 And the exit code should mean success

Scenario: Running a scenario outline
 When I run 'shellkin features/fixtures/scenario_outlines'
 Then the output should include 'Feature: scenario outlines'
 And the output should include 'Scenario 1: Creating Alice as admin'
 And the output should include 'Scenario 2: Creating Bob as member'
 And the output should include '2 scenarios, 0 failing'
 And the exit code should mean success

Scenario: Selecting one expanded scenario outline row
 When I run 'shellkin features/fixtures/scenario_outlines:2'
 Then the output should include 'Scenario 2: Creating Bob as member'
 And the output should not include 'Creating Alice as admin'
 And the output should include '1 scenario, 0 failing'
 And the exit code should mean success

Scenario: Running a failing test
 When I run 'shellkin features/fixtures/selective/failing.feature'
 Then the output should include 'Feature: two'
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add support for `Scenario Outline` and `Examples` by DannyBen · Pull Request #13 · DannyBen/shellkin · GitHub
Skip to content
Add support for Scenario Outline and Examples#13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

DannyBen
merged 1 commit into

from

Jul 11, 2026
 Merged


Add support for Scenario Outline and Examples#13
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 3 additions & 2 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@ Implemented pieces include:
- `Background`, `Scenario`, `Given` / `When` / `Then`, `And` / `But`, and `*`
- doc strings via Gherkin-style `"""` blocks exposed as `DOC_STRING`
- data tables exposed as `TABLE_HEADER` and `TABLE_ROWS` arrays
- `Scenario Outline` expansion from one `Examples` table
- colored terminal output and scenario summary

### Gherkin Feature Support
Expand All@@ -88,9 +89,9 @@ Implemented pieces include:
| `Before`, `After` hooks | Supported |
| `BeforeAll`, `AfterAll` hooks | Supported |
| Data tables | Supported |
| `Scenario Outline` | Supported |
| `Examples` | Supported |
| `Rule` | Unsupported |
| `Scenario Outline` | Unsupported |
| `Examples` | Unsupported |

Tags can be selected with `--tag` / `-t` and skipped with `--exclude-tag` / `-x`.
`@Before` and `@After` hooks are declared in step definition files and may be
Expand Down

30 changes: 26 additions & 4 deletions
doc/shellkin-feature.5

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,8 @@ Shellkin currently supports these Gherkin keywords:
.IP \(bu 2
\f[B]Scenario\f[R]
.IP \(bu 2
\f[B]Scenario Outline\f[R], \f[B]Examples\f[R]
.IP \(bu 2
\f[B]Given\f[R], \f[B]When\f[R], \f[B]Then\f[R]
.IP \(bu 2
\f[B]And\f[R], \f[B]But\f[R], \f[B]*\f[R]
Expand DownExpand Up@@ -53,6 +55,30 @@ in the feature.
Background:
 Given I am in a temp directory
.EE
.SS Scenario Outline
Use \f[B]Scenario Outline:\f[R] with one \f[B]Examples:\f[R] table to
run the same scenario with several values.
Each Examples row is a separate scenario.
.IP
.EX
Scenario Outline: Creating <name> as <role>
 When I register user \(aq<name>\(aq with role \(aq<role>\(aq
 Then user \(aq<name>\(aq should have role \(aq<role>\(aq

Examples:
 | name | role |
 | Alice | admin |
 | Bob | member |
.EE
.PP
Placeholders may appear in the scenario name, steps, doc strings, and
data table cells.
Every placeholder must have a matching Examples column.
Examples headings must be unique, and all rows must have the same number
of cells.
.PP
Shellkin currently supports one Examples block per Scenario Outline.
Tags on Examples blocks are not supported.
.SS Steps
Supported step keywords are \f[B]Given\f[R], \f[B]When\f[R],
\f[B]Then\f[R], \f[B]And\f[R], \f[B]But\f[R], and \f[B]*\f[R].
Expand DownExpand Up@@ -147,10 +173,6 @@ Escaped pipe characters in cells are not currently supported.
The following common Gherkin constructs are not currently supported:
.IP \(bu 2
\f[B]Rule\f[R]
.IP \(bu 2
\f[B]Scenario Outline\f[R]
.IP \(bu 2
\f[B]Examples\f[R]
.SH EXAMPLE
.IP
.EX
Expand Down

27 changes: 25 additions & 2 deletions
doc/shellkin-feature.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ Shellkin currently supports these Gherkin keywords:
- **Feature**
- **Background**
- **Scenario**
- **Scenario Outline**, **Examples**
- **Given**, **When**, **Then**
- **And**, **But**, **\***
- data tables
Expand DownExpand Up@@ -72,6 +73,30 @@ Background:
 Given I am in a temp directory
```

Scenario Outline
--------------------------------------------------

Use **Scenario Outline:** with one **Examples:** table to run the same scenario
with several values. Each Examples row is a separate scenario.

```gherkin
Scenario Outline: Creating <name> as <role>
 When I register user '<name>' with role '<role>'
 Then user '<name>' should have role '<role>'

Examples:
 | name | role |
 | Alice | admin |
 | Bob | member |
```

Placeholders may appear in the scenario name, steps, doc strings, and data
table cells. Every placeholder must have a matching Examples column. Examples
headings must be unique, and all rows must have the same number of cells.

Shellkin currently supports one Examples block per Scenario Outline. Tags on
Examples blocks are not supported.

Steps
--------------------------------------------------

Expand DownExpand Up@@ -177,8 +202,6 @@ UNSUPPORTED CONSTRUCTS
The following common Gherkin constructs are not currently supported:

- **Rule**
- **Scenario Outline**
- **Examples**

EXAMPLE
==================================================
Expand Down

14 changes: 14 additions & 0 deletions
features/fixtures/scenario_outlines/scenario_outlines.feature

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
Feature: scenario outlines
 Run the same scenario with several examples

Background:
 Given the user registry is empty

Scenario Outline: Creating <name> as <role>
 When I register user '<name>' with role '<role>'
 Then user '<name>' should have role '<role>'

Examples:
 | name | role |
 | Alice | admin |
 | Bob | member |

17 changes: 17 additions & 0 deletions
features/fixtures/scenario_outlines/step_definitions/core.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
@Given the user registry is empty
 USER_NAMES=()
 USER_ROLES=()

@When I register user '{name}' with role '{role}'
 USER_NAMES+=("$name")
 USER_ROLES+=("$role")

@Then user '{name}' should have role '{role}'
 for index in "${!USER_NAMES[@]}"; do
 if [[ ${USER_NAMES[$index]} == "$name" ]]; then
 [[ ${USER_ROLES[$index]} == "$role" ]]
 return
 fi
 done

 fail "user not found: $name"

15 changes: 15 additions & 0 deletions
features/test.feature

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,21 @@ Scenario: Running a feature that uses a data table
 And the output should include '1 scenario, 0 failing'
 And the exit code should mean success

Scenario: Running a scenario outline
 When I run 'shellkin features/fixtures/scenario_outlines'
 Then the output should include 'Feature: scenario outlines'
 And the output should include 'Scenario 1: Creating Alice as admin'
 And the output should include 'Scenario 2: Creating Bob as member'
 And the output should include '2 scenarios, 0 failing'
 And the exit code should mean success

Scenario: Selecting one expanded scenario outline row
 When I run 'shellkin features/fixtures/scenario_outlines:2'
 Then the output should include 'Scenario 2: Creating Bob as member'
 And the output should not include 'Creating Alice as admin'
 And the output should include '1 scenario, 0 failing'
 And the exit code should mean success

Scenario: Running a failing test
 When I run 'shellkin features/fixtures/selective/failing.feature'
 Then the output should include 'Feature: two'
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add support for `Scenario Outline` and `Examples` by DannyBen · Pull Request #13 · DannyBen/shellkin · GitHub
Skip to content
Add support for Scenario Outline and Examples#13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

DannyBen
merged 1 commit into

from

Jul 11, 2026
 Merged


Add support for Scenario Outline and Examples#13
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 3 additions & 2 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@ Implemented pieces include:
- `Background`, `Scenario`, `Given` / `When` / `Then`, `And` / `But`, and `*`
- doc strings via Gherkin-style `"""` blocks exposed as `DOC_STRING`
- data tables exposed as `TABLE_HEADER` and `TABLE_ROWS` arrays
- `Scenario Outline` expansion from one `Examples` table
- colored terminal output and scenario summary

### Gherkin Feature Support
Expand All@@ -88,9 +89,9 @@ Implemented pieces include:
| `Before`, `After` hooks | Supported |
| `BeforeAll`, `AfterAll` hooks | Supported |
| Data tables | Supported |
| `Scenario Outline` | Supported |
| `Examples` | Supported |
| `Rule` | Unsupported |
| `Scenario Outline` | Unsupported |
| `Examples` | Unsupported |

Tags can be selected with `--tag` / `-t` and skipped with `--exclude-tag` / `-x`.
`@Before` and `@After` hooks are declared in step definition files and may be
Expand Down

30 changes: 26 additions & 4 deletions
doc/shellkin-feature.5

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,8 @@ Shellkin currently supports these Gherkin keywords:
.IP \(bu 2
\f[B]Scenario\f[R]
.IP \(bu 2
\f[B]Scenario Outline\f[R], \f[B]Examples\f[R]
.IP \(bu 2
\f[B]Given\f[R], \f[B]When\f[R], \f[B]Then\f[R]
.IP \(bu 2
\f[B]And\f[R], \f[B]But\f[R], \f[B]*\f[R]
Expand DownExpand Up@@ -53,6 +55,30 @@ in the feature.
Background:
 Given I am in a temp directory
.EE
.SS Scenario Outline
Use \f[B]Scenario Outline:\f[R] with one \f[B]Examples:\f[R] table to
run the same scenario with several values.
Each Examples row is a separate scenario.
.IP
.EX
Scenario Outline: Creating <name> as <role>
 When I register user \(aq<name>\(aq with role \(aq<role>\(aq
 Then user \(aq<name>\(aq should have role \(aq<role>\(aq

Examples:
 | name | role |
 | Alice | admin |
 | Bob | member |
.EE
.PP
Placeholders may appear in the scenario name, steps, doc strings, and
data table cells.
Every placeholder must have a matching Examples column.
Examples headings must be unique, and all rows must have the same number
of cells.
.PP
Shellkin currently supports one Examples block per Scenario Outline.
Tags on Examples blocks are not supported.
.SS Steps
Supported step keywords are \f[B]Given\f[R], \f[B]When\f[R],
\f[B]Then\f[R], \f[B]And\f[R], \f[B]But\f[R], and \f[B]*\f[R].
Expand DownExpand Up@@ -147,10 +173,6 @@ Escaped pipe characters in cells are not currently supported.
The following common Gherkin constructs are not currently supported:
.IP \(bu 2
\f[B]Rule\f[R]
.IP \(bu 2
\f[B]Scenario Outline\f[R]
.IP \(bu 2
\f[B]Examples\f[R]
.SH EXAMPLE
.IP
.EX
Expand Down

27 changes: 25 additions & 2 deletions
doc/shellkin-feature.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ Shellkin currently supports these Gherkin keywords:
- **Feature**
- **Background**
- **Scenario**
- **Scenario Outline**, **Examples**
- **Given**, **When**, **Then**
- **And**, **But**, **\***
- data tables
Expand DownExpand Up@@ -72,6 +73,30 @@ Background:
 Given I am in a temp directory
```

Scenario Outline
--------------------------------------------------

Use **Scenario Outline:** with one **Examples:** table to run the same scenario
with several values. Each Examples row is a separate scenario.

```gherkin
Scenario Outline: Creating <name> as <role>
 When I register user '<name>' with role '<role>'
 Then user '<name>' should have role '<role>'

Examples:
 | name | role |
 | Alice | admin |
 | Bob | member |
```

Placeholders may appear in the scenario name, steps, doc strings, and data
table cells. Every placeholder must have a matching Examples column. Examples
headings must be unique, and all rows must have the same number of cells.

Shellkin currently supports one Examples block per Scenario Outline. Tags on
Examples blocks are not supported.

Steps
--------------------------------------------------

Expand DownExpand Up@@ -177,8 +202,6 @@ UNSUPPORTED CONSTRUCTS
The following common Gherkin constructs are not currently supported:

- **Rule**
- **Scenario Outline**
- **Examples**

EXAMPLE
==================================================
Expand Down

14 changes: 14 additions & 0 deletions
features/fixtures/scenario_outlines/scenario_outlines.feature

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
Feature: scenario outlines
 Run the same scenario with several examples

Background:
 Given the user registry is empty

Scenario Outline: Creating <name> as <role>
 When I register user '<name>' with role '<role>'
 Then user '<name>' should have role '<role>'

Examples:
 | name | role |
 | Alice | admin |
 | Bob | member |

17 changes: 17 additions & 0 deletions
features/fixtures/scenario_outlines/step_definitions/core.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
@Given the user registry is empty
 USER_NAMES=()
 USER_ROLES=()

@When I register user '{name}' with role '{role}'
 USER_NAMES+=("$name")
 USER_ROLES+=("$role")

@Then user '{name}' should have role '{role}'
 for index in "${!USER_NAMES[@]}"; do
 if [[ ${USER_NAMES[$index]} == "$name" ]]; then
 [[ ${USER_ROLES[$index]} == "$role" ]]
 return
 fi
 done

 fail "user not found: $name"

15 changes: 15 additions & 0 deletions
features/test.feature

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,21 @@ Scenario: Running a feature that uses a data table
 And the output should include '1 scenario, 0 failing'
 And the exit code should mean success

Scenario: Running a scenario outline
 When I run 'shellkin features/fixtures/scenario_outlines'
 Then the output should include 'Feature: scenario outlines'
 And the output should include 'Scenario 1: Creating Alice as admin'
 And the output should include 'Scenario 2: Creating Bob as member'
 And the output should include '2 scenarios, 0 failing'
 And the exit code should mean success

Scenario: Selecting one expanded scenario outline row
 When I run 'shellkin features/fixtures/scenario_outlines:2'
 Then the output should include 'Scenario 2: Creating Bob as member'
 And the output should not include 'Creating Alice as admin'
 And the output should include '1 scenario, 0 failing'
 And the exit code should mean success

Scenario: Running a failing test
 When I run 'shellkin features/fixtures/selective/failing.feature'
 Then the output should include 'Feature: two'
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Add support for `Scenario Outline` and `Examples` by DannyBen · Pull Request #13 · DannyBen/shellkin · GitHub
Skip to content
Add support for Scenario Outline and Examples#13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

DannyBen
merged 1 commit into

from

Jul 11, 2026
 Merged


Add support for Scenario Outline and Examples#13
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 3 additions & 2 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@ Implemented pieces include:
- `Background`, `Scenario`, `Given` / `When` / `Then`, `And` / `But`, and `*`
- doc strings via Gherkin-style `"""` blocks exposed as `DOC_STRING`
- data tables exposed as `TABLE_HEADER` and `TABLE_ROWS` arrays
- `Scenario Outline` expansion from one `Examples` table
- colored terminal output and scenario summary

### Gherkin Feature Support
Expand All@@ -88,9 +89,9 @@ Implemented pieces include:
| `Before`, `After` hooks | Supported |
| `BeforeAll`, `AfterAll` hooks | Supported |
| Data tables | Supported |
| `Scenario Outline` | Supported |
| `Examples` | Supported |
| `Rule` | Unsupported |
| `Scenario Outline` | Unsupported |
| `Examples` | Unsupported |

Tags can be selected with `--tag` / `-t` and skipped with `--exclude-tag` / `-x`.
`@Before` and `@After` hooks are declared in step definition files and may be
Expand Down

30 changes: 26 additions & 4 deletions
doc/shellkin-feature.5

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,8 @@ Shellkin currently supports these Gherkin keywords:
.IP \(bu 2
\f[B]Scenario\f[R]
.IP \(bu 2
\f[B]Scenario Outline\f[R], \f[B]Examples\f[R]
.IP \(bu 2
\f[B]Given\f[R], \f[B]When\f[R], \f[B]Then\f[R]
.IP \(bu 2
\f[B]And\f[R], \f[B]But\f[R], \f[B]*\f[R]
Expand DownExpand Up@@ -53,6 +55,30 @@ in the feature.
Background:
 Given I am in a temp directory
.EE
.SS Scenario Outline
Use \f[B]Scenario Outline:\f[R] with one \f[B]Examples:\f[R] table to
run the same scenario with several values.
Each Examples row is a separate scenario.
.IP
.EX
Scenario Outline: Creating <name> as <role>
 When I register user \(aq<name>\(aq with role \(aq<role>\(aq
 Then user \(aq<name>\(aq should have role \(aq<role>\(aq

Examples:
 | name | role |
 | Alice | admin |
 | Bob | member |
.EE
.PP
Placeholders may appear in the scenario name, steps, doc strings, and
data table cells.
Every placeholder must have a matching Examples column.
Examples headings must be unique, and all rows must have the same number
of cells.
.PP
Shellkin currently supports one Examples block per Scenario Outline.
Tags on Examples blocks are not supported.
.SS Steps
Supported step keywords are \f[B]Given\f[R], \f[B]When\f[R],
\f[B]Then\f[R], \f[B]And\f[R], \f[B]But\f[R], and \f[B]*\f[R].
Expand DownExpand Up@@ -147,10 +173,6 @@ Escaped pipe characters in cells are not currently supported.
The following common Gherkin constructs are not currently supported:
.IP \(bu 2
\f[B]Rule\f[R]
.IP \(bu 2
\f[B]Scenario Outline\f[R]
.IP \(bu 2
\f[B]Examples\f[R]
.SH EXAMPLE
.IP
.EX
Expand Down

27 changes: 25 additions & 2 deletions
doc/shellkin-feature.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ Shellkin currently supports these Gherkin keywords:
- **Feature**
- **Background**
- **Scenario**
- **Scenario Outline**, **Examples**
- **Given**, **When**, **Then**
- **And**, **But**, **\***
- data tables
Expand DownExpand Up@@ -72,6 +73,30 @@ Background:
 Given I am in a temp directory
```

Scenario Outline
--------------------------------------------------

Use **Scenario Outline:** with one **Examples:** table to run the same scenario
with several values. Each Examples row is a separate scenario.

```gherkin
Scenario Outline: Creating <name> as <role>
 When I register user '<name>' with role '<role>'
 Then user '<name>' should have role '<role>'

Examples:
 | name | role |
 | Alice | admin |
 | Bob | member |
```

Placeholders may appear in the scenario name, steps, doc strings, and data
table cells. Every placeholder must have a matching Examples column. Examples
headings must be unique, and all rows must have the same number of cells.

Shellkin currently supports one Examples block per Scenario Outline. Tags on
Examples blocks are not supported.

Steps
--------------------------------------------------

Expand DownExpand Up@@ -177,8 +202,6 @@ UNSUPPORTED CONSTRUCTS
The following common Gherkin constructs are not currently supported:

- **Rule**
- **Scenario Outline**
- **Examples**

EXAMPLE
==================================================
Expand Down

14 changes: 14 additions & 0 deletions
features/fixtures/scenario_outlines/scenario_outlines.feature

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
Feature: scenario outlines
 Run the same scenario with several examples

Background:
 Given the user registry is empty

Scenario Outline: Creating <name> as <role>
 When I register user '<name>' with role '<role>'
 Then user '<name>' should have role '<role>'

Examples:
 | name | role |
 | Alice | admin |
 | Bob | member |

17 changes: 17 additions & 0 deletions
features/fixtures/scenario_outlines/step_definitions/core.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
@Given the user registry is empty
 USER_NAMES=()
 USER_ROLES=()

@When I register user '{name}' with role '{role}'
 USER_NAMES+=("$name")
 USER_ROLES+=("$role")

@Then user '{name}' should have role '{role}'
 for index in "${!USER_NAMES[@]}"; do
 if [[ ${USER_NAMES[$index]} == "$name" ]]; then
 [[ ${USER_ROLES[$index]} == "$role" ]]
 return
 fi
 done

 fail "user not found: $name"

15 changes: 15 additions & 0 deletions
features/test.feature

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,21 @@ Scenario: Running a feature that uses a data table
 And the output should include '1 scenario, 0 failing'
 And the exit code should mean success

Scenario: Running a scenario outline
 When I run 'shellkin features/fixtures/scenario_outlines'
 Then the output should include 'Feature: scenario outlines'
 And the output should include 'Scenario 1: Creating Alice as admin'
 And the output should include 'Scenario 2: Creating Bob as member'
 And the output should include '2 scenarios, 0 failing'
 And the exit code should mean success

Scenario: Selecting one expanded scenario outline row
 When I run 'shellkin features/fixtures/scenario_outlines:2'
 Then the output should include 'Scenario 2: Creating Bob as member'
 And the output should not include 'Creating Alice as admin'
 And the output should include '1 scenario, 0 failing'
 And the exit code should mean success

Scenario: Running a failing test
 When I run 'shellkin features/fixtures/selective/failing.feature'
 Then the output should include 'Feature: two'
Expand Down
Loading
Loading