Never Patronize Mothers

    coverage-badge-creator
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.12 • Public • Published

    Coverage Badge Creator


    CI Build Code-Style

    MIT License Release Maintenance

    Table of Contents
    1. About The Project
    2. Installation
    3. Usage
    4. Config
    5. Requirements
    6. Built With
    7. Contributing
    8. License
    9. Contact
    10. Acknowledgements

    About The Project

    Coverage Badge Creator is a super easy to use tool for your project. It creates badges based on your test coverage and inserts them into the README. All without any third-party libraries or tools.

    Installation

    npm:

    npm install --save-dev coverage-badge-creator

    yarn:

    yarn add --dev coverage-badge-creator

    Usage

    1. First you need to set up your test environment.

    2. Insert one of the following keys anywhere in your README. These will be replaced by the coverage-badge-creator with the appropriate badge.

      The following keys are available:

      • $coverage$
      • $statements$
      • $branches$
      • $functions$
      • $lines$

      important are also the surrounding dollar signs


    3. Now you can create the badges.

      Add the command to your package.json scripts block:

      "scripts": {
        "coverage:badge": "coverage-badge-creator",
      }   

      and run it from the CLI:

      npm run coverage:badge

    Config

    There are various ways to configure the badges according to your wishes. To do this, you only need to create a new file called .badge-config. Then you have the following options:

    For a simple example click here.

    coverage file path

    {
      coverage_file_path: './coverage/json-summary.json'
    }
    

    badges

     {
       badges: {
         coverage: {
          logo: 'foo'
          color: 'bar'
         }
       }
     }
    

    Depending on your test tool, you will probably have the following badges available for configuration:

    • coverage
    • statements
    • branches
    • functions
    • lines

    Options

    • style
      plastic flat flat-square flat-for-the-badge social
    • logo
      kotlin medium github
    • logoColor
      blue green white
    • color
      blue green white
    • link
      blue green white

    For more information on all options, see ->

    Extended

    In addition, you have further options in the cli.

    • --config

      This allows you to change the path and name of the configuration file.

      "scripts": {
        "coverage:badge": "coverage-badge-creator --config './badge-coverage-config.json'",
      }

    Requirements

    • Node > v10.0.0

    Built With

    This section lists all programming languages and main frameworks.

    Contributing

    Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

    1. Fork the Project
    2. Create your Feature Branch (git checkout -b feature/new_feature)
    3. Commit your Changes (git commit -m 'feat: Add new feature')
    4. Push to the Branch (git push origin feature/new_feature)
    5. Open a Pull Request

    License

    Distributed under the MIT License. See LICENSE for more information.

    Contact

    This npm package is primarily the work of Henry Steinhauer (H3nSte1n), for full list of contributors see the contributors graph.

    Acknowledgements

    Install

    npm i coverage-badge-creator

    DownloadsWeekly Downloads

    620

    Version

    1.0.12

    License

    MIT

    Unpacked Size

    25.7 kB

    Total Files

    37

    Last publish

    Collaborators

    • h3nste1n