giget 1.1.1 → 1.1.3

package/README.md

@@ -184,7 +184,7 @@ You can define additional [custom registry](#custom-registry) providers using `r
 import { registryProvider } from "giget";
 
 const themes = registryProvider(
-  "https://raw.githubusercontent.com/unjs/giget/main/templates"
+  "https://raw.githubusercontent.com/unjs/giget/main/templates",
 );
 
 const { source, dir } = await downloadRepo("themes:test", {

package/dist/cli.cjs

@@ -4,7 +4,7 @@
 const node_path = require('node:path');
 const mri = require('mri');
 const colorette = require('colorette');
-const giget = require('./shared/giget.e7e76a83.cjs');
+const index = require('./index.cjs');
 require('node:fs/promises');
 require('node:fs');
 require('tar');
@@ -15,10 +15,13 @@ require('node:child_process');
 require('node:os');
 require('node:util');
 require('node-fetch-native');
-require('https-proxy-agent');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
+
+const mri__default = /*#__PURE__*/_interopDefaultCompat(mri);
 
 async function main() {
-  const arguments_ = mri(process.argv.slice(2), {
+  const arguments_ = mri__default(process.argv.slice(2), {
     boolean: [
       "help",
       "force",
@@ -41,7 +44,7 @@ async function main() {
   if (arguments_.verbose) {
     process.env.DEBUG = process.env.DEBUG || "true";
   }
-  const r = await giget.downloadTemplate(input, {
+  const r = await index.downloadTemplate(input, {
     dir,
     force: arguments_.force,
     forceClean: arguments_["force-clean"],
@@ -57,7 +60,7 @@ async function main() {
 `
   );
   if (arguments_.shell) {
-    giget.startShell(r.dir);
+    index.startShell(r.dir);
   }
   process.exit(0);
 }

package/dist/cli.d.cts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/cli.d.mts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/cli.d.ts

@@ -1,2 +1,2 @@
 
-export { }
+export {  }

package/dist/cli.mjs

@@ -2,7 +2,7 @@
 import { relative } from 'node:path';
 import mri from 'mri';
 import { cyan } from 'colorette';
-import { d as downloadTemplate, s as startShell } from './shared/giget.c3d868f5.mjs';
+import { downloadTemplate, startShell } from './index.mjs';
 import 'node:fs/promises';
 import 'node:fs';
 import 'tar';
@@ -13,7 +13,6 @@ import 'node:child_process';
 import 'node:os';
 import 'node:util';
 import 'node-fetch-native';
-import 'https-proxy-agent';
 
 async function main() {
   const arguments_ = mri(process.argv.slice(2), {

package/dist/index.cjs

@@ -1,20 +1,299 @@
 'use strict';
 
-const giget = require('./shared/giget.e7e76a83.cjs');
-require('node:fs/promises');
-require('node:fs');
-require('tar');
-require('pathe');
-require('defu');
-require('node:stream');
-require('node:child_process');
-require('node:os');
-require('node:util');
-require('node-fetch-native');
-require('https-proxy-agent');
+const promises = require('node:fs/promises');
+const node_fs = require('node:fs');
+const tar = require('tar');
+const pathe = require('pathe');
+const defu = require('defu');
+const node_stream = require('node:stream');
+const node_child_process = require('node:child_process');
+const node_os = require('node:os');
+const node_util = require('node:util');
+const nodeFetchNative = require('node-fetch-native');
 
+async function download(url, filePath, options = {}) {
+  const infoPath = filePath + ".json";
+  const info = JSON.parse(
+    await promises.readFile(infoPath, "utf8").catch(() => "{}")
+  );
+  const headResponse = await sendFetch(url, {
+    method: "HEAD",
+    headers: options.headers
+  }).catch(() => void 0);
+  const etag = headResponse?.headers.get("etag");
+  if (info.etag === etag && node_fs.existsSync(filePath)) {
+    return;
+  }
+  if (typeof etag === "string") {
+    info.etag = etag;
+  }
+  const response = await sendFetch(url, { headers: options.headers });
+  if (response.status >= 400) {
+    throw new Error(
+      `Failed to download ${url}: ${response.status} ${response.statusText}`
+    );
+  }
+  const stream = node_fs.createWriteStream(filePath);
+  await node_util.promisify(node_stream.pipeline)(response.body, stream);
+  await promises.writeFile(infoPath, JSON.stringify(info), "utf8");
+}
+const inputRegex = /^(?<repo>[\w.-]+\/[\w.-]+)(?<subdir>[^#]+)?(?<ref>#[\w./-]+)?/;
+function parseGitURI(input) {
+  const m = input.match(inputRegex)?.groups || {};
+  return {
+    repo: m.repo,
+    subdir: m.subdir || "/",
+    ref: m.ref ? m.ref.slice(1) : "main"
+  };
+}
+function debug(...args) {
+  if (process.env.DEBUG) {
+    console.debug("[giget]", ...args);
+  }
+}
+async function sendFetch(url, options = {}) {
+  if (!options.agent) {
+    const proxyEnv = process.env.HTTPS_PROXY || process.env.https_proxy || process.env.HTTP_PROXY || process.env.http_proxy;
+    if (proxyEnv) {
+      const HttpsProxyAgent = await import('https-proxy-agent').then(
+        (r) => r.HttpsProxyAgent || r.default
+      );
+      options.agent = new HttpsProxyAgent(proxyEnv);
+    }
+  }
+  return await nodeFetchNative.fetch(url, {
+    ...options,
+    headers: normalizeHeaders(options.headers)
+  });
+}
+function cacheDirectory() {
+  return process.env.XDG_CACHE_HOME ? pathe.resolve(process.env.XDG_CACHE_HOME, "giget") : pathe.resolve(node_os.homedir(), ".cache/giget");
+}
+function normalizeHeaders(headers = {}) {
+  const normalized = {};
+  for (const [key, value] of Object.entries(headers)) {
+    if (!value) {
+      continue;
+    }
+    normalized[key.toLowerCase()] = value;
+  }
+  return normalized;
+}
+function currentShell() {
+  if (process.env.SHELL) {
+    return process.env.SHELL;
+  }
+  if (process.platform === "win32") {
+    return "cmd.exe";
+  }
+  return "/bin/bash";
+}
+function startShell(cwd) {
+  cwd = pathe.resolve(cwd);
+  const shell = currentShell();
+  console.info(
+    `(experimental) Opening shell in ${pathe.relative(process.cwd(), cwd)}...`
+  );
+  node_child_process.spawnSync(shell, [], {
+    cwd,
+    shell: true,
+    stdio: "inherit"
+  });
+}
 
+const github = (input, options) => {
+  const parsed = parseGitURI(input);
+  const githubAPIURL = process.env.GIGET_GITHUB_URL || "https://api.github.com";
+  return {
+    name: parsed.repo.replace("/", "-"),
+    version: parsed.ref,
+    subdir: parsed.subdir,
+    headers: {
+      Authorization: options.auth ? `Bearer ${options.auth}` : void 0,
+      Accept: "application/vnd.github+json",
+      "X-GitHub-Api-Version": "2022-11-28"
+    },
+    url: `${githubAPIURL.replace("api.github.com", "github.com")}/${parsed.repo}/tree/${parsed.ref}${parsed.subdir}`,
+    tar: `${githubAPIURL}/repos/${parsed.repo}/tarball/${parsed.ref}`
+  };
+};
+const gitlab = (input, options) => {
+  const parsed = parseGitURI(input);
+  const gitlab2 = process.env.GIGET_GITLAB_URL || "https://gitlab.com";
+  return {
+    name: parsed.repo.replace("/", "-"),
+    version: parsed.ref,
+    subdir: parsed.subdir,
+    headers: {
+      authorization: options.auth ? `Bearer ${options.auth}` : void 0
+    },
+    url: `${gitlab2}/${parsed.repo}/tree/${parsed.ref}${parsed.subdir}`,
+    tar: `${gitlab2}/${parsed.repo}/-/archive/${parsed.ref}.tar.gz`
+  };
+};
+const bitbucket = (input, options) => {
+  const parsed = parseGitURI(input);
+  return {
+    name: parsed.repo.replace("/", "-"),
+    version: parsed.ref,
+    subdir: parsed.subdir,
+    headers: {
+      authorization: options.auth ? `Bearer ${options.auth}` : void 0
+    },
+    url: `https://bitbucket.com/${parsed.repo}/src/${parsed.ref}${parsed.subdir}`,
+    tar: `https://bitbucket.org/${parsed.repo}/get/${parsed.ref}.tar.gz`
+  };
+};
+const sourcehut = (input, options) => {
+  const parsed = parseGitURI(input);
+  return {
+    name: parsed.repo.replace("/", "-"),
+    version: parsed.ref,
+    subdir: parsed.subdir,
+    headers: {
+      authorization: options.auth ? `Bearer ${options.auth}` : void 0
+    },
+    url: `https://git.sr.ht/~${parsed.repo}/tree/${parsed.ref}/item${parsed.subdir}`,
+    tar: `https://git.sr.ht/~${parsed.repo}/archive/${parsed.ref}.tar.gz`
+  };
+};
+const providers = {
+  github,
+  gh: github,
+  gitlab,
+  bitbucket,
+  sourcehut
+};
 
-exports.downloadTemplate = giget.downloadTemplate;
-exports.registryProvider = giget.registryProvider;
-exports.startShell = giget.startShell;
+const DEFAULT_REGISTRY = "https://raw.githubusercontent.com/unjs/giget/main/templates";
+const registryProvider = (registryEndpoint = DEFAULT_REGISTRY, options = {}) => {
+  return async (input) => {
+    const start = Date.now();
+    const registryURL = `${registryEndpoint}/${input}.json`;
+    const result = await sendFetch(registryURL, {
+      headers: {
+        authorization: options.auth ? `Bearer ${options.auth}` : void 0
+      }
+    });
+    if (result.status >= 400) {
+      throw new Error(
+        `Failed to download ${input} template info from ${registryURL}: ${result.status} ${result.statusText}`
+      );
+    }
+    const info = await result.json();
+    if (!info.tar || !info.name) {
+      throw new Error(
+        `Invalid template info from ${registryURL}. name or tar fields are missing!`
+      );
+    }
+    debug(
+      `Fetched ${input} template info from ${registryURL} in ${Date.now() - start}ms`
+    );
+    return info;
+  };
+};
+
+const sourceProtoRe = /^([\w-.]+):/;
+async function downloadTemplate(input, options = {}) {
+  options = defu.defu(
+    {
+      registry: process.env.GIGET_REGISTRY,
+      auth: process.env.GIGET_AUTH
+    },
+    options
+  );
+  const registry = options.registry === false ? void 0 : registryProvider(options.registry, { auth: options.auth });
+  let providerName = options.provider || (registry ? "registry" : "github");
+  let source = input;
+  const sourceProvierMatch = input.match(sourceProtoRe);
+  if (sourceProvierMatch) {
+    providerName = sourceProvierMatch[1];
+    source = input.slice(sourceProvierMatch[0].length);
+  }
+  const provider = options.providers?.[providerName] || providers[providerName] || registry;
+  if (!provider) {
+    throw new Error(`Unsupported provider: ${providerName}`);
+  }
+  const template = await Promise.resolve().then(() => provider(source, { auth: options.auth })).catch((error) => {
+    throw new Error(
+      `Failed to download template from ${providerName}: ${error.message}`
+    );
+  });
+  if (!template) {
+    throw new Error(`Failed to resolve template from ${providerName}`);
+  }
+  template.name = (template.name || "template").replace(/[^\da-z-]/gi, "-");
+  template.defaultDir = (template.defaultDir || template.name).replace(
+    /[^\da-z-]/gi,
+    "-"
+  );
+  const cwd = pathe.resolve(options.cwd || ".");
+  const extractPath = pathe.resolve(cwd, options.dir || template.defaultDir);
+  if (options.forceClean) {
+    await promises.rm(extractPath, { recursive: true, force: true });
+  }
+  if (!options.force && node_fs.existsSync(extractPath) && node_fs.readdirSync(extractPath).length > 0) {
+    throw new Error(`Destination ${extractPath} already exists.`);
+  }
+  await promises.mkdir(extractPath, { recursive: true });
+  const temporaryDirectory = pathe.resolve(
+    cacheDirectory(),
+    providerName,
+    template.name
+  );
+  const tarPath = pathe.resolve(
+    temporaryDirectory,
+    (template.version || template.name) + ".tar.gz"
+  );
+  if (options.preferOffline && node_fs.existsSync(tarPath)) {
+    options.offline = true;
+  }
+  if (!options.offline) {
+    await promises.mkdir(pathe.dirname(tarPath), { recursive: true });
+    const s2 = Date.now();
+    await download(template.tar, tarPath, {
+      headers: {
+        Authorization: options.auth ? `Bearer ${options.auth}` : void 0,
+        ...normalizeHeaders(template.headers)
+      }
+    }).catch((error) => {
+      if (!node_fs.existsSync(tarPath)) {
+        throw error;
+      }
+      debug("Download error. Using cached version:", error);
+      options.offline = true;
+    });
+    debug(`Downloaded ${template.tar} to ${tarPath} in ${Date.now() - s2}ms`);
+  }
+  if (!node_fs.existsSync(tarPath)) {
+    throw new Error(
+      `Tarball not found: ${tarPath} (offline: ${options.offline})`
+    );
+  }
+  const s = Date.now();
+  const subdir = template.subdir?.replace(/^\//, "") || "";
+  await tar.extract({
+    file: tarPath,
+    cwd: extractPath,
+    onentry(entry) {
+      entry.path = entry.path.split("/").splice(1).join("/");
+      if (subdir) {
+        if (entry.path.startsWith(subdir + "/")) {
+          entry.path = entry.path.slice(subdir.length);
+        } else {
+          entry.path = "";
+        }
+      }
+    }
+  });
+  debug(`Extracted to ${extractPath} in ${Date.now() - s}ms`);
+  return {
+    ...template,
+    source,
+    dir: extractPath
+  };
+}
+
+exports.downloadTemplate = downloadTemplate;
+exports.registryProvider = registryProvider;
+exports.startShell = startShell;

package/dist/index.d.cts

@@ -0,0 +1,47 @@
+interface GitInfo {
+    provider: "github" | "gitlab" | "bitbucket" | "sourcehut";
+    repo: string;
+    subdir: string;
+    ref: string;
+}
+interface TemplateInfo {
+    name: string;
+    tar: string;
+    version?: string;
+    subdir?: string;
+    url?: string;
+    defaultDir?: string;
+    headers?: Record<string, string | undefined>;
+    source?: never;
+    dir?: never;
+    [key: string]: any;
+}
+type TemplateProvider = (input: string, options: {
+    auth?: string;
+}) => TemplateInfo | Promise<TemplateInfo> | null;
+
+interface DownloadTemplateOptions {
+    provider?: string;
+    force?: boolean;
+    forceClean?: boolean;
+    offline?: boolean;
+    preferOffline?: boolean;
+    providers?: Record<string, TemplateProvider>;
+    dir?: string;
+    registry?: false | string;
+    cwd?: string;
+    auth?: string;
+}
+type DownloadTemplateResult = Omit<TemplateInfo, "dir" | "source"> & {
+    dir: string;
+    source: string;
+};
+declare function downloadTemplate(input: string, options?: DownloadTemplateOptions): Promise<DownloadTemplateResult>;
+
+declare const registryProvider: (registryEndpoint?: string, options?: {
+    auth?: string;
+}) => TemplateProvider;
+
+declare function startShell(cwd: string): void;
+
+export { type DownloadTemplateOptions, type DownloadTemplateResult, type GitInfo, type TemplateInfo, type TemplateProvider, downloadTemplate, registryProvider, startShell };

package/dist/index.d.mts

@@ -0,0 +1,47 @@
+interface GitInfo {
+    provider: "github" | "gitlab" | "bitbucket" | "sourcehut";
+    repo: string;
+    subdir: string;
+    ref: string;
+}
+interface TemplateInfo {
+    name: string;
+    tar: string;
+    version?: string;
+    subdir?: string;
+    url?: string;
+    defaultDir?: string;
+    headers?: Record<string, string | undefined>;
+    source?: never;
+    dir?: never;
+    [key: string]: any;
+}
+type TemplateProvider = (input: string, options: {
+    auth?: string;
+}) => TemplateInfo | Promise<TemplateInfo> | null;
+
+interface DownloadTemplateOptions {
+    provider?: string;
+    force?: boolean;
+    forceClean?: boolean;
+    offline?: boolean;
+    preferOffline?: boolean;
+    providers?: Record<string, TemplateProvider>;
+    dir?: string;
+    registry?: false | string;
+    cwd?: string;
+    auth?: string;
+}
+type DownloadTemplateResult = Omit<TemplateInfo, "dir" | "source"> & {
+    dir: string;
+    source: string;
+};
+declare function downloadTemplate(input: string, options?: DownloadTemplateOptions): Promise<DownloadTemplateResult>;
+
+declare const registryProvider: (registryEndpoint?: string, options?: {
+    auth?: string;
+}) => TemplateProvider;
+
+declare function startShell(cwd: string): void;
+
+export { type DownloadTemplateOptions, type DownloadTemplateResult, type GitInfo, type TemplateInfo, type TemplateProvider, downloadTemplate, registryProvider, startShell };

package/dist/index.d.ts

@@ -11,7 +11,7 @@ interface TemplateInfo {
     subdir?: string;
     url?: string;
     defaultDir?: string;
-    headers?: Record<string, string>;
+    headers?: Record<string, string | undefined>;
     source?: never;
     dir?: never;
     [key: string]: any;
@@ -44,4 +44,4 @@ declare const registryProvider: (registryEndpoint?: string, options?: {
 
 declare function startShell(cwd: string): void;
 
-export { DownloadTemplateOptions, DownloadTemplateResult, GitInfo, TemplateInfo, TemplateProvider, downloadTemplate, registryProvider, startShell };
+export { type DownloadTemplateOptions, type DownloadTemplateResult, type GitInfo, type TemplateInfo, type TemplateProvider, downloadTemplate, registryProvider, startShell };