@uuv/assistant 1.3.3 → 1.4.1

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.
Files changed (9) hide show
  1. package/README.md +74 -10
  2. package/build/static/css/main.8c76db0a.css +1 -0
  3. package/build/static/js/main.57c0adfd.js +2 -0
  4. package/dist/launcher/conf.json +2 -2
  5. package/dist/launcher/uuv-assistant-launcher.js +30 -4
  6. package/dist/launcher/uuv-assistant.js +26 -16
  7. package/package.json +13 -9
  8. package/build/static/css/main.a63bc536.css +0 -2
  9. package/build/static/js/main.4685455a.js +0 -3
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,51 @@ 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
- ## Installing
79
+ ## Online demo
80
+
81
+ <a href="https://uuv-assistant.vercel.app/">
82
+ <img src="https://e2e-test-quest.github.io/uuv/img/assistant/online-demo.png" alt="assistant online demo"/>
83
+ </a>
84
+
85
+ ## Installation
86
+ ```bash
87
+ npm install --save-dev @uuv/assistant
88
+ ```
89
+ or
90
+ ```bash
91
+ yarn add -D @uuv/assistant
92
+ ```
48
93
 
49
- <a href="https://e2e-test-quest.github.io/uuv/docs/tools/uuv-assistant"><img src="https://img.shields.io/badge/run%20uuv%20assistant%20doc-red?&style=for-the-badge&logo=github&logoColor=white" alt="documentation for run uuv assistant"/></a>
94
+ ## Usage
50
95
 
51
- <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%20doc-red?&style=for-the-badge&logo=github&logoColor=white" alt="documentation containing sentences"/></a>
96
+ ### Scenarios example
97
+ You can find test examples here : [google.feature](https://github.com/e2e-test-quest/uuv/example/google.fr.feature)
98
+
99
+ ### Launch
100
+ To launch uuv assistant :
101
+ ```bash
102
+ npx uuv-assistant --targetUrl=<targetUrl>
103
+ ```
104
+ | Name | Description | Example |
105
+ |-------------|---------------------------------------------------------------------------------------------------------------|---------------------------------------|
106
+ | `targetUrl` | Target website url | https://e2e-test-quest.github.io/uuv/ |
107
+
108
+ The dictionary is available in french and english. It can be accessed with this link:
109
+
110
+ <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
111
 
53
112
  ## License
54
113
 
55
- [<a href="https://www.npmjs.com/package/@uuv/cypress">
56
- <img src="https://img.shields.io/badge/license-Apache%202.0-blue" alt="npm"/>
114
+ [<a href="https://github.com/e2e-test-quest/uuv/blob/main/LICENSE">
115
+ <img src="https://img.shields.io/badge/license-Apache%202.0-blue" alt="apache license"/>
57
116
  </a>](https://www.apache.org/licenses/LICENSE-2.0)
58
117
 
59
- This project is licensed under the terms of the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0).
118
+ This project is licensed under the terms of the [Apache 2.0 license](https://github.com/e2e-test-quest/uuv/blob/main/LICENSE).
119
+
120
+ ## Authors
121
+
122
+ - [@luifr10](https://github.com/luifr10)
123
+ - [@stanlee974](https://github.com/stanlee974)
package/build/static/css/main.8c76db0a.css ADDED
@@ -0,0 +1 @@
1
+ body{-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale;font-family:-apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Oxygen,Ubuntu,Cantarell,Fira Sans,Droid Sans,Helvetica Neue,sans-serif;margin:0}code{font-family:source-code-pro,Menlo,Monaco,Consolas,Courier New,monospace}.anticon{display:inline-flex!important}.uuvAssistant{box-shadow:0 .0625em .0625em rgba(0,0,0,.25),0 .125em .5em rgba(0,0,0,.25),inset 0 0 0 1px hsla(0,0%,100%,.1);opacity:95%}.uuvArrowExpander{cursor:pointer;left:50%;width:30px}.uuvArrowExpander,.uuvFloatingButton{border-color:grey;height:30px;position:absolute;top:-1em}.uuvFloatingButton{width:120px;z-index:9999999779}.uuvActionAside :disabled{width:200px}.uuvActionAside{border-color:grey;margin-left:10%;margin-right:10px;width:80%}