Generating badge based on sub key in package.json

[therealsujitk]

To get a badge using a key in package.json, you can do

[GET] https://img.shields.io/github/package-json/<key>/<author>/<repository>

Is it possible to read a sub key? For example,

{
    "key": {
        "subKeyA": "value",
        "subKeyB": "value"
    }
}

[calebcartwright]

Do you have a specific use case in mind?

[therealsujitk]

Take for example from this repository's package.json I'd like to display the value of the email key inside the object bugs.

[calebcartwright]

Thanks! Npm's manifest schema is largely fixed (I realize of course it can contain other 3rd party content, but is not generally viewed as an arbitrary source of metadata), so we do offer an assortment of badges that directly provide specific values for known keys (e.g. name, version, dependency versions, etc.) to cover common use cases, as well as the aforementioned package.json dynamic badge for grabbing top level keys. That dynamic badge doesn't support json-path style queries for digging into the json, and I personally don't think it makes sense to do so given the above.

If you really want to dig lower into the package.json contents beyond what we already support, I'd suggest using our standard dynamic json badge that allows working with fully arbitrary json content but requires you to provide the url to the json.

https://img.shields.io/badge/dynamic/json?color=blue&label=foo&query=%24.bugs.email&url=https%3A%2F%2Fraw.githubusercontent.com%2Fbadges%2Fshields%2Fmaster%2Fpackage.json

[therealsujitk]

Thanks! This works for me.