badges / badges/shields

"GitHub repo file count" counts not all files

Open
#8,784 1 comment 0 reactions 0 assignees View on GitHub
question service-badge
Dominant language
JavaScript
Stars
27.2k
Forks
5.6k
Avg merge
1d 8h
Merged PRs (30d)
46

Description

### Are you experiencing an issue with...

shields.io

### 🐞 Description

Repo [cn007b/stash](https://github.com/cn007b/stash) has many directories and each directory holds many files,
but `GitHub repo file count` from https://shields.io/category/size returns only 4, here: ![GitHub cn007b/stash repo file count](https://img.shields.io/github/directory-file-count/cn007b/stash)
which is definitely incorrect, for example only [this directory](https://github.com/cn007b/stash/tree/master/ed/p) has 14 files.

### 🔗 Link to the badge

https://img.shields.io/github/directory-file-count/cn007b/stash

### 💡 Possible Solution

Probably `GitHub repo file count` should iterate over all files over all directories recursively,
it might be expensive in terms of processing time,
probably some sort of caching must be introduced,
but it would be nice to have this insights, IMHO.

Contributor guide

Open the contributing guide

Research direction

Start from the GitHub repo file count badge at https://img.shields.io/github/directory-file-count/cn007b/stash and trace its implementation and GitHub repository data lookup. Compare the result with the linked cn007b/stash directory, including ed/p, and determine how recursive counting and any required caching should be handled; done means the badge reports files across nested directories accurately.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, javascript
Domain
api, backend
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.