Architecture and Contribution

🎵Handshake-Nodejs-Reporters

Setup for the common-handshakes and other custom reporters for the Node.JS based frameworks

We have made this project with Turbo Repo. This would have"

  • common-handshakes - core package for all custom reporters

  • wdio-handshake-reporter - custom reporter for webdriverio

  • handshake-dashboard - Dashboard Package

  • apps/test-* - End to End Tests for generating the sample data and also for testing end-to-end flow

Steps

  1. move to handshake-nodejs-reporters/

  2. execute: npm install

  3. it's done 😊

Tests

for testing, we have the pipe command: npm run sanity for running the sanity tests across all the apps and packages

or you can run npm run test for running even non-sanity tests.

Changesets

For versioning, we use changesets.

After performing any changes, you will be required to execute the following commands:

  1. npx changeset

    1. select the packages you want to change the version

    2. select the type of bump (patch/minor/major)

  2. you can edit the README files generated to document the changes made.

Linting

Lint before building the files using npm run lint. eslint would take care of the rest. Currently, we use eslint 8.57.0

Building

To build (we use tsup) all the packages, npm run build, it's another pipe command that runs across all these relevant packages.

Reference

PreviousStorybook SetupNextTest Packages

Last updated