github-lang-stats 1.6.0 → 1.6.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -32,6 +32,11 @@ Perfect for portfolios, resumes, and demonstrating your real technical expertise
|
|
|
32
32
|
|
|
33
33
|
Progress is cached in `.github-lang-stats-cache/<user>.json` so **interrupted runs resume from where they left off**.
|
|
34
34
|
|
|
35
|
+
> **⚠️ Former employer / removed from org?**
|
|
36
|
+
> Phase 3 requires **current read access** to each repository. If you've since been removed from a private org or repo, those `GET /commits/:sha` calls will return `404` and no language stats will be collected for that work.
|
|
37
|
+
>
|
|
38
|
+
> **Workaround:** Run the tool while you still have access and keep the cache file. On future runs the tool will use cached data, so your stats remain intact even after access is revoked.
|
|
39
|
+
|
|
35
40
|
**Note**: PR counts are collected by default starting with Phase 4. Use `--exclude-pr-counts` to skip this phase if you don't need PR data. The Search API has a stricter rate limit (30 requests/minute), so PR collection includes automatic 2-second delays between requests.
|
|
36
41
|
|
|
37
42
|
## Metric: `lines_changed`
|
|
@@ -240,6 +245,12 @@ When `--exclude-pr-counts` is used, the metadata includes `"excludedPRs": true`.
|
|
|
240
245
|
- **Exclude infrastructure languages** with `--exclude-langs HCL,Dockerfile` if teammates committed those to repos you also touched.
|
|
241
246
|
- **Adjust concurrency** carefully — GitHub's [secondary rate limits](https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api) may trigger at high concurrency even if your primary limit is not exhausted. `5` is a safe default.
|
|
242
247
|
|
|
248
|
+
## Screenshot
|
|
249
|
+
|
|
250
|
+
Example of how the output data can be visualized — this chart is from the IndieCV app by smallstack, built on top of the JSON data this tool produces:
|
|
251
|
+
|
|
252
|
+
[](https://ltmdiiguvlmrsihp.public.blob.vercel-storage.com/screenshots/github-lang-stats-wide.png)
|
|
253
|
+
|
|
243
254
|
---
|
|
244
255
|
|
|
245
256
|
Made by [smallstack GmbH](https://smallstack.com) · [GitHub](https://github.com/smallstack/github-lang-stats) · [npm](https://www.npmjs.com/package/github-lang-stats)
|