npm - @uuv/cypress - Versions diffs - 1.3.2 → 1.4.0 - Mend

@uuv/cypress 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.

Files changed (6) hide show

package/CHANGELOG.md CHANGED Viewed

@@ -1,3 +1,24 @@
+# [1.4.0](https://github.com/e2e-test-quest/uuv/compare/runner-cypress-v1.3.3...runner-cypress-v1.4.0) (2023-05-16)
+### Bug Fixes
+* **runner-commons:** restructure documentation, [#112](https://github.com/e2e-test-quest/uuv/issues/112) ([f5db612](https://github.com/e2e-test-quest/uuv/commit/f5db612da3c31d2e6f4a3f647546167ebcbddaa5))
+* **runner-cypress:** add benefit block [#112](https://github.com/e2e-test-quest/uuv/issues/112) ([04cf36f](https://github.com/e2e-test-quest/uuv/commit/04cf36fd0e43614ae801bb08bf514a4ba3cca975))
+* **runner-cypress:** restructure documentation, [#112](https://github.com/e2e-test-quest/uuv/issues/112) ([43353a8](https://github.com/e2e-test-quest/uuv/commit/43353a88499e3270fa64c518b7332541e3a01652))
+### Features
+* **runner-playwright:** add error details and screenshot to report, fixes [#110](https://github.com/e2e-test-quest/uuv/issues/110) ([3c4a3cd](https://github.com/e2e-test-quest/uuv/commit/3c4a3cd192b90242dd07bbdc4bb3ece780ee0c40))
+## [1.3.3](https://github.com/e2e-test-quest/uuv/compare/runner-cypress-v1.3.2...runner-cypress-v1.3.3) (2023-05-15)
+### Bug Fixes
+* **runner-playwright:** fix workspace lint during ci, [#108](https://github.com/e2e-test-quest/uuv/issues/108) ([a3ac0d6](https://github.com/e2e-test-quest/uuv/commit/a3ac0d68d27c34f36237b6f74b94e160b7cde9b8))
 ## [1.3.2](https://github.com/e2e-test-quest/uuv/compare/runner-cypress-v1.3.1...runner-cypress-v1.3.2) (2023-05-11)

package/README.md CHANGED Viewed

@@ -1,3 +1,4 @@
 # @uuv/runner-cypress
 <p align="center">
 <a href="https://e2e-test-quest.github.io/uuv/">
@@ -6,9 +7,6 @@
 </picture>
 </a>
 </p>
-<p align="center">
-<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>
-</p>
 <h3 align="center">
 Test as final user
@@ -33,22 +31,40 @@ Make test writing fast, understandable by any human understanding English or Fre
 </a><br />
 </p>
-<div align="center">
-<h4>
-Demo in english
-</h4>
-<a href="https://player.vimeo.com/video/822253247?texttrack=en&h=617306172d&amp;badge=0&amp;autopause=0&amp;player_id=0&amp;app_id=58479" rel="nofollow">
-    <img alt="runner-cypress in english" src="https://e2e-test-quest.github.io/uuv/img/cypress/screenshot.png" style="max-width: 100%;" width="75%" height="75%">
-  </a>
-<h4>
-Demo in french
-</h4>
-<a href="https://player.vimeo.com/video/822253247?texttrack=fr&h=617306172d&amp;badge=0&amp;autopause=0&amp;player_id=0&amp;app_id=58479" rel="nofollow">
-    <img alt="runner-cypress in french" src="https://e2e-test-quest.github.io/uuv/img/cypress/screenshot.png" style="max-width: 100%;" width="75%" height="75%">
-  </a>
-</div>
-## What is @uuv/cypress ?
+## Benefits
+- If used correctly, integrates accessibility from the development stage
+- 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
+- A wizard that facilitates the writing of tests by suggesting the most accessible sentences
+- Integrates several runtime engines: Cypress / Playwright
+- User-friendly and standardized execution report
+  ### <u>Comparison</u>
+| Criteria | Cypress | Playwright | Testing library | UUV |
+|:-: |:-: |:-: |:-: |:-: |
+| User centrism | :x: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
+| Native accessibility | :x: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
+| Easy setup configuration for BDD test | :warning: | :warning: | :heavy_minus_sign: | :heavy_check_mark: |
+| Understandable by everyone <br> (included non dev) | :x: | :x: | :x: | :heavy_check_mark: |
+### <u>Syntax example</u>
+With this dom example :
+  ```html
+  <body>
+  <h1>Result<h1>
+  </body>
+```
+we see that the sentence proposed by **UUV is the most understandable** of all
+| Library | Syntax |
+|:--|:--|
+| Cypress  | cy.get('result').should('exist') |
+| Playwright| await expect(page.getByTitle('Result')).toHaveCount(1) |
+| Testing library  | expect(screen.getByTitle(/Result/i)).toBeTruthy() |
+| UUV | Then I should see a title named "Result"|
+## Documentation
+<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>
+## What is @uuv/cypress?
 <p align="center">
@@ -56,20 +72,88 @@ The `@uuv` library (User centric Usecases Validator) is an ecosystem that simpli
 We can use the cypress engine to run test or playwright with [@uuv/playwright](https://www.npmjs.com/package/@uuv/playwright)
 </p>
-## Installing
+## Demonstration
+### Demo in english
+<a href="https://player.vimeo.com/video/822253247?texttrack=en&h=617306172d&amp;badge=0&amp;autopause=0&amp;player_id=0&amp;app_id=58479" rel="nofollow">
+<img alt="runner-cypress in english" src="https://e2e-test-quest.github.io/uuv/img/cypress/screenshot.png" style="max-width: 100%;" width="75%" height="75%">
+</a>
+### Demo in french
+<a href="https://player.vimeo.com/video/822253247?texttrack=fr&h=617306172d&amp;badge=0&amp;autopause=0&amp;player_id=0&amp;app_id=58479" rel="nofollow">
+<img alt="runner-cypress in french" src="https://e2e-test-quest.github.io/uuv/img/cypress/screenshot.png" style="max-width: 100%;" width="75%" height="75%">
+</a>
-<a href="https://e2e-test-quest.github.io/uuv/docs/getting-started/installation#cypress"><img src="https://img.shields.io/badge/Install%20Cypress%20doc-red?&style=for-the-badge&logo=github&logoColor=white" alt="documentation for install uuv cypress"/></a>
+## Installation
+```bash
+npm install --save-dev @uuv/cypress
+```
+or
+```bash
+yarn add -D @uuv/cypress
+```
+## Configuration  (optional)
 <a href="https://e2e-test-quest.github.io/uuv/docs/getting-started/configuration"><img src="https://img.shields.io/badge/Configure%20cypress%20doc-red?&style=for-the-badge&logo=github&logoColor=white" alt="documentation for configure uuv cypress"/></a>
+## Usage
+### Write test
+To write your first test, create the file `uuv/e2e/first-test.feature` in the project root with the following content :
+  ```gherkin
+  Feature: Hello World
+  Scenario: Search - Successful case
+    When I visit path "/"
+    Then I should see an element with role "heading" and name "My app title"
+  ```
+For more details, please go to the documentation:
 <a href="https://e2e-test-quest.github.io/uuv/docs/test/first-test"><img src="https://img.shields.io/badge/Write%20test%20doc-red?&style=for-the-badge&logo=github&logoColor=white" alt="documentation for write test"/></a>
+### Run test
+#### browser mode
+```bash
+npx uuv open
+```
+or
+```bash
+yarn uuv open
+```
+#### headless mode
+##### without args
+```bash
+npx uuv e2e
+```
+or
+```bash
+yarn uuv e2e
+```
+##### with args
+```bash
+npx uuv e2e --browser=edge --env="{'TAGS':'@mobile'}" --generateHtmlReport
+```
+or
+```bash
+yarn uuv e2e --browser=edge --env="{'TAGS':'@mobile'}" --generateHtmlReport
+```
+For more details, please go to the documentation:
 <a href="https://e2e-test-quest.github.io/uuv/docs/test/running-test"><img src="https://img.shields.io/badge/Run%20test%20doc-red?&style=for-the-badge&logo=github&logoColor=white" alt="documentation for run test"/></a>
 ## License
-[<a href="https://www.npmjs.com/package/@uuv/cypress">
-<img src="https://img.shields.io/badge/license-Apache%202.0-blue" alt="npm"/>
+[<a href="https://github.com/e2e-test-quest/uuv/blob/main/LICENSE">
+<img src="https://img.shields.io/badge/license-Apache%202.0-blue" alt="apache license"/>
 </a>](https://www.apache.org/licenses/LICENSE-2.0)
-This project is licensed under the terms of the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0).
+This project is licensed under the terms of the [Apache 2.0 license](https://github.com/e2e-test-quest/uuv/blob/main/LICENSE).
+## Authors
+- [@luifr10](https://github.com/luifr10)
+- [@stanlee974](https://github.com/stanlee974)

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@uuv/cypress",
-  "version": "1.3.2",
+  "version": "1.4.0",
   "type": "commonjs",
   "author": "Louis Fredice NJAKO MOLOM (https://github.com/luifr10) & Stanley SERVICAL (https://github.com/stanlee974)",
   "description": "A solution to run E2E tests written in cucumber(BDD) with cypress.",
@@ -42,7 +42,7 @@
     "@badeball/cypress-cucumber-preprocessor": "16.0.3",
     "@cypress/webpack-preprocessor": "5.17.0",
     "@testing-library/cypress": "9.0.0",
-    "@uuv/runner-commons": "1.3.2",
+    "@uuv/runner-commons": "1.4.0",
     "axe-core": "4.7.0",
     "chalk": "4.1.2",
     "cucumber-json-report-formatter": "0.1.4",

package/dist/CHANGELOG.md DELETED Viewed

@@ -1,35 +0,0 @@
-## [1.3.2](https://github.com/e2e-test-quest/uuv/compare/runner-cypress-v1.3.1...runner-cypress-v1.3.2) (2023-05-11)
-### Bug Fixes
-* **runner-cypress:** add lint script [#8](https://github.com/e2e-test-quest/uuv/issues/8) ([78c43d1](https://github.com/e2e-test-quest/uuv/commit/78c43d1406709953086793298132f8fb85e68ba8))
-* **runner-cypress:** modify doc for npmjs [#94](https://github.com/e2e-test-quest/uuv/issues/94) ([b7ba332](https://github.com/e2e-test-quest/uuv/commit/b7ba332900081318984e495d563c1477ffacd801))
-* **runner-playwright:** update @cucumber/cucumber dep version, [#93](https://github.com/e2e-test-quest/uuv/issues/93) ([a891a70](https://github.com/e2e-test-quest/uuv/commit/a891a70daad1cb5d7d34f25097a31d89f92b92c6))
-## [1.3.1](https://github.com/e2e-test-quest/uuv/compare/runner-cypress-v1.3.0...runner-cypress-v1.3.1) (2023-05-09)
-### Bug Fixes
-* **runner-commons:** fix npm documentation, [#87](https://github.com/e2e-test-quest/uuv/issues/87) ([ba7394c](https://github.com/e2e-test-quest/uuv/commit/ba7394cd755e350fd5a5964aed26435e5979e77d))
-* **runner-commons:** modify keyword for npmjs, [#87](https://github.com/e2e-test-quest/uuv/issues/87) ([392c4d0](https://github.com/e2e-test-quest/uuv/commit/392c4d0337179dae2c2a96c26dc2cc32e0ad87b3))
-* **runner-cypress:** fix npm documentation, [#87](https://github.com/e2e-test-quest/uuv/issues/87) ([1ccef97](https://github.com/e2e-test-quest/uuv/commit/1ccef97182614635050defdccbe8838df2603247))
-* **runner-cypress:** modify keyword for npmjs, [#87](https://github.com/e2e-test-quest/uuv/issues/87) ([080f82d](https://github.com/e2e-test-quest/uuv/commit/080f82d92c376b0d30ee2fb3473a07d5fc1f0d73))
-* **runner-cypress:** move webpack dep from devDeps to deps ([2e96fa7](https://github.com/e2e-test-quest/uuv/commit/2e96fa77d8b9845d6df899603dee087aad13e8ef))
-# Change Log
-All notable changes to this project will be documented in this file.
-The format is based on [Keep a Changelog](http://keepachangelog.com/)
-and this project adheres to [Semantic Versioning](http://semver.org/).
-## [1.2.0-beta-20230424] - 2023-04-24
-### Added
-- [#4](https://github.com/e2e-test-quest/uuv/issues/4)
-  MINOR Amélioration du scoring npm
-- [#3](https://github.com/e2e-test-quest/uuv/issues/3)
-  MAJOR Initialisation du pipeline
-- [#1](https://github.com/e2e-test-quest/uuv/issues/1)
-  MAJOR Rajout de la licence Apache 2.0

package/dist/CONTRIBUTING.md DELETED Viewed

@@ -1,81 +0,0 @@
-# Contributors guide
-**Want to contribute?**
-We try to make it easy, and all contributions, even the smaller ones, are more than welcome.
-This includes bug reports, fixes, documentation, examples...
-But first, read this page (including the small print at the end).
-Contributions are available on https://github.com/e2e-test-quest/uuv
-## Legal
-All original contributions to _UUV_ are licensed under the
-[Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0),
-version 2.0 or later.
-All contributions are subject to the [Developer Certificate of Origin](https://developercertificate.org/) (DCO).
-The DCO is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project.
-The DCO text is also included verbatim in the [DCO.txt](DCO.txt) file in the root directory of the repository.
-Contributors **must** _sign-off_ that they adhere to these requirements by adding a `Signed-off-by` line to commit messages, as shown below:
-```text
-This is the commit message
-Signed-off-by: Joe Dev <joe.dev@developer.example.org>
-```
-Git has a handy [`-s` command line option](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---signoff) to append this automatically to your commit message:
-```bash
-$ git commit -s -m 'This is the commit message'
-```
-## Reporting an issue
-This project uses GitLab issues to manage the issues.
-Before creating an issue:
-1. upgrade your project to the latest released template version, and check whether your bug is still present,
-2. have a look in the opened issues if your problem is already known/tracked, and possibly contribute to the thread with your own information.
-If none of the above was met, open an issue directly in GitLab, select the appropriate issue template and fill-in each section when applicable.
-## Submitting a code change
-### Git Setup
-Before contributing, make sure you have set up your Git authorship correctly:
-```bash
-git config --global user.name "Your Full Name"
-git config --global user.email your.email@example.com
-```
-### Workflow
-All submissions, including submissions by project members, need to be reviewed before being merged.
-To contribute:
-1. Create an issue describing the bug or enhancement you want to propose (select the right issue template).
-2. Make sure the issue has been reviewed and agreed.
-3. Create a Merge Request, from your **own** fork (see [forking workflow](https://docs.github.com/en/get-started/quickstart/fork-a-repo) documentation).
-   Don't hesitate to mark your MR as `Draft` as long as you think it's not ready to be reviewed.
-### Git Commit Conventions
-In addition to being signed-off according the [Developer Certificate of Origin](https://developercertificate.org/) (see above),
-Git commits in _UUV_ shall be:
-1. **atomic** (1 commit `=` 1 and only 1 _thing_),
-2. **semantic** (using [semantic-release commit message syntax](https://semantic-release.gitbook.io/semantic-release/#commit-message-format)).
-3. **pattern**
-   - **SCOPE** : one of (UUV, COMMONS, CYPRESS, PLAYWRIGHT, ASSISTANT, EXTENSION, DOCS)
-   - ***TYPE*** : one of (FEAT, FIX, TECH, REFACTOR)
-   - [**SCOPE**] [***TYPE***] #issue_identifier: commit message
-   - Example :
-   ```bash
-   [CYPRESS] [FEAT] #51: upgrade library @badeball/cypress-cucumber-preprocessor version
-   ```

package/dist/README.md DELETED Viewed

@@ -1,75 +0,0 @@
-# @uuv/runner-cypress
-<p align="center">
-<a href="https://e2e-test-quest.github.io/uuv/">
-<picture>
-<img alt="UUV Logo" src="https://e2e-test-quest.github.io/uuv/img/uuv.png">
-</picture>
-</a>
-</p>
-<p align="center">
-<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>
-</p>
-<h3 align="center">
-Test as final user
-</h3>
-<p align="center">
-Make test writing fast, understandable by any human understanding English or French.
-</p>
-<p align="center">
-<a href="https://www.npmjs.com/package/@uuv/cypress">
-<img src="https://img.shields.io/badge/available%20on%20npm-grey?logo=npm" alt="npm"/>
-</a>
-<a href="https://www.cypress.io/">
-<img src="https://img.shields.io/badge/tested with-cypress-04C38E?logo=cypress" alt="cypress"/>
-</a>
-<a href="https://testing-library.com/">
-<img src="https://img.shields.io/badge/tested%20with-testing%20library-ED3B3A?logo=testing-library" alt="testing-library"/>
-</a>
-<a href="https://cucumber.io/">
-<img src="https://img.shields.io/badge/tested%20with-cucumber-1dbb68?logo=cucumber" alt="cucumber"/>
-</a><br />
-</p>
-<div align="center">
-<h4>
-Demo in english
-</h4>
-<a href="https://player.vimeo.com/video/822253247?texttrack=en&h=617306172d&amp;badge=0&amp;autopause=0&amp;player_id=0&amp;app_id=58479" rel="nofollow">
-    <img alt="runner-cypress in english" src="https://e2e-test-quest.github.io/uuv/img/cypress/screenshot.png" style="max-width: 100%;" width="75%" height="75%">
-  </a>
-<h4>
-Demo in french
-</h4>
-<a href="https://player.vimeo.com/video/822253247?texttrack=fr&h=617306172d&amp;badge=0&amp;autopause=0&amp;player_id=0&amp;app_id=58479" rel="nofollow">
-    <img alt="runner-cypress in french" src="https://e2e-test-quest.github.io/uuv/img/cypress/screenshot.png" style="max-width: 100%;" width="75%" height="75%">
-  </a>
-</div>
-## What is @uuv/cypress ?
-<p align="center">
-The `@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.
-We can use the cypress engine to run test or playwright with [@uuv/playwright](https://www.npmjs.com/package/@uuv/playwright)
-</p>
-## Installing
-<a href="https://e2e-test-quest.github.io/uuv/docs/getting-started/installation#cypress"><img src="https://img.shields.io/badge/Install%20Cypress%20doc-red?&style=for-the-badge&logo=github&logoColor=white" alt="documentation for install uuv cypress"/></a>
-<a href="https://e2e-test-quest.github.io/uuv/docs/getting-started/configuration"><img src="https://img.shields.io/badge/Configure%20cypress%20doc-red?&style=for-the-badge&logo=github&logoColor=white" alt="documentation for configure uuv cypress"/></a>
-<a href="https://e2e-test-quest.github.io/uuv/docs/test/first-test"><img src="https://img.shields.io/badge/Write%20test%20doc-red?&style=for-the-badge&logo=github&logoColor=white" alt="documentation for write test"/></a>
-<a href="https://e2e-test-quest.github.io/uuv/docs/test/running-test"><img src="https://img.shields.io/badge/Run%20test%20doc-red?&style=for-the-badge&logo=github&logoColor=white" alt="documentation for run test"/></a>
-## License
-[<a href="https://www.npmjs.com/package/@uuv/cypress">
-<img src="https://img.shields.io/badge/license-Apache%202.0-blue" alt="npm"/>
-</a>](https://www.apache.org/licenses/LICENSE-2.0)
-This project is licensed under the terms of the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0).