@ptkdev/all-shields-cli
v2.0.2
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 al
59/weekUpdated 3 years agoMITUnpacked: 71.7 KB
Published by Patryk Rzucidło [@ptkdev]
npm install @ptkdev/all-shields-cli
🦌 all-shields-cli - badges generator
     
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
- 👔 Screenshot
- 🚀 How to use
- - 🔧 installation
- - ⚙️ CLI
- 📚 Documentation
- - 🔑 Liquid Variables
- - 🐶 With Husky
- - 🧰 Options
- 🔨 Developer Mode
- - 🏁 Run Project
- 👨💻 Contributing
- 🐛 Known Bugs
- 🍻 Community:
- 
Telegram (🇬🇧 English | 🇮🇹 Italian)
- 
Discord (🇬🇧 English | 🇮🇹 Italian | 🇵🇱 Polish)
- 
Twitter
💡 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
🚀 How to use
#### 🔧 Installation
1. In your node project run: npm install @ptkdev/all-shields-cli --save-dev
2. In your package.json add script:
``json`
...
"scripts": {
"all-shields-generate": "all-shields-cli"
}
...
3. Create .all-shieldsrc and paste sample:
`json`
{
"files": ["README.md"],
"shields": [
{
"id": "my-badges",
"badges": [
{
"url": "https://www.npmjs.com/package/@ptkdev/all-shields-cli",
"color": "#D3D3D3",
"label": "package name",
"title": "package name",
"message": "{{name}}",
"style": "flat",
"logo": "",
"platform": "shields"
}
]
}
]
}
4. Add in your README.md the html comment (my-badges is id from the previous step):
`html`
5. Run npm run all-shields-generate
See folder examples, run with npm run example. Below is available a description of options values.
##### ⚙️ CLI
1. Install cli package globally: npm install @ptkdev/all-shields-cli -g
2. Run anywhere:
You can use npx, example: npx @ptkdev/all-shields-cli
🔑 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)npx husky install
2. Setup husky with:
3. Add hook:
🧰 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 |string
| custom | Set custom string of image url (appended after domain url of badge service) | | empty | discord, shields, fury, snyk, badgen, github | v1.1.0 |URI
| url | If you click on badge open this url | | empty | discord, shields, fury, snyk, badgen, github | v1.0.0 |custom
| color | Badge hexcode color (right side). NOTE: Overwrited if is set. | string / hexcode | lightgray | shields, badgen | v1.0.0 |custom
| label | Badge text (left side). NOTE: Overwrited if is set. | string | empty | shields, badgen | v1.0.0 |string
| title | Mouse hover alt text | | empty | discord, shields, fury, snyk, badgen, github | v1.0.0 |custom
| message | Badge text (right side). NOTE: Overwrited if is set. | string | empty | discord, shields, fury, snyk, badgen, github | v1.0.0 |custom
| style | Look of badge. NOTE: Overwrited if is set. | plastic / flat / flat-square / for-the-badge / social | flat | shields | v1.0.0 |custom
| logo | Show logo (left side). NOTE: Overwrited if is set. | shields: bitcoin , dependabot , discord , gitlab , npm , paypal , serverfault , stackexchange , superuser , telegram , travis and more on docs. airbnb
badgen: , 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 |DISCORD_SERVER_ID
| server_id | if platform is discord, set your discord server_id | | empty | discord | v1.0.0 |
🔨 Developer Mode
#### 🏁 Run Project
1. Clone this repository or download nightly, beta or stable.
2. Run npm run init
3. Run (unix require sudo)all-shields-cli
4. Run anywhere for execute command line tool
or run npm run dev for watch mode.
📚 Documentation
Run npm run docs
👑 Backers and Sponsors
Thanks to all our backers! 🙏 Donate 3$ or more on paypal, ko-fi, github or patreon and send me email with your avatar and url.
                                              
👨💻 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 💻 🌍 📖 🐛 |  di4urp 💻 🐛 |
> 💰 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>