badges/shields

Badge request: SDK constraint and dependency version for Dart packages

Open

#3,471 opened on May 20, 2019

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

Description

The support for Dart packages is currently pretty basic: we can only get a bagde for the latest version of a package (i.e. https://img.shields.io/pub/v/<package_name>.svg).

It exists a specification for the API endpoints exposed by Pub package manager: https://github.com/dart-lang/pub/blob/master/doc/repository-spec-v2.md

The API let us access two missing things from shields.io:

  • the SDK constraint: we can get the Node.js constraint from a npm package, the PHP constraint from a Packagist package, but it's currently impossible with a Dart package.
  • the version of a dependency: same here. The badges are available for npm and Packagist packages but not for Pub packages.

It would be very cool if more kind of badges could be generated for Dart projets.

Contributor guide

Tech stack
javascript
Domain
apideveloper experience
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic knowledge of Shields badge creationUnderstanding of the Pub API (see link in issue)
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Examine how Shields currently implements npm and Packagist badges for SDK constraints and dependency versions, likely in the services directory. Then use the Pub API specification (https://github.com/dart lang/pub/blob/master/doc/repository spec v2.md) to implement similar badges for Dart packages. Review existing comments in the issue for any previous attempts or guidance.