JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 127
  • Score
    100M100P100Q78006F
  • License MIT

A npm cli tool that reads your package.json/project metadata and git config and connects your readme with multiple badge providers (shields.io, badgen.net etc)

Package Exports

  • git-auto-badger

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (git-auto-badger) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Git Auto badger

A npm cli tool that reads your packagejson/project metadata and git config and connects your readme with multiple badge providers (shields.io, badgen.net etc)

Build Status version package size license

dependancies downloads all contributors code of conduct chat with community

stargazers number of forks Follow technikhil314 on twiter

The badges are auto generated by auto badger


Prerequisites

Node >= 10.x.x


See the demo running here

demo


Why

Because why not? I did not find any such tool out there to minimise efforts of such a robotic job. Plus some of the default provided badges lack of accessibility constrint. White on green does not meet any contrast ratio. See the badge below for example it will be difficult for low vision people to read it

demo


How to use

Install the cli

npm i -g git-auto-badger

or 

yarn add -g git-auto-badger

Add placeholder to add badges

Add following markdown comment where you want the badges to appear

[//]: <> (start placeholder for auto-badger)

Run the cli

then run following in your project root directory

npx auto-badger

And whoo hoo you are done. All the necessary badges are added to your markdown.


What all things are supported

This cli currently supports following providers from each category

  1. VCS
  2. CI/CD
  3. Coverage
  4. Package Managers
  5. License
    • Github License File [✔️]
  6. Code of Conduct
    • Github CoC File [✔️]
  7. Dependancies
  8. Package size
  9. Download Count
  10. Social
    • Github (Repo Stars, Fork) [✔️]
    • twitter (Follow user/org) [✔️]
  11. Chat

How it works?

  1. It looks for different file in your project root directory. To decide what tools are you using. And generates badges based on it.

    e.g. If you have .travis.yml then it assumes you are using travis for CI/CD and it creates a dynamic badge for travis latest build status



    or

    if you have appveyor.yml then it assumes you are using appveyor for CI/CD and it creates a dynamic badge for appveyor latest build status

Defaults

Badge Type Default
Size Bundle phobia (if browser only package)
Size package phobia (if node only package e.g cli)