Have ideas to improve npm?Join in the discussion! »

    @ptkdev/all-shields-cli

    1.3.0 • Public • Published

    Badges generator from dotfiles for any markdown: Tool to help automate your badges of shields.io, badgen.net, fury.io and snyk.io from .all-shieldsrc for your markdown files.  Inspired by all-contributors-cli

    🦌 Badges generator from dotfiles for any markdown

    Tool to help automate your badges of shields.io, badgen.net, fury.io, github action and snyk.io from .all-shieldsrc dotfile for your markdown files. You can use Liquid variables like {{name}} or {{version}} which refer to your package.json. Inspired by all-contributors-cli

    🎁 Support: Donate

    This project is free, open source and I try to provide excellent free support. Why donate? I work on this project several hours in my spare time and try to keep it up to date and working. THANK YOU!

    📎 Menu

    💡 Features

    • [✔️] Easy to use
    • [✔️] MIT License
    • [✔️] Support: shields.io
    • [✔️] Support: fury.io
    • [✔️] Support: snyk.io
    • [✔️] Support: badgen.net
    • [✔️] Support: github action
    • [✔️] Full customizations!
    • [✔️] Liquid Variables
    • [✔️] Tool to help automate your badges on markdown.
    • [✔️] Badges generator from dotfiles for any markdown

    👔 Screenshot

    Badges generator from dotfiles for any markdown

    🚀 Installation

    1. In your node project run: npm install @ptkdev/all-shields-cli --save-dev
    2. In your package.json add script:
    	...
    	"scripts": {
    		"all-shields-cli": "all-shields-generate"
    	}
    	...
    1. Create .all-shieldsrc and paste sample:
    {
    	"files": [
    		"README.md"
    	],
    	"shields": [
    		{
    			"id": "my-badges",
    			"badges": [
    				{
    					"url": "https://www.npmjs.com/package/@ptkdev/all-shields-cli",
    					"color": "lightgray",
    					"label": "package name",
    					"title": "package name",
    					"message": "{{name}}",
    					"style": "flat",
    					"logo": "",
    					"platform": "shields"
    				}
    			]
    		}
    	]
    }
    1. Add in your README.md the html comment (my-badges is id from the previous step):
    <!-- all-shields/my-badges:START -->
    <!-- all-shields/my-badges:END -->
    1. Run npm run all-shields-cli

    See folder examples, run with node example.js. Below is available a description of options values.

    🔑 Liquid variables

    In your .all-shieldsrc dotfile you can use liquid variables like {{name}} or {{version}} which refer to your package.json. Key of package.json is name of liquid variable {{key_from_package.json}}

    🐶 Work with Husky

    1. In your node project run: npm install husky --save-dev (docs)
    2. You can use pre-commit hooks with husky:
    	...
    	"husky": {
    		"hooks": {
    			"pre-commit": "npm run all-shields-cli"
    		}
    	}
    	...

    🧰 Options: Badges Array

    Parameter Description Values Default value Available on platforms Available since
    platform Define platform discord / shields / fury / snyk / badgen / github shields v1.0.0
    custom Set custom string of image url (appended after domain url of badge service) string empty discord, shields, fury, snyk, badgen, github v1.1.0
    url If you click on badge open this url URI empty discord, shields, fury, snyk, badgen, github v1.0.0
    color Badge hexcode color (right side). NOTE: Overwrited if custom is set. string / hexcode lightgray shields, badgen v1.0.0
    label Badge text (left side). NOTE: Overwrited if custom is set. string empty shields, badgen v1.0.0
    title Mouse hover alt text string empty discord, shields, fury, snyk, badgen, github v1.0.0
    message Badge text (right side). NOTE: Overwrited if custom is set. string empty discord, shields, fury, snyk, badgen, github v1.0.0
    style Look of badge. NOTE: Overwrited if custom is set. plastic / flat / flat-square / for-the-badge / social flat shields v1.0.0
    logo Show logo (left side). NOTE: Overwrited if custom is set. shields: bitcoin , dependabot , discord , gitlab , npm , paypal , serverfault , stackexchange , superuser , telegram , travis and more on docs.

    badgen: airbnb, apple, appveyor, atom, awesome, azure, azurepipelines, bitcoin, buymeacoffee, chrome, circleci, cocoapods, codacy, codebeat, codeclimate, codecov, codeship, commonwl, deepscan, dependabot, discord, dockbit, docker, eclipse, firefox, flow, git, github, gitlab, gitter, googleplay, graphql, haskell, jsdelivr and more on docs
    empty shields, badgen v1.0.0
    server_id if platform is discord, set your discord server_id DISCORD_SERVER_ID empty discord v1.0.0

    🔨 Developer Mode

    1. Download stable, beta or nightly and extract it.
    2. Run npm install
    3. Run sudo npm link
    4. You can use all-shields-generate everywhere.

    📚 Documentation

    Run npm run docs

    👨‍💻 Contributing

    I ❤️ contributions! I will happily accept your pull request! Translations, grammatical corrections (GrammarNazi you are welcome! Yes my English is bad, sorry), etc... Do not be afraid, if the code is not perfect we will work together 👯 and remember to insert your name in .all-contributorsrc and package.json file.

    Thanks goes to these wonderful people (emoji key):


    Patryk Rzucidło

    💻 🌍 📖 🐛

    💰 In the future, if the donations allow it, I would like to share some of the success with those who helped me the most. For me open source is share of code, share development knowledges and share donations!

    🦄 Other Projects

    💫 License

    • Code and Contributions have MIT License
    • Images and logos have CC BY-NC 4.0 License (Freepik Premium License)
    • Documentations and Translations have CC BY 4.0 License
    Copyleft (c) 2021 Patryk Rzucidło (@PTKDev) <support@ptkdev.io>

    Install

    npm i @ptkdev/all-shields-cli

    DownloadsWeekly Downloads

    68

    Version

    1.3.0

    License

    MIT

    Unpacked Size

    32.5 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar