XAMPPRocky/tokei_rs

Feature request: customize badge label

Open

#3 opened on Jan 2, 2018

View on GitHub
 (7 comments) (1 reaction) (0 assignees)Rust (11 forks)auto 404
enhancementhelp wanted

Repository metrics

Stars
 (67 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

(moved from https://github.com/Aaronepower/tokei/issues/139)

In tldr-pages/tldr we're using the file count badge as a proxy to the number of pages in the collection. Ideally we'd want to only count files in the pages directory (requested at #2), but even with the current count, which is already a good approximation, we'd want to change the label from "Files" to "pages". A feature to provide a custom label for the badge would enable us to do that.

On a related (but independent) note, I think the label should be lowercased to match the majority of default badge labels (see e.g. https://shields.io)

Contributor guide

Research direction
Investigate the badge generation logic in the tokei rs server and add an optional parameter to allow customizing the badge label text.
Tech stack
rust
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
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
GitRust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60