@uuv/assistant 1.5.1 → 1.6.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 +17 -9
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -34,7 +34,7 @@ Make test writing fast, understandable by any human understanding English or Fre
|
|
|
34
34
|
## Benefits
|
|
35
35
|
- If used correctly, integrates accessibility from the development stage
|
|
36
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
|
-
-
|
|
37
|
+
- @uuv/assistant that facilitates the writing of tests by suggesting the most accessible sentences
|
|
38
38
|
- Integrates several runtime engines: Cypress / Playwright
|
|
39
39
|
- User-friendly and standardized execution report
|
|
40
40
|
### <u>Comparison</u>
|
|
@@ -43,7 +43,7 @@ Make test writing fast, understandable by any human understanding English or Fre
|
|
|
43
43
|
| User centrism | :x: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
|
|
44
44
|
| Native accessibility | :x: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
|
|
45
45
|
| Easy setup configuration for BDD test | :warning: | :warning: | :heavy_minus_sign: | :heavy_check_mark: |
|
|
46
|
-
| Understandable by everyone
|
|
46
|
+
| Understandable by everyone </br> (included non dev) | :x: | :x: | :x: | :heavy_check_mark: |
|
|
47
47
|
|
|
48
48
|
### <u>Syntax example</u>
|
|
49
49
|
With this dom example :
|
|
@@ -64,13 +64,13 @@ we see that the sentence proposed by **UUV is the most understandable** of all
|
|
|
64
64
|
## Documentation
|
|
65
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
66
|
|
|
67
|
-
## What is @uuv/assistant
|
|
67
|
+
## What is @uuv/assistant ?
|
|
68
68
|
|
|
69
69
|
<p align="center">
|
|
70
70
|
|
|
71
71
|
`@uuv` library (User centric Usecases Validator) is an ecosystem that simplifies the writing of End to End tests in a BDD approach and a user-centric way.
|
|
72
72
|
|
|
73
|
-
With this
|
|
73
|
+
With this tool, 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).
|
|
74
74
|
</p>
|
|
75
75
|
|
|
76
76
|
## Screenshots
|
|
@@ -83,6 +83,7 @@ With this wizard, we can generate cucumber sentences that will use an execution
|
|
|
83
83
|
</a>
|
|
84
84
|
|
|
85
85
|
## Installation
|
|
86
|
+
### NPM Package
|
|
86
87
|
```bash
|
|
87
88
|
npm install --save-dev @uuv/assistant
|
|
88
89
|
```
|
|
@@ -90,13 +91,14 @@ or
|
|
|
90
91
|
```bash
|
|
91
92
|
yarn add -D @uuv/assistant
|
|
92
93
|
```
|
|
94
|
+
### Desktop executable
|
|
95
|
+
1. Download executable using the following button </br>
|
|
96
|
+
<a href="https://github.com/e2e-test-quest/uuv/releases/latest/download/uuv-assistant-win32-x64.zip"><img src="https://img.shields.io/badge/download_uuv--assistant_desktop-black?&style=for-the-badge&logo=github&logoColor=white" alt="documentation"/></a>
|
|
97
|
+
2. Unzip the downloaded zip file
|
|
93
98
|
|
|
94
|
-
## Usage
|
|
95
|
-
|
|
96
|
-
### Scenarios example
|
|
97
|
-
You can find test examples here : [weather-app.feature](https://github.com/e2e-test-quest/uuv/blob/main/example/weather-app.feature)
|
|
98
99
|
|
|
99
|
-
|
|
100
|
+
## Usage
|
|
101
|
+
### NPM Package
|
|
100
102
|
To launch uuv assistant :
|
|
101
103
|
```bash
|
|
102
104
|
npx uuv-assistant --targetUrl=<targetUrl>
|
|
@@ -105,6 +107,12 @@ npx uuv-assistant --targetUrl=<targetUrl>
|
|
|
105
107
|
|-------------|---------------------------------------------------------------------------------------------------------------|---------------------------------------|
|
|
106
108
|
| `targetUrl` | Target website url | https://e2e-test-quest.github.io/uuv/ |
|
|
107
109
|
|
|
110
|
+
### Desktop executable
|
|
111
|
+
Execute `uuv-assistant.exe` from the unzipped folder
|
|
112
|
+
|
|
113
|
+
## Scenario examples
|
|
114
|
+
You can find test examples here : [weather-app.feature](https://github.com/e2e-test-quest/uuv/blob/main/example/weather-app.feature)
|
|
115
|
+
|
|
108
116
|
The dictionary is available in french and english. It can be accessed with this link:
|
|
109
117
|
|
|
110
118
|
<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>
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@uuv/assistant",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.6.0",
|
|
4
4
|
"author": "Louis Fredice NJAKO MOLOM (https://github.com/luifr10) & Stanley SERVICAL (https://github.com/stanlee974)",
|
|
5
5
|
"description": "UUV Helper used to improve the life of testers and developers by generating cucumber phrases from the GUI.",
|
|
6
6
|
"license": "Apache-2.0",
|