docs-please 0.2.1-beta.0 → 0.2.2-beta.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docs-please",
   "type": "module",
-  "version": "0.2.1-beta.0",
+  "version": "0.2.2-beta.0",
   "description": "Nuxt layer for documentation sites using shadcn-vue",
   "license": "MIT",
   "repository": {
@@ -18,7 +18,8 @@
     "modules",
     "nuxt.config.ts",
     "nuxt.schema.ts",
-    "server"
+    "server",
+    "utils"
   ],
   "scripts": {
     "dev": "nuxt dev",

package/utils/git.ts

@@ -0,0 +1,59 @@
+import { execSync } from 'node:child_process'
+import process from 'node:process'
+
+export interface GitInfo {
+  name: string
+  owner: string
+  url: string
+}
+
+export function getGitBranch(): string {
+  const envName
+    = process.env.CF_PAGES_BRANCH
+      || process.env.CI_COMMIT_BRANCH
+      || process.env.VERCEL_GIT_COMMIT_REF
+      || process.env.BRANCH
+      || process.env.GITHUB_REF_NAME
+
+  if (envName && envName !== 'HEAD') {
+    return envName
+  }
+  try {
+    const branch = execSync('git rev-parse --abbrev-ref HEAD', { stdio: ['ignore', 'pipe', 'ignore'] }).toString().trim()
+    if (branch && branch !== 'HEAD') {
+      return branch
+    }
+  }
+  catch {
+    // Ignore error
+  }
+
+  return 'main'
+}
+
+export function getGitEnv(): GitInfo {
+  const envInfo = {
+    provider: process.env.VERCEL_GIT_PROVIDER
+      || (process.env.GITHUB_SERVER_URL ? 'github' : undefined)
+      || '',
+    owner: process.env.VERCEL_GIT_REPO_OWNER
+      || process.env.GITHUB_REPOSITORY_OWNER
+      || process.env.CI_PROJECT_PATH?.split('/').shift()
+      || '',
+    name: process.env.VERCEL_GIT_REPO_SLUG
+      || process.env.GITHUB_REPOSITORY?.split('/').pop()
+      || process.env.CI_PROJECT_PATH?.split('/').splice(1).join('/')
+      || '',
+    url: process.env.REPOSITORY_URL || '',
+  }
+
+  if (!envInfo.url && envInfo.provider && envInfo.owner && envInfo.name) {
+    envInfo.url = `https://${envInfo.provider}.com/${envInfo.owner}/${envInfo.name}`
+  }
+
+  return {
+    name: envInfo.name,
+    owner: envInfo.owner,
+    url: envInfo.url,
+  }
+}

package/utils/meta.ts

@@ -0,0 +1,29 @@
+import { readFile } from 'node:fs/promises'
+import { resolve } from 'node:path'
+import process from 'node:process'
+
+export function inferSiteURL(): string | undefined {
+  return (
+    process.env.NUXT_SITE_URL
+    || (process.env.NEXT_PUBLIC_VERCEL_URL && `https://${process.env.NEXT_PUBLIC_VERCEL_URL}`)
+    || process.env.URL // Netlify
+    || process.env.CI_PAGES_URL // Gitlab Pages
+    || process.env.CF_PAGES_URL // Cloudflare Pages
+  )
+}
+
+export async function getPackageJsonMetadata(dir: string): Promise<{ name: string, description?: string }> {
+  try {
+    const packageJson = await readFile(resolve(dir, 'package.json'), 'utf-8')
+    const parsed = JSON.parse(packageJson)
+    return {
+      name: parsed.name,
+      description: parsed.description,
+    }
+  }
+  catch {
+    return {
+      name: 'docs',
+    }
+  }
+}