@adobe/gen-health-table

Generate a Markdown table with health badges for repos.

Usage no npm install needed!

<script type="module">
  import adobeGenHealthTable from 'https://cdn.skypack.dev/@adobe/gen-health-table';
</script>

README

Module Version Downloads Build Status Coverage Issues Pull Requests
@adobe/gen-health-table Version Downloads/week Build Status Codecov Coverage Github Issues Github Pull Requests

gen-health-table

CLI utility and module to generate Markdown health tables for scoped repos.

This will generate a Markdown table for a list of Github repos, with badges for these headers:

Module Version Downloads Build Status Coverage Issues Pull Requests

Installation:

CLI: npm install -g @adobe/gen-health-table

Dev module: npm install --save-dev @adobe/gen-health-table

CLI Usage:

$ gen-health-table
Please provide an argument: path to a .json file containing scoped repo names.
For example, for https://github.com/adobe/aio-cli, you would just list adobe/aio-cli

Module usage:

const genHealth = require('@adobe/gen-health-table')

const main = async () => {
    const repos = [ 'foo/bar', 'baz' ]
    const markdownData = await genHealth(repos)
    console.log(markdownData)
}

main()

Contributing

Contributions are welcome! Read the Contributing Guide for more information.

Licensing

This project is licensed under the Apache V2 License. See LICENSE for more information.