https://github.com/ivmartel/jsonqa2md

Convert json QA docs into markdown
https://github.com/ivmartel/jsonqa2md

Last synced: about 1 month ago
JSON representation

Convert json QA docs into markdown

• Host: GitHub
• URL: https://github.com/ivmartel/jsonqa2md
• Owner: ivmartel
• License: gpl-3.0
• Created: 2024-04-23T14:14:33.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-09-16T07:09:24.000Z (2 months ago)
• Last Synced: 2024-09-16T08:37:34.835Z (2 months ago)
• Language: JavaScript
• Size: 1.7 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • Contributing: .github/contributing.md
  • License: license.txt

Awesome Lists containing this project

README

        
jsonqa2md

=======

Cli to convert json QA documents into markdown.

Run `node jsonqa2md` in a javascript github repo, it will generate markdown files

that can be integrated in a jsdoc documentation. See the demo files of this repo for example input/output.

Default input:

- `package.json`: json package description

- `resources/doc/user-stories.json`: json requirements as a list of

`{id, name, group, description}`

- `build/test-results.json`: json tests results as output by Karma

Test descriptions must make a reference to a requirement. They should be in the

form of: `Add zero - #JQ2MD-001 Add two numbers` ([name] - [requirement key] [requirement name]).

Default output:

- `resources/doc/tutorials/user-stories.md`: with warnings for duplicate keys and/or names

- `resources/doc/tutorials/test-results.md`: with a traceability list to see tested requirements

Typical workflow:

```sh

# run tests to generate test results

yarn run test-ci

# convert json to md

node jsonqa2md

# integrate in documentation

yarn run doc

```

Inspired from https://github.com/davidahouse/junit-to-md