-
Notifications
You must be signed in to change notification settings - Fork 49
docs: add npm downloads badges to all reporter READMEs #891
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
61 commits
Select commit
Hold shift + click to select a range
6f7ed83
feat(01-foundation): create core documentation templates (README and …
gibiw ee655f3
feat(01-foundation): create feature guide templates
gibiw 0ca510e
feat(01-foundation): create placeholder naming convention reference
gibiw cc544f9
docs(01-foundation): complete 01-01 plan execution
gibiw 372cbd7
feat(01-foundation-02): create placeholder validation script
gibiw 97de48e
feat(01-foundation-02): document framework syntax variations
gibiw b01d665
feat(01-foundation-02): create code style guide for documentation
gibiw 8c34c5c
docs(01-foundation-02): complete validation and reference documentati…
gibiw b4c8770
feat(01-foundation): create template usage guide with comprehensive w…
gibiw c6b5d35
docs(01-foundation-03): complete template usage guide and foundation …
gibiw ece26d0
docs(02-core-documentation): create phase plan
gibiw 817c6ce
fix(02): revise plans based on checker feedback
gibiw c422386
feat(02-core-documentation): apply master templates to Vitest reporter
gibiw 9af6811
docs(02-01): apply templates to Jest reporter (README.md + usage.md)
gibiw 187f4b4
feat(02-core-documentation): apply templates to Cypress reporter
gibiw 7573805
feat(02-core-documentation): apply master templates to CucumberJS rep…
gibiw 6cc507e
feat(02-core-documentation): apply templates to Mocha reporter
gibiw 089e7f7
docs(02-01): apply templates to Playwright reporter (README.md + usag…
gibiw e645b01
docs(02-core-documentation-04): apply templates to Newman reporter
gibiw 9522024
docs(02-core-documentation): complete 02-03 plan execution summary
gibiw 5eacbea
docs(02-core-documentation-04): apply templates to TestCafe reporter
gibiw 9fb5e9a
docs(02-core-documentation-04): apply templates to WDIO reporter
gibiw 419c053
docs(02-core-documentation-04): complete Newman, TestCafe, and WDIO plan
gibiw 888f15c
docs(02-core-documentation): add missing sections and standardize str…
gibiw a0777cc
docs(02-05): complete cross-framework validation plan
gibiw 8ec0d52
docs(02-06): complete human review and Phase 2 verification
gibiw 55d8c9f
Updated gitignore
gibiw 0899b99
docs(03-feature-guides): create phase plan
gibiw b722a19
feat(03-01): create ATTACHMENTS.md for Jest and Playwright
gibiw 49af464
feat(03-feature-guides): add STEPS.md for Jest and Playwright
gibiw a1975d7
feat(03-01): create ATTACHMENTS.md for Cypress, Mocha, and Vitest
gibiw 6c9cdde
feat(03-03): create ATTACHMENTS.md and STEPS.md for TestCafe and WDIO
gibiw c79a149
feat(03-feature-guides): add STEPS.md for Cypress, Mocha, and Vitest
gibiw af0e4a4
feat(03-03): create ATTACHMENTS.md and STEPS.md for CucumberJS and Ne…
gibiw 747dac6
docs(03-03): complete plan summary and update STATE.md
gibiw 5a3fdff
feat(03-feature-guides-04): create MULTI_PROJECT.md for Newman and Te…
gibiw 42f46d9
docs(03-05): create UPGRADE.md for Jest, Playwright, and Cypress
gibiw f70fbf5
feat(03-feature-guides-04): enhance 7 existing MULTI_PROJECT.md files
gibiw 9b07d3f
docs(03-05): create UPGRADE.md for remaining 6 frameworks
gibiw db3f016
docs(03-feature-guides-04): complete multi-project documentation plan
gibiw 42b43a3
docs(03-feature-guides-06): complete Phase 3 validation and approval
gibiw 8a976ee
fix(04-03): correct TestCafe attachment parameter from contentType to…
gibiw 95ad377
fix(04-01): correct vitest attachment parameter from contentType to type
gibiw e2aadcf
docs(04-03): add expected behavior documentation to example README files
gibiw d6fcd99
docs(04-02): fix Vitest documentation framework-specific syntax
gibiw 0bcb31f
docs(04-03): complete plan documentation and update state
gibiw 9160e33
docs(04-02): add expected behavior documentation to example README files
gibiw 68eae00
feat(04-04): add CI workflow for testing examples
gibiw b89e31d
feat(04-04): add Phase 4 validation report and complete EX-02
gibiw 82adea3
docs(04-04): complete CI workflow and validation plan
gibiw 4d055e8
chore(05-01): create terminology dictionary and reference guide
gibiw 70b31e0
chore(05-01): create validation scripts for terminology and links
gibiw 6bfae42
docs(05-01): complete validation tooling plan
gibiw 393f2bc
docs(05-02): fix terminology, links, and TOCs across all 9 frameworks
gibiw 74388e0
docs(05-02): add CI validation and create QA report
gibiw eb00591
docs(05-02): complete plan 05-02 execution with summary and state upd…
gibiw 0648400
docs: add npm downloads badges to all reporter READMEs
gibiw bb5509b
chore: remove .planning directory and examples workflow from git
gibiw 07f86ed
docs: add missing documentation links to TestCafe, Newman, and WDIO R…
gibiw a3b338a
docs: fix multi-project example paths in commons README
gibiw 9b06bfa
Merge branch 'main' into docs/04-examples-validation-plans
gibiw File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -77,4 +77,7 @@ jspm_packages/ | |
|
|
||
| # Temporary files and playground | ||
| tmp | ||
| *.tmp | ||
| *.tmp | ||
|
|
||
| CLAUDE.md | ||
| .planning/ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| # CucumberJS Example | ||
|
|
||
| This is a sample project demonstrating how to write and execute tests using the CucumberJS framework with integration to Qase Test Management. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Ensure that the following tools are installed on your machine: | ||
|
|
||
| 1. [Node.js](https://nodejs.org/) (version 18 or higher is recommended) | ||
| 2. [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/) | ||
|
|
||
| ## Setup Instructions | ||
|
|
||
| 1. Clone this repository by running the following commands: | ||
| ```bash | ||
| git clone https://github.com/qase-tms/qase-javascript.git | ||
| cd qase-javascript/examples/single/cucumberjs | ||
| ``` | ||
|
|
||
| 2. Install the project dependencies: | ||
| ```bash | ||
| npm install | ||
| ``` | ||
|
|
||
| 3. Create a `qase.config.json` file in the root of the project. Follow the instructions on [how to configure the file](https://github.com/qase-tms/qase-javascript/tree/main/qase-javascript-commons#configuration). | ||
|
|
||
| ## Example Files | ||
|
|
||
| This example includes: | ||
|
|
||
| * **features/** — Gherkin feature files with test scenarios | ||
| * `simple.feature` — Basic scenarios with Qase tags (@QaseID, @QaseTitle, @QaseFields) | ||
| * `table.feature` — Examples using data tables | ||
| * **step_definitions/** — Step implementation files | ||
| * `simple_steps.js` — Step definitions using native Cucumber Given/When/Then | ||
| * `table_steps.js` — Step definitions for table-based scenarios | ||
| * **qase.config.json** — Qase reporter configuration | ||
|
|
||
| ## Running Tests | ||
|
|
||
| To run tests locally without reporting to Qase: | ||
|
|
||
| ```bash | ||
| QASE_MODE=off npm test | ||
| ``` | ||
|
|
||
| To run tests and upload the results to Qase Test Management: | ||
|
|
||
| ```bash | ||
| npm test | ||
| ``` | ||
|
|
||
| Or with explicit mode: | ||
|
|
||
| ```bash | ||
| QASE_MODE=testops npx cucumber-js -f cucumberjs-qase-reporter | ||
| ``` | ||
|
|
||
| ## Expected Behavior | ||
|
|
||
| When tests execute with Qase reporting enabled: | ||
|
|
||
| * **Gherkin scenarios** are reported as individual test cases in Qase | ||
| * **Given/When/Then/And steps** from feature files are automatically reported as Qase test steps | ||
| * **@QaseID tags** link scenarios to existing test cases in your Qase project | ||
| * **@QaseTitle tags** override the default scenario name in Qase | ||
| * **@QaseFields tags** add metadata (severity, priority, etc.) to test results | ||
| * **Attachments** added via `this.attach()` in step definitions are included in Qase results | ||
|
|
||
| ## Framework-Specific Features | ||
|
|
||
| CucumberJS with Qase has unique patterns: | ||
|
|
||
| * **No programmatic qase.step() API** — Steps come from Gherkin syntax (Given/When/Then) | ||
| * **Native Cucumber attachments** — Use `this.attach(content, mimeType)` in step definitions (not `qase.attach()`) | ||
| * **Tag-based metadata** — Test configuration uses Gherkin tags instead of programmatic calls | ||
| * **Feature-based organization** — Test suite hierarchy comes from Feature/Scenario structure | ||
|
|
||
| ## Additional Resources | ||
|
|
||
| For more details on how to use this integration with Qase Test Management, visit the [Qase CucumberJS documentation](https://github.com/qase-tms/qase-javascript/tree/main/qase-cucumberjs). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
AI tool artifacts added to shared project gitignore
Low Severity
CLAUDE.mdand.planning/are personal AI development tool artifacts added to the shared project.gitignore. These are developer-specific files (Claude AI context/planning) that belong in the developer's global gitignore (~/.gitignore_global) or.git/info/exclude, not in the repository's.gitignorewhich is shared with all contributors.