Merge remote-tracking branch 'repoconf-rust-public-lib-template/main'

Author: DenisGorbachev

README.md

@@ -4,6 +4,7 @@
 
 # stub!() - a better todo!()
 
+[![Build](https://github.com/DenisGorbachev/stub-macro/actions/workflows/ci.yml/badge.svg)](https://github.com/DenisGorbachev/stub-macro)
 [![Documentation](https://docs.rs/stub-macro/badge.svg)](https://docs.rs/stub-macro)
 
 <!-- crate documentation start -->

README.ts

@@ -1,4 +1,4 @@
-#!/usr/bin/env -S deno run --allow-write --allow-read --allow-run=bash,git,cargo --allow-net=docs.rs:443 --allow-env --allow-sys --no-lock
+#!/usr/bin/env -S deno run --allow-write --allow-read --allow-run=bash,git,cargo --allow-net=docs.rs:443,github.com:443 --allow-env --allow-sys --no-lock
 
 // NOTE: Pin the versions of the packages because the script runs without a lock file
 import * as zx from "npm:zx@8.3.2"
@@ -51,13 +51,6 @@ const CargoMetadataSchema = z.object({
 
 type CargoMetadata = z.infer<typeof CargoMetadataSchema>
 
-const GitHubRepoSchema = z.object({
-  url: z.string().url(),
-  visibility: z.enum(["PUBLIC", "PRIVATE"]),
-})
-
-type GitHubRepo = z.infer<typeof GitHubRepoSchema>
-
 const BadgeSchema = z.object({
   name: z.string().min(1),
   image: z.string().url(),
@@ -92,6 +85,7 @@ const stub = <T>(message = "Implement me"): T => {
  * Examples:
  *
  * `normalizeGitRemoteUrl("git@github.com:DenisGorbachev/rust-private-template.git") == "https://github.com/DenisGorbachev/rust-private-template"`
+ * `normalizeGitRemoteUrl("https://github.com/DenisGorbachev/rust-private-template.git") == "https://github.com/DenisGorbachev/rust-private-template"`
  *
  * @param url
  */
@@ -103,7 +97,14 @@ const normalizeGitRemoteUrl = (url: string) => {
     return `https://github.com/${username}/${repo}`
   }
 
-  // Return original if not a GitHub SSH URL
+  // Handle GitHub HTTPS format: https://github.com/username/repo(.git)
+  const httpsMatch = url.match(/^https:\/\/github\.com\/([^/]+)\/([^/]+?)(?:\.git)?\/?$/)
+  if (httpsMatch) {
+    const [, username, repo] = httpsMatch
+    return `https://github.com/${username}/${repo}`
+  }
+
+  // Return original if not a GitHub URL we recognize
   return url
 }
 
@@ -164,7 +165,13 @@ const crateDocsPlaceholder = `
 `.trim()
 const docsUrlPromise = fetch(docsUrl, {method: "HEAD"})
 const helpPromise = primaryBinTarget ? $`cargo run --quiet --bin ${primaryBinTarget.name} -- --help` : undefined
-const ghRepoViewPromise = $`gh repo view --json url,visibility ${theOriginUrl}`.nothrow().quiet()
+const isPublicGitHubRepoPromise = (async () => {
+  if (!theOriginUrl.startsWith("https://github.com")) return false
+  const response = await fetch(theOriginUrl, {method: "GET"})
+  if (response.status === 200) return true
+  if (response.status === 404) return false
+  throw new Error(`Unexpected response status while checking GitHub repo visibility: ${response.status} ${response.statusText}`)
+})()
 
 const docsUrlHead = await docsUrlPromise
 const docsUrlIs200 = docsUrlHead.status === 200
@@ -174,25 +181,11 @@ const insertCrateDocsIntoReadme = async (readmePath: string) => {
   await $`cargo insert-docs crate-into-readme --allow-dirty --link-to-latest --shrink-headings 0 --readme-path ${readmePath}`
 }
 
-const theGitHubRepo = await (async () => {
-  const output = await ghRepoViewPromise
-  if (output.exitCode === 0) {
-    return parse(GitHubRepoSchema, output)
-  } else {
-    const text = output.text()
-    if (text.includes('argument error: expected the "[HOST/]OWNER/REPO" format')) {
-      return null
-    } else {
-      throw new Error("Failure in ghRepoViewPromise: \n" + text)
-    }
-  }
-})()
-const isGitHubRepo = theGitHubRepo !== null
-const isPublicGitHubRepo = isGitHubRepo && theGitHubRepo.visibility === "PUBLIC"
+const isPublicGitHubRepo = await isPublicGitHubRepoPromise
 
 const badges: Badge[] = []
 if (isPublicGitHubRepo) {
-  badge("Build", `${theCargoToml.package.repository}/actions/workflows/ci.yml/badge.svg`, theCargoToml.package.repository)
+  badges.push(badge("Build", `${theCargoToml.package.repository}/actions/workflows/ci.yml/badge.svg`, theCargoToml.package.repository))
 }
 if (docsUrlIs200) {
   badges.push(badge("Documentation", `https://docs.rs/${name}/badge.svg`, docsUrl))