403-html / mochawesome-json-to-md

Translate the extensive reports from your mochawesome and mochawesome-merge JSON reports into markdown format using templates.

Hello World! 👋

I'm Tymoteusz, a computer enthusiast who enjoys coding blunders and unexpected digital adventures. Embracing the spontaneity of "impulse" interactions has led me to some of the most memorable events of my life.

About Me

• 🤖 QA enthusiast with a focus on automation
• 🌪️ Process's flow lover
• 🌲 TypeScript Playwright (also Cypress) user
• 🐍 Python hobbyist
• 🍫 Sweets fan; a bajaderka junky

Academic Background

I completed my education at a IT technical high school, but I'm a firm believer in valuing experience over a degree. The real-world challenges and hands-on experiences have been my greatest teachers.

GitHub Stats

mochawesome-json-to-md's Issues

Fails in code workflows

Add option to pull changes from main so semvar will always work as intended

This is addressed to case: "What if something was already uploaded to main, and the workflow update does based on an old version of package.json?"

Refactor script for having fully editable template, also move to TypeScript

Move to TS due to types and simple compilation.

It'll add value to the project by splitting to src and dist, also types will help keeping everything together

• extract data from result
• build md file from template
• incorporate 10 NASA's safety rules for writing code
• add eslint stricter rules
• add code of conduct

Add workflow for checking properly named PRs

https://github.com/marketplace/semantic-pr-title

Add tests

Task

Create Jest unit tests environment, and write tests to cover all methods happy paths (and write down matrix of each case possible, for later).

Tests JSON finals types:

• one test report for each type of outcome
• multiple test reports for each type of outcome
• nested types (for each type, so like describe)

Add contribution file

Contribution (commits and PRs) will be based on conventional commits methodology. It may vary

Commits:

• feat: = feature
• ref: = refactor of something
• bug: = fixed bug
• misc: = changes to docs/README
• chore: = none of above

Example feat: New option for showing diagram

PRs:

• feat: = feature
• bug: = fixed bug
• misc: = changes to docs/README
• chore = none of above
• if it will have breaking changes for whole project (major update) it should also have BREAKING CHANGES before all. Example BREAKING CHANGES - feat: New template engine

Merging PRs

You can have as many commits as you wish but before giving for review please consider rebasing your branch to clear the commit list - so it'll leave cleaner repo after merging.

Branches names:

• major/short-description-of-change
• minor/short-description-of-change
• fix/short-description-of-change

Versioning:

• major change adds +1 to first number in version (1.0.0 -> 2.0.0)
• minor change adds +1 to second number in version (1.0.0 -> 1.1.0)
• fix change adds +1 to last number in version (1.0.0 -> 1.0.0)

Kick off

First time trying to add npm package.
Here is how to do so: https://bugfender.com/blog/how-to-create-an-npm-package/

What I need to test it:

• report from Cypress, positive and negative

Duration is wrong

The formula in index.js line 102 is wrong
const genDuration = showDuration
? > Duration: ${Math.round(duration / 60)}s \n
: "";

The value from the json is displayed in milliseconds, so to end up with seconds, divide by 1000 instead

Improvements

• incorporate 10 NASA's safety rules for writing code
• add eslint stricter rules
• add code of conduct

Add eslint with the workflow for it

• Add eslint with the workflow for it
• Resolve any eslint related issues

It should be something easy to follow along, just core to not "break the code", so eslint:recommended will do and also

env:
   node: true

to not getting errors on node's methods.

Small win: remove lodash from script

🎉 0.x.x is deprecated, please use 1.x.x version

🚨 Deprecation Notice

🎉 Version 0.x.x is now deprecated!

Please upgrade to version 1.x.x for continued support and improvements. No further updates or fixes will be made to the 0.x.x series, and future development will focus exclusively on the 1.x.x version.

Thank you for your understanding and continued support by using it!

Add workflow which will create proper semver

Add workflow which will create proper semver. Based on branch prefix. Has to update the package.json.

Add workflow for tagging and release in GitHub

## What's Changed

[list of the PRs]

**Full Changelog**: https://github.com/403-html/mochawesome-json-to-md/compare/prev...next

error | uncaughtException: Cannot access 'outputPath' before initialization

error | uncaughtException: Cannot access 'outputPath' before initialization

Rewrite return of mdTemplate