Skip to content

Commit 50d3645

Browse files
committed
📝 Improve anchors
1 parent c6a62f6 commit 50d3645

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,29 +16,30 @@ and the Flutter guide for
1616
Supercharge your Dart testing with **parameterized_test**! Built on top of the [dart test package](https://pub.dev/packages/test), this [JUnit ParameterizedTest](https://junit.org/junit5/docs/current/user-guide/#writing-tests-parameterized-tests) inspired package wrap around `group` and `test` to take your testing to the next level!
1717

1818
## Table of contents
19-
* [Features](#features-)
20-
* [Installation](#installation)
21-
* [Usage](#usage)
22-
* [Examples](#examples)
23-
* [How it works](#how-it-works)
24-
* [Additional information](#additional-information)
19+
- [Features](#features)
20+
- [Installation](#installation)
21+
- [Usage](#usage)
22+
- [Add test options to parameter](#add test options to parameter)
23+
- [Changing test description output](#changing)
24+
- [Examples](#examples)
25+
- [Additional information](#additional-information)
2526

26-
## Features
27+
## Features
2728

2829
- ✅ Run a test multiple times based on provide parameter list.
2930
- ✅ Built on top of [dart test package](https://pub.dev/packages/test).
3031
- ✅ Type cast test parameters used in the tests.
3132
- ✅ Include test options for parameter_test.
3233
- ✅ Include test options per parameter.
3334

34-
## 🛠 Installation
35+
## Installation 🛠
3536

3637
```yaml
3738
dev_dependencies:
3839
parameterized_test: [latest-version]
3940
```
4041
41-
## ⚡️ Usage
42+
## Usage ⚡️
4243
4344
Instead of creating a `group` test with multiple of the same `test` and different parameters, you can now use `parameterizedTest` and supply it list of test parameters to run the same test with multiple times.
4445
Specifying a parameterized test is almost the same as normal test. It has all the same parameters as a normal test like: `skip` or `testOn` etc.
@@ -76,7 +77,7 @@ Here you still need to provide a `test`. This can be useful if you want to have
7677
7778
Besides accepting a list of test values, you can also provide a `setUp` and `tearDown` function to run before and after each test.
7879
79-
## 🔩 Add test options to parameter
80+
### Add test options to parameter 🔩
8081
If you want to add test options to a specific parameter you can do so by using the `options` extension on `List`. This will allow you to add test options like `skip` or `testOn` to a specific parameter.
8182
8283
For example:
@@ -100,7 +101,7 @@ parameterizedTest(
100101

101102
This will create a `group` with 4 `test` inside it. The second test will receive the provided test options and will be skipped in this case.
102103

103-
## 📝 Changing test description output
104+
### Changing test description output 📝
104105
By default, the test description contains the test value used within the tests. you can override this by using `customDescriptionBuilder`.
105106

106107
When normally running parameterized tests with description 'My parameterized test' and the values `[['first', 'second', true], ['third', 'fourth', false]]` the test description output looks something like this:
@@ -124,7 +125,7 @@ My parameterized test 🚀[2] My parameterized test: <<third|fourth|false>>
124125

125126
>Note: the first 'My parameterized test' is because parameterized tests make use of a group test. Most IDE's will group this for you and only show the second part.
126127
127-
## 📦 Examples
128+
## Examples 📦
128129
### Simple test containing a list of single values
129130
```dart
130131
parameterizedTest(

0 commit comments

Comments
 (0)