badges/shields

macports version

Open

#9588 opened on Sep 19, 2023

View on GitHub
 (11 comments) (1 reaction) (0 assignees)JavaScript (22,337 stars) (5,423 forks)batch import
good first issueservice-badge

Description

📋 Description

I'd like to see a Version category badge for macports using its search interface at https://ports.macports.org.

🔗 Data

https://ports.macports.org/api/v1/ports/:package_name

It's achievable with a Dynamic JSON badge for now:

https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fports.macports.org%2Fapi%2Fv1%2Fports%2Fproxy-audio-device%2F&query=%24.version&label=macports

proxy-audio-device

🎤 Motivation

Shields has badges for several other package managers, and although I'm a fervent Homebrew user, I'd like to see macports supported, too.

Contributor guide

Tech stack
javascriptnodejsrest api
Domain
full stack
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic JavaScriptfamiliarity with badges/shields codebaseunderstanding of REST APIs
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue requests adding a MacPorts version badge. Look at existing package manager badge implementations in the shields repository, such as the Homebrew badge found in `services/homebrew/`. Study how the API endpoint is called and how the badge data is extracted. For MacPorts, use the provided API: `https://ports.macports.org/api/v1/ports/:package name`. Implement a new service class similar to existing ones, and add corresponding tests. Check the `services/` directory for patterns and the test suite for examples. The issue has comments suggesting a dynamic JSON badge workaround; the task is to make it a native service.