@uuv/assistant 1.3.2 → 1.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
|
|
2
2
|
|
|
3
3
|
|
|
4
|
+
|
|
4
5
|
# @uuv/assistant
|
|
5
6
|
<p align="center">
|
|
6
7
|
<a href="https://e2e-test-quest.github.io/uuv/">
|
|
@@ -8,10 +9,7 @@
|
|
|
8
9
|
<img alt="UUV Logo" src="https://e2e-test-quest.github.io/uuv/img/uuv.png">
|
|
9
10
|
</picture>
|
|
10
11
|
</a>
|
|
11
|
-
</p>
|
|
12
|
-
<p align="center">
|
|
13
|
-
<a href="https://e2e-test-quest.github.io/uuv/"><img src="https://img.shields.io/badge/documentation-black?&style=for-the-badge&logo=github&logoColor=white" alt="documentation"/></a>
|
|
14
|
-
</p>
|
|
12
|
+
</p>
|
|
15
13
|
|
|
16
14
|
<h3 align="center">
|
|
17
15
|
Test as final user
|
|
@@ -33,6 +31,39 @@ Make test writing fast, understandable by any human understanding English or Fre
|
|
|
33
31
|
</a><br />
|
|
34
32
|
</p>
|
|
35
33
|
|
|
34
|
+
## Benefits
|
|
35
|
+
- If used correctly, integrates accessibility from the development stage
|
|
36
|
+
- A living documentation is possible because we propose an unified language for developers and non-developers with a rich dictionary of ready-to-use sentences
|
|
37
|
+
- A wizard that facilitates the writing of tests by suggesting the most accessible sentences
|
|
38
|
+
- Integrates several runtime engines: Cypress / Playwright
|
|
39
|
+
- User-friendly and standardized execution report
|
|
40
|
+
### <u>Comparison</u>
|
|
41
|
+
| Criteria | Cypress | Playwright | Testing library | UUV |
|
|
42
|
+
|:-: |:-: |:-: |:-: |:-: |
|
|
43
|
+
| User centrism | :x: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
|
|
44
|
+
| Native accessibility | :x: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
|
|
45
|
+
| Easy setup configuration for BDD test | :warning: | :warning: | :heavy_minus_sign: | :heavy_check_mark: |
|
|
46
|
+
| Understandable by everyone <br> (included non dev) | :x: | :x: | :x: | :heavy_check_mark: |
|
|
47
|
+
|
|
48
|
+
### <u>Syntax example</u>
|
|
49
|
+
With this dom example :
|
|
50
|
+
```html
|
|
51
|
+
<body>
|
|
52
|
+
<h1>Result<h1>
|
|
53
|
+
</body>
|
|
54
|
+
```
|
|
55
|
+
we see that the sentence proposed by **UUV is the most understandable** of all
|
|
56
|
+
| Library | Syntax |
|
|
57
|
+
|:--|:--|
|
|
58
|
+
| Cypress | cy.get('result').should('exist') |
|
|
59
|
+
| Playwright| await expect(page.getByTitle('Result')).toHaveCount(1) |
|
|
60
|
+
| Testing library | expect(screen.getByTitle(/Result/i)).toBeTruthy() |
|
|
61
|
+
| UUV | Then I should see a title named "Result"|
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
## Documentation
|
|
65
|
+
<a href="https://e2e-test-quest.github.io/uuv/"><img src="https://img.shields.io/badge/documentation-black?&style=for-the-badge&logo=github&logoColor=white" alt="documentation"/></a>
|
|
66
|
+
|
|
36
67
|
## What is @uuv/assistant (Wizard) ?
|
|
37
68
|
|
|
38
69
|
<p align="center">
|
|
@@ -42,18 +73,41 @@ Make test writing fast, understandable by any human understanding English or Fre
|
|
|
42
73
|
With this wizard, we can generate cucumber sentences that will use an execution engine like cypress with [@uuv/cypress](https://www.npmjs.com/package/@uuv/cypress) or playwright with [@uuv/playwright](https://www.npmjs.com/package/@uuv/playwright).
|
|
43
74
|
</p>
|
|
44
75
|
|
|
76
|
+
## Screenshots
|
|
45
77
|
<img src="https://e2e-test-quest.github.io/uuv/img/assistant/screenshots.gif" alt="assistant screenshots"/>
|
|
46
78
|
|
|
47
|
-
##
|
|
79
|
+
## Installation
|
|
80
|
+
```bash
|
|
81
|
+
npm install --save-dev @uuv/assistant
|
|
82
|
+
```
|
|
83
|
+
or
|
|
84
|
+
```bash
|
|
85
|
+
yarn add -D @uuv/assistant
|
|
86
|
+
```
|
|
48
87
|
|
|
49
|
-
|
|
88
|
+
## Usage
|
|
50
89
|
|
|
51
|
-
|
|
90
|
+
To launch uuv assistant :
|
|
91
|
+
```bash
|
|
92
|
+
npx uuv-assistant --targetUrl=<targetUrl>
|
|
93
|
+
```
|
|
94
|
+
| Name | Description | Example |
|
|
95
|
+
|-------------|---------------------------------------------------------------------------------------------------------------|---------------------------------------|
|
|
96
|
+
| `targetUrl` | Target website url | https://e2e-test-quest.github.io/uuv/ |
|
|
97
|
+
|
|
98
|
+
The dictionary is available in french and english. It can be accessed with this link:
|
|
99
|
+
|
|
100
|
+
<a href="https://e2e-test-quest.github.io/uuv/docs/wordings/generated-wording-description/en-generated-wording-description"><img src="https://img.shields.io/badge/sentences%20dictionary-red?&style=for-the-badge&logo=github&logoColor=white" alt="documentation containing sentences"/></a>
|
|
52
101
|
|
|
53
102
|
## License
|
|
54
103
|
|
|
55
|
-
[<a href="https://
|
|
56
|
-
<img src="https://img.shields.io/badge/license-Apache%202.0-blue" alt="
|
|
104
|
+
[<a href="https://github.com/e2e-test-quest/uuv/blob/main/LICENSE">
|
|
105
|
+
<img src="https://img.shields.io/badge/license-Apache%202.0-blue" alt="apache license"/>
|
|
57
106
|
</a>](https://www.apache.org/licenses/LICENSE-2.0)
|
|
58
107
|
|
|
59
|
-
This project is licensed under the terms of the [Apache 2.0 license](https://
|
|
108
|
+
This project is licensed under the terms of the [Apache 2.0 license](https://github.com/e2e-test-quest/uuv/blob/main/LICENSE).
|
|
109
|
+
|
|
110
|
+
## Authors
|
|
111
|
+
|
|
112
|
+
- [@luifr10](https://github.com/luifr10)
|
|
113
|
+
- [@stanlee974](https://github.com/stanlee974)
|