setup-git-repo 1.0.22 → 1.0.24

package/README.md

@@ -9,6 +9,15 @@
     <a href="https://www.npmjs.com/package/setup-git-repo"><img src="https://img.shields.io/npm/types/setup-git-repo" alt="TypeScript types" /></a>
     <a href="https://packagephobia.com/result?p=setup-git-repo"><img src="https://packagephobia.com/badge?p=setup-git-repo" alt="Install size" /></a>
     <a href="https://app.codecov.io/gh/OpenSourceAGI/dev-tools-starter-agent/flags"><img src="https://img.shields.io/codecov/c/github/OpenSourceAGI/dev-tools-starter-agent?flag=setup-git-repo&label=setup-git-repo%20coverage&logo=codecov&logoColor=white" alt="Coverage" /></a>
+    <br />
+    <a href="https://github.com/OpenSourceAGI/dev-tools-starter-agent/stargazers"><img src="https://img.shields.io/github/stars/OpenSourceAGI/dev-tools-starter-agent" alt="GitHub Stars" /></a>
+    <a href="https://github.com/OpenSourceAGI/dev-tools-starter-agent/issues"><img src="https://img.shields.io/github/issues/OpenSourceAGI/dev-tools-starter-agent?logo=github" alt="GitHub Issues" /></a>
+    <a href="https://github.com/OpenSourceAGI/dev-tools-starter-agent/pulls"><img src="https://img.shields.io/github/issues-pr/OpenSourceAGI/dev-tools-starter-agent?logo=github&label=PRs" alt="Open Pull Requests" /></a>
+    <a href="https://github.com/OpenSourceAGI/dev-tools-starter-agent/pulls?q=is%3Apr+is%3Aclosed"><img src="https://img.shields.io/github/issues-pr-closed/OpenSourceAGI/dev-tools-starter-agent?logo=github&label=PRs%20merged&color=8957e5" alt="Merged Pull Requests" /></a>
+    <a href="https://github.com/OpenSourceAGI/dev-tools-starter-agent/discussions"><img src="https://img.shields.io/github/discussions/OpenSourceAGI/dev-tools-starter-agent" alt="GitHub Discussions" /></a>
+    <a href="https://github.com/OpenSourceAGI/dev-tools-starter-agent/commits/master/"><img src="https://img.shields.io/github/last-commit/OpenSourceAGI/dev-tools-starter-agent.svg" alt="GitHub last commit" /></a>
+    <br />
+    <img src="https://img.shields.io/badge/Bun-14151A?logo=bun&logoColor=white" alt="Bun" /> <img src="https://img.shields.io/badge/Vitest-6E9F18?logo=vitest&logoColor=white" alt="Vitest" />
 </p>
 <!-- template-git-repo:badges:end -->
 
@@ -69,7 +78,7 @@ rather than shipped pointing at a placeholder:
 | --- | --- |
 | `--package <name>` | npm version + monthly downloads |
 | `--doi <10.5281/zenodo.N>` | Zenodo DOI |
-| `--docs <url>` / `--api <url>` / `--youtube <url>` | link badges |
+| `--website <url>` / `--docs <url>` / `--api <url>` / `--youtube <url>` | link badges |
 | `--uptime <page-id>` | UptimeRobot status page |
 | `--discord-id <id>` + `--discord-invite <url>` | Discord (both required) |
 

package/bin/setup-git-repo.js

@@ -41,6 +41,7 @@ const FLAGS = {
   description: "DESCRIPTION",
   package: "PACKAGE",
   doi: "DOI",
+  website: "WEBSITE_URL",
   docs: "DOCS_URL",
   api: "API_URL",
   youtube: "YOUTUBE_URL",
@@ -119,6 +120,7 @@ ${bold("Optional badges")} ${dim("(a badge whose value is omitted is left out of
 
   --package <name>          npm package, for the version + downloads badges
   --doi <10.5281/zenodo.N>  Zenodo DOI
+  --website <url>           Live app link
   --docs <url>              Documentation link
   --api <url>               API reference link
   --youtube <url>           Demo video link
@@ -196,6 +198,7 @@ async function main() {
       console.log(`\n${bold("  Optional badges")} ${dim("— press Enter to leave one out")}`);
       values.PACKAGE = await prompt(rl, "npm package name", values.PACKAGE);
       values.DOI = await prompt(rl, "Zenodo DOI", values.DOI);
+      values.WEBSITE_URL = await prompt(rl, "Live app URL", values.WEBSITE_URL);
       values.DOCS_URL = await prompt(rl, "Docs URL", values.DOCS_URL);
       values.API_URL = await prompt(rl, "API URL", values.API_URL);
       values.YOUTUBE_URL = await prompt(rl, "YouTube URL", values.YOUTUBE_URL);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "setup-git-repo",
-  "version": "1.0.22",
+  "version": "1.0.24",
   "description": "One command to set up a GitHub repo: Turborepo, CI workflows, README badges, and the docs for each",
   "type": "module",
   "bin": {

package/src/template.mjs

@@ -11,6 +11,7 @@ import { join, relative, sep } from "node:path";
  */
 export const OPTIONAL_BADGES = {
   doi: ["DOI"],
+  website: ["WEBSITE_URL"],
   docs: ["DOCS_URL"],
   api: ["API_URL"],
   youtube: ["YOUTUBE_URL"],

package/template/README.md

@@ -1,28 +1,44 @@
 <p align="center">
 <!-- badge:doi --><a href="https://doi.org/{{DOI}}"><img src="https://zenodo.org/badge/DOI/{{DOI}}.svg" alt="DOI" /></a>
     <a href="https://deepwiki.com/{{OWNER}}/{{REPO}}"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki" /></a>
+<!-- badge:website --><a href="{{WEBSITE_URL}}"><img height="20px" src="https://img.shields.io/badge/App-blueviolet?style=for-the-badge&logo=googlechrome&logoColor=white" alt="Website" /></a>
 <!-- badge:docs --><a href="{{DOCS_URL}}"><img src="https://img.shields.io/badge/Docs-blue?logo=ReadTheDocs&logoColor=white" alt="Documentation" /></a>
 <!-- badge:api --><a href="{{API_URL}}"><img src="https://img.shields.io/badge/API-blue?logo=fastapi&logoColor=white" alt="API" /></a>
 <!-- badge:youtube --><a href="{{YOUTUBE_URL}}"><img height="20px" src="https://img.shields.io/badge/YouTube-red?style=for-the-badge&logo=youtube&logoColor=white" alt="YouTube" /></a>
     <a href="https://deploy.workers.cloudflare.com/?url=https://github.com/{{OWNER}}/{{REPO}}"><img height="24px" src="https://deploy.workers.cloudflare.com/button" alt="Deploy to Cloudflare Workers" /></a>
-    <a href="https://github.com/{{OWNER}}/{{REPO}}/stargazers"><img src="https://img.shields.io/github/stars/{{OWNER}}/{{REPO}}" alt="GitHub Stars" /></a>
+    <a href="https://codespaces.new/{{OWNER}}/{{REPO}}"><img height="20px" src="https://github.com/codespaces/badge.svg" alt="Open in GitHub Codespaces" /></a>
 <br />
+<!-- badge:npm --><a href="https://www.npmjs.com/package/{{PACKAGE}}"><img src="https://img.shields.io/npm/v/{{PACKAGE}}.svg" alt="npm version" /></a>
 <!-- badge:npm --><a href="https://www.npmjs.com/package/{{PACKAGE}}"><img src="https://img.shields.io/npm/dm/{{PACKAGE}}.svg" alt="NPM Monthly Downloads" /></a>
+<!-- badge:npm --><a href="https://www.npmjs.com/package/{{PACKAGE}}"><img src="https://img.shields.io/npm/dt/{{PACKAGE}}.svg" alt="NPM Total Downloads" /></a>
     <a href="https://codecov.io/gh/{{OWNER}}/{{REPO}}"><img src="https://codecov.io/gh/{{OWNER}}/{{REPO}}/graph/badge.svg" alt="Coverage" /></a>
-    <a href="https://github.com/{{OWNER}}/{{REPO}}/graphs/contributors"><img src="https://img.shields.io/github/commit-activity/m/{{OWNER}}/{{REPO}}" alt="Commit Activity" /></a>
-    <a href="https://github.com/{{OWNER}}/{{REPO}}/commits/{{DEFAULT_BRANCH}}/"><img src="https://img.shields.io/github/last-commit/{{OWNER}}/{{REPO}}.svg" alt="Last Commit" /></a>
     <a href="https://github.com/{{OWNER}}/{{REPO}}/actions/workflows/tests.yml"><img src="https://github.com/{{OWNER}}/{{REPO}}/actions/workflows/tests.yml/badge.svg?branch={{DEFAULT_BRANCH}}" alt="Tests" /></a>
-<br />
 <!-- badge:uptime --><a href="https://stats.uptimerobot.com/{{UPTIME_ID}}"><img src="https://img.shields.io/badge/Uptime-Status-brightgreen?logo=uptimerobot&logoColor=white" alt="Uptime Status" /></a>
-<!-- badge:npm --><a href="https://www.npmjs.com/package/{{PACKAGE}}"><img src="https://img.shields.io/npm/v/{{PACKAGE}}.svg" alt="npm version" /></a>
+<br />
+    <a href="https://github.com/{{OWNER}}/{{REPO}}/stargazers"><img src="https://img.shields.io/github/stars/{{OWNER}}/{{REPO}}" alt="GitHub Stars" /></a>
+    <a href="https://github.com/{{OWNER}}/{{REPO}}/forks"><img src="https://img.shields.io/github/forks/{{OWNER}}/{{REPO}}" alt="GitHub Forks" /></a>
+    <a href="https://github.com/{{OWNER}}/{{REPO}}/graphs/contributors"><img src="https://img.shields.io/github/contributors/{{OWNER}}/{{REPO}}" alt="Contributors" /></a>
+    <a href="https://github.com/{{OWNER}}/{{REPO}}/issues"><img src="https://img.shields.io/github/issues/{{OWNER}}/{{REPO}}?logo=github" alt="GitHub Issues" /></a>
+    <a href="https://github.com/{{OWNER}}/{{REPO}}/pulls"><img src="https://img.shields.io/github/issues-pr/{{OWNER}}/{{REPO}}?logo=github&label=PRs" alt="Open Pull Requests" /></a>
+    <a href="https://github.com/{{OWNER}}/{{REPO}}/pulls?q=is%3Apr+is%3Aclosed"><img src="https://img.shields.io/github/issues-pr-closed/{{OWNER}}/{{REPO}}?logo=github&label=PRs%20merged&color=8957e5" alt="Merged Pull Requests" /></a>
+    <a href="https://github.com/{{OWNER}}/{{REPO}}/discussions"><img src="https://img.shields.io/github/discussions/{{OWNER}}/{{REPO}}" alt="GitHub Discussions" /></a>
+    <a href="https://github.com/{{OWNER}}/{{REPO}}/graphs/contributors"><img src="https://img.shields.io/github/commit-activity/m/{{OWNER}}/{{REPO}}" alt="Commit Activity" /></a>
+    <a href="https://github.com/{{OWNER}}/{{REPO}}/commits/{{DEFAULT_BRANCH}}/"><img src="https://img.shields.io/github/last-commit/{{OWNER}}/{{REPO}}.svg" alt="Last Commit" /></a>
 <!-- badge:discord --><a href="{{DISCORD_INVITE}}"><img src="https://img.shields.io/discord/{{DISCORD_ID}}.svg?label=Chat&logo=Discord&colorB=7289da&style=flat" alt="Join Discord" /></a>
     <a href="https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs Welcome" /></a>
     <a href="./LICENSE.md"><img src="https://img.shields.io/github/license/{{OWNER}}/{{REPO}}" alt="License" /></a>
 <br />
     <img src="https://img.shields.io/badge/Claude-D97757?logo=claude&logoColor=fff" alt="Claude AI" />
-    <img src="https://img.shields.io/badge/Cloudflare-F38020?logo=Cloudflare&logoColor=white" alt="Cloudflare" />
+    <img src="https://img.shields.io/badge/Cloudflare%20Workers-F38020?logo=cloudflareworkers&logoColor=white" alt="Cloudflare Workers" />
+    <img src="https://img.shields.io/badge/TypeScript-3178C6?logo=typescript&logoColor=white" alt="TypeScript" />
+    <img src="https://img.shields.io/badge/Next.js-black?logo=nextdotjs&logoColor=white" alt="Next.js" />
+    <img src="https://img.shields.io/badge/React-20232A?logo=react&logoColor=white" alt="React" />
+    <img src="https://img.shields.io/badge/Tailwind%20CSS-06B6D4?logo=tailwindcss&logoColor=white" alt="Tailwind CSS" />
+    <img src="https://img.shields.io/badge/shadcn%2Fui-000000?logo=shadcnui&logoColor=white" alt="shadcn/ui" />
+    <img src="https://img.shields.io/badge/Drizzle%20ORM-C5F74F?logo=drizzle&logoColor=white" alt="Drizzle ORM" />
     <img src="https://img.shields.io/badge/Turborepo-EF4444?logo=turborepo&logoColor=white" alt="Turborepo" />
-    <img src="https://img.shields.io/badge/Bun-000000?logo=bun&logoColor=white" alt="Bun" />
+    <img src="https://img.shields.io/badge/Bun-14151A?logo=bun&logoColor=white" alt="Bun" />
+    <img src="https://img.shields.io/badge/Vitest-6E9F18?logo=vitest&logoColor=white" alt="Vitest" />
 </p>
 
 # {{REPO}}

package/template/docs/BADGES.md

@@ -4,9 +4,9 @@ Every badge in the README falls into one of three groups:
 
 | Group | Setup | Badges |
 | --- | --- | --- |
-| **Zero setup** — works the moment the repo is public | none | Stars, Commit Activity, Last Commit, License, PRs Welcome, Deploy to Cloudflare, DeepWiki, tech-stack chips |
+| **Zero setup** — works the moment the repo is public | none | Stars, Forks, Contributors, Open Issues, Open PRs, Merged PRs, Discussions, Commit Activity, Last Commit, License, PRs Welcome, Deploy to Cloudflare, Codespaces, DeepWiki, tech-stack chips |
 | **Needs a workflow or service connected** | one repo secret or one app install | Tests status, Coverage, npm version, npm downloads |
-| **Needs an account and an id you paste in** | an external account | DOI, Discord, UptimeRobot, YouTube, Docs, API |
+| **Needs an account and an id you paste in** | an external account | DOI, Discord, UptimeRobot, YouTube, Website, Docs, API |
 
 `setup-git-repo` drops the badge lines for group 3 unless you pass the id, so the
 README never ships a badge pointing at `{{DOI}}`. Add them back later by copying
@@ -86,6 +86,69 @@ DeepWiki indexes public repos automatically. The first visit to the link
 triggers indexing if the repo has not been seen; the badge image itself is
 static, so it renders even before indexing finishes.
 
+### Forks and Contributors
+
+```html
+<a href="https://github.com/OWNER/REPO/forks"><img src="https://img.shields.io/github/forks/OWNER/REPO" alt="GitHub Forks" /></a>
+<a href="https://github.com/OWNER/REPO/graphs/contributors"><img src="https://img.shields.io/github/contributors/OWNER/REPO" alt="Contributors" /></a>
+```
+
+`forks` counts direct forks only, not forks of forks, so a repo forked along a
+chain reads lower than it is. `contributors` counts commit authors GitHub could
+match to an account — commits made with an unregistered email belong to nobody
+and are invisible here. Use `contributors-anon` instead if your history has many
+of those.
+
+### Open Issues
+
+```html
+<a href="https://github.com/OWNER/REPO/issues"><img src="https://img.shields.io/github/issues/OWNER/REPO?logo=github" alt="GitHub Issues" /></a>
+```
+
+Needs Issues enabled (Settings → Features). Read it as work in flight, not a
+defect count. Shields asks GitHub Search, which treats pull requests as issues on
+some endpoints — the `/issues/` path used here already excludes them. Add
+`-raw` (`github/issues-raw/...`) for a bare number with no "open" suffix, and
+`-closed` for the closed count.
+
+### Open PRs and Merged PRs
+
+```html
+<a href="https://github.com/OWNER/REPO/pulls"><img src="https://img.shields.io/github/issues-pr/OWNER/REPO?logo=github&label=PRs" alt="Open Pull Requests" /></a>
+<a href="https://github.com/OWNER/REPO/pulls?q=is%3Apr+is%3Aclosed"><img src="https://img.shields.io/github/issues-pr-closed/OWNER/REPO?logo=github&label=PRs%20merged&color=8957e5" alt="Merged Pull Requests" /></a>
+```
+
+Two counts rather than one on purpose. An open count alone reads the same whether
+the queue clears in a day or has been stuck for a year; the pair is what tells a
+reader whether maintenance is actually happening.
+
+Shields has **no "merged" endpoint**. `issues-pr-closed` counts every PR that is
+no longer open, so PRs closed without merging are in the number too. If you close
+a lot of stale PRs, relabel it `label=PRs%20closed` rather than overstating what
+landed. Both take `label=` because unlabelled they render as bare numbers, and
+two adjacent PR badges then look like one number printed twice.
+
+### Discussions
+
+```html
+<a href="https://github.com/OWNER/REPO/discussions"><img src="https://img.shields.io/github/discussions/OWNER/REPO" alt="GitHub Discussions" /></a>
+```
+
+Discussions is **off by default**. Until you turn it on (Settings → Features →
+Discussions) the badge reads `repo not found`, which looks exactly like the
+private-repo failure — turn it on before adding the badge, not after.
+
+### Open in GitHub Codespaces
+
+```html
+<a href="https://codespaces.new/OWNER/REPO"><img height="20px" src="https://github.com/codespaces/badge.svg" alt="Open in GitHub Codespaces" /></a>
+```
+
+Nothing to configure — the link boots the repo in a default container, billed
+against the *visitor's* free hours, so the button costs you nothing. Add a
+`.devcontainer/devcontainer.json` if the default image is missing something your
+install needs: the visitor is the one who sees that failure.
+
 ### Tech-stack chips
 
 Pure decoration — static Shields badges with a brand color and a Simple Icons
@@ -154,6 +217,7 @@ drop to 0%.
 ```html
 <a href="https://www.npmjs.com/package/PACKAGE"><img src="https://img.shields.io/npm/v/PACKAGE.svg" alt="npm version" /></a>
 <a href="https://www.npmjs.com/package/PACKAGE"><img src="https://img.shields.io/npm/dm/PACKAGE.svg" alt="NPM Monthly Downloads" /></a>
+<a href="https://www.npmjs.com/package/PACKAGE"><img src="https://img.shields.io/npm/dt/PACKAGE.svg" alt="NPM Total Downloads" /></a>
 ```
 
 `PACKAGE` is the name in that package's `package.json`, not the repo name. Both
@@ -161,7 +225,10 @@ badges render `invalid` until the package's **first** publish — `npm-publish.y
 does that on the first push to the default branch. Scoped packages work with the
 scope included and URL-encoded slash: `npm/v/%40scope%2Fname`.
 
-`dm` is downloads/month; `dw` weekly, `dt` total. In a monorepo, pick the package
+`dm` is downloads/month; `dw` weekly, `dt` total. Show the monthly and the total
+together rather than either alone: a large all-time total with a flat month means
+something very different from the same total still climbing, and only the monthly
+number says the package is still being installed. In a monorepo, pick the package
 users actually install — or show several, one badge each.
 
 ---
@@ -225,6 +292,17 @@ For a badge that reports the *real* number, use a monitor-specific API key
 That key is read-only for one monitor, which is why it is safe in a README —
 never paste your account-wide API key there.
 
+### Website (live app)
+
+```html
+<a href="https://your.app"><img height="20px" src="https://img.shields.io/badge/App-blueviolet?style=for-the-badge&logo=googlechrome&logoColor=white" alt="Website" /></a>
+```
+
+The deployed thing, not the repo, and first in the row on purpose: a visitor who
+can click straight into a running app decides in seconds whether to read the
+rest. Static — nothing checks the URL is up, which is what the uptime badge is
+for. Pass it with `--website <url>`.
+
 ### Docs / API / YouTube links
 
 ```html
@@ -256,8 +334,9 @@ markdown image syntax cannot center or set a height. Consequences:
 - GitHub's markdown renderer strips `style` attributes. Sizing has to come from
   the `height` attribute or from Shields' own `style=` parameter.
 
-Group by meaning: identity and links on row one, health and freshness on row two,
-community on row three, stack chips last.
+Group by meaning, four rows: identity and links on row one, health and freshness
+on row two, community on row three, stack chips last. Four rows of five reads;
+twenty badges in one run is a wall.
 
 ## Verifying