giget 0.1.6 → 1.0.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 - UnJS
+Copyright (c) Pooya Parsa <pooya@pi0.io>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -89,7 +89,7 @@ A custom registry should provide an endpoint with dynamic path `/:template.json`
 - `tar` (required) Link to the tar download link.
 - `defaultDir`: (optional) Default cloning directory.
 - `url`: (optional) Webpage of the template.
-- `subpath`: (optional) Subpath inside the tar file.
+- `subdir`: (optional) Directory inside the tar file.
 - `headers`: (optional) Custom headers to send while downloading template.
 
 Because of the simplicity, you can even use a github repository as template registry but also you can build something more powerful by bringing your own API.
@@ -135,7 +135,7 @@ const { source, dir } = await downloadTemplate('github:unjs/template')
   - `provider`: (string) Either `github`, `gitlab`, `bitbucket` or `sourcehut`. The default is `github`.
   - `repo`: (string) Name of repository in format of `{username}/{reponame}`.
   - `ref`: (string) Git ref (branch or commit or tag). The default value is `main`.
-  - `subdirpath`: (string) subdir of the repo to clone from. The default value is none.
+  - `subdir`: (string) Directory of the repo to clone from. The default value is none.
   - `force`: (boolean) Extract to the exisiting dir even if already exsists.
   - `forceClean`: (boolean) ⚠️ Clean ups any existing directory or file before cloning.
   - `offline`: (boolean) Do not attempt to download and use cached version.

package/dist/cli.cjs

@@ -4,52 +4,50 @@
 const node_path = require('node:path');
 const mri = require('mri');
 const colorette = require('colorette');
-const giget = require('./shared/giget.73314e21.cjs');
+const giget = require('./shared/giget.1028e17a.cjs');
 require('node:fs/promises');
 require('node:os');
 require('node:fs');
 require('tar');
 require('pathe');
 require('defu');
-require('node:stream/promises');
+require('node:stream');
 require('node:child_process');
+require('node:util');
 require('node-fetch-native');
-
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e["default"] : e; }
-
-const mri__default = /*#__PURE__*/_interopDefaultLegacy(mri);
+require('https-proxy-agent');
 
 async function main() {
-  const args = mri__default(process.argv.slice(2), {
+  const arguments_ = mri(process.argv.slice(2), {
     boolean: ["help", "force", "force-clean", "offline", "prefer-offline", "shell", "verbose"],
     string: ["registry", "cwd", "auth"]
   });
-  const input = args._[0];
-  const dir = args._[1];
-  if (!input || args.help || args.h) {
+  const input = arguments_._[0];
+  const dir = arguments_._[1];
+  if (!input || arguments_.help || arguments_.h) {
     console.error("Usage: npx getgit@latest <input> [<dir>] [--force] [--force-clean] [--offline] [--prefer-offline] [--shell] [--registry]  [--no-registry] [--verbose] [--cwd] [--auth]");
     process.exit(1);
   }
-  if (args.verbose) {
+  if (arguments_.verbose) {
     process.env.DEBUG = process.env.DEBUG || "true";
   }
   const r = await giget.downloadTemplate(input, {
     dir,
-    force: args.force,
-    forceClean: args["force-clean"],
-    offline: args.offline,
-    registry: args.registry,
-    cwd: args.cwd,
-    auth: args.auth
+    force: arguments_.force,
+    forceClean: arguments_["force-clean"],
+    offline: arguments_.offline,
+    registry: arguments_.registry,
+    cwd: arguments_.cwd,
+    auth: arguments_.auth
   });
   console.log(`\u2728 Successfully cloned ${colorette.cyan(r.name || r.url)} to ${colorette.cyan(node_path.relative(process.cwd(), r.dir))}
 `);
-  if (args.shell) {
+  if (arguments_.shell) {
     giget.startShell(r.dir);
   }
   process.exit(0);
 }
-main().catch((err) => {
-  console.error(err);
+main().catch((error) => {
+  console.error(error);
   process.exit(1);
 });

package/dist/cli.mjs

@@ -2,48 +2,50 @@
 import { relative } from 'node:path';
 import mri from 'mri';
 import { cyan } from 'colorette';
-import { d as downloadTemplate, s as startShell } from './shared/giget.ae887001.mjs';
+import { d as downloadTemplate, s as startShell } from './shared/giget.5e7ec864.mjs';
 import 'node:fs/promises';
 import 'node:os';
 import 'node:fs';
 import 'tar';
 import 'pathe';
 import 'defu';
-import 'node:stream/promises';
+import 'node:stream';
 import 'node:child_process';
+import 'node:util';
 import 'node-fetch-native';
+import 'https-proxy-agent';
 
 async function main() {
-  const args = mri(process.argv.slice(2), {
+  const arguments_ = mri(process.argv.slice(2), {
     boolean: ["help", "force", "force-clean", "offline", "prefer-offline", "shell", "verbose"],
     string: ["registry", "cwd", "auth"]
   });
-  const input = args._[0];
-  const dir = args._[1];
-  if (!input || args.help || args.h) {
+  const input = arguments_._[0];
+  const dir = arguments_._[1];
+  if (!input || arguments_.help || arguments_.h) {
     console.error("Usage: npx getgit@latest <input> [<dir>] [--force] [--force-clean] [--offline] [--prefer-offline] [--shell] [--registry]  [--no-registry] [--verbose] [--cwd] [--auth]");
     process.exit(1);
   }
-  if (args.verbose) {
+  if (arguments_.verbose) {
     process.env.DEBUG = process.env.DEBUG || "true";
   }
   const r = await downloadTemplate(input, {
     dir,
-    force: args.force,
-    forceClean: args["force-clean"],
-    offline: args.offline,
-    registry: args.registry,
-    cwd: args.cwd,
-    auth: args.auth
+    force: arguments_.force,
+    forceClean: arguments_["force-clean"],
+    offline: arguments_.offline,
+    registry: arguments_.registry,
+    cwd: arguments_.cwd,
+    auth: arguments_.auth
   });
   console.log(`\u2728 Successfully cloned ${cyan(r.name || r.url)} to ${cyan(relative(process.cwd(), r.dir))}
 `);
-  if (args.shell) {
+  if (arguments_.shell) {
     startShell(r.dir);
   }
   process.exit(0);
 }
-main().catch((err) => {
-  console.error(err);
+main().catch((error) => {
+  console.error(error);
   process.exit(1);
 });

package/dist/index.cjs

@@ -1,17 +1,17 @@
 'use strict';
 
-Object.defineProperty(exports, '__esModule', { value: true });
-
-const giget = require('./shared/giget.73314e21.cjs');
+const giget = require('./shared/giget.1028e17a.cjs');
 require('node:fs/promises');
 require('node:os');
 require('node:fs');
 require('tar');
 require('pathe');
 require('defu');
-require('node:stream/promises');
+require('node:stream');
 require('node:child_process');
+require('node:util');
 require('node-fetch-native');
+require('https-proxy-agent');
 
 
 

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 interface GitInfo {
-    provider: 'github' | 'gitlab' | 'bitbucket' | 'sourcehut';
+    provider: "github" | "gitlab" | "bitbucket" | "sourcehut";
     repo: string;
     subdir: string;
     ref: string;
@@ -32,11 +32,11 @@ interface DownloadTemplateOptions {
     cwd?: string;
     auth?: string;
 }
-declare type DownloadTemplateResult = Omit<TemplateInfo, 'dir' | 'source'> & {
+declare type DownloadTemplateResult = Omit<TemplateInfo, "dir" | "source"> & {
     dir: string;
     source: string;
 };
-declare function downloadTemplate(input: string, opts?: DownloadTemplateOptions): Promise<DownloadTemplateResult>;
+declare function downloadTemplate(input: string, options?: DownloadTemplateOptions): Promise<DownloadTemplateResult>;
 
 declare const registryProvider: (registryEndpoint?: string) => TemplateProvider;
 

package/dist/index.mjs

@@ -1,10 +1,12 @@
-export { d as downloadTemplate, r as registryProvider, s as startShell } from './shared/giget.ae887001.mjs';
+export { d as downloadTemplate, r as registryProvider, s as startShell } from './shared/giget.5e7ec864.mjs';
 import 'node:fs/promises';
 import 'node:os';
 import 'node:fs';
 import 'tar';
 import 'pathe';
 import 'defu';
-import 'node:stream/promises';
+import 'node:stream';
 import 'node:child_process';
+import 'node:util';
 import 'node-fetch-native';
+import 'https-proxy-agent';

package/dist/shared/{giget.73314e21.cjs → giget.1028e17a.cjs}

@@ -6,29 +6,27 @@ const node_fs = require('node:fs');
 const tar = require('tar');
 const pathe = require('pathe');
 const defu = require('defu');
-const promises$1 = require('node:stream/promises');
+const node_stream = require('node:stream');
 const node_child_process = require('node:child_process');
-const fetch = require('node-fetch-native');
+const node_util = require('node:util');
+const nodeFetchNative = require('node-fetch-native');
+const createHttpsProxyAgent = require('https-proxy-agent');
 
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e["default"] : e; }
-
-const fetch__default = /*#__PURE__*/_interopDefaultLegacy(fetch);
-
-async function download(url, filePath, opts = {}) {
+async function download(url, filePath, options = {}) {
   const infoPath = filePath + ".json";
   const info = JSON.parse(await promises.readFile(infoPath, "utf8").catch(() => "{}"));
-  const headRes = await fetch.fetch(url, { method: "HEAD", headers: opts.headers }).catch(() => null);
-  const etag = headRes?.headers.get("etag");
+  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;
   }
   info.etag = etag;
-  const res = await fetch.fetch(url, { headers: opts.headers });
-  if (res.status >= 400) {
-    throw new Error(`Failed to download ${url}: ${res.status} ${res.statusText}`);
+  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 promises$1.pipeline(res.body, stream);
+  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.-]+)?/;
@@ -37,14 +35,19 @@ function parseGitURI(input) {
   return {
     repo: m.repo,
     subdir: m.subdir || "/",
-    ref: m.ref ? m.ref.substring(1) : "main"
+    ref: m.ref ? m.ref.slice(1) : "main"
   };
 }
-function debug(...args) {
+function debug(...arguments_) {
   if (process.env.DEBUG) {
-    console.debug("[giget]", ...args);
+    console.debug("[giget]", ...arguments_);
   }
 }
+async function sendFetch(url, options) {
+  const proxy = process.env.HTTPS_PROXY || process.env.https_proxy || process.env.HTTP_PROXY || process.env.http_proxy;
+  const requestOptions = proxy ? { agent: createHttpsProxyAgent(proxy), ...options } : options;
+  return await nodeFetchNative.fetch(url, requestOptions);
+}
 function currentShell() {
   if (process.env.SHELL) {
     return process.env.SHELL;
@@ -65,46 +68,46 @@ function startShell(cwd) {
   });
 }
 
-const github = (input, opts) => {
+const github = (input, options) => {
   const parsed = parseGitURI(input);
   return {
     name: parsed.repo.replace("/", "-"),
     version: parsed.ref,
     subdir: parsed.subdir,
-    headers: { Authorization: opts.auth ? `Bearer ${opts.auth}` : void 0 },
+    headers: { Authorization: options.auth ? `Bearer ${options.auth}` : void 0 },
     url: `https://github.com/${parsed.repo}/tree/${parsed.ref}${parsed.subdir}`,
     tar: `https://github.com/${parsed.repo}/archive/${parsed.ref}.tar.gz`
   };
 };
-const gitlab = (input, opts) => {
+const gitlab = (input, options) => {
   const parsed = parseGitURI(input);
   return {
     name: parsed.repo.replace("/", "-"),
     version: parsed.ref,
     subdir: parsed.subdir,
-    headers: { Authorization: opts.auth ? `Bearer ${opts.auth}` : void 0 },
+    headers: { Authorization: options.auth ? `Bearer ${options.auth}` : void 0 },
     url: `https://gitlab.com/${parsed.repo}/tree/${parsed.ref}${parsed.subdir}`,
     tar: `https://gitlab.com/${parsed.repo}/-/archive/${parsed.ref}.tar.gz`
   };
 };
-const bitbucket = (input, opts) => {
+const bitbucket = (input, options) => {
   const parsed = parseGitURI(input);
   return {
     name: parsed.repo.replace("/", "-"),
     version: parsed.ref,
     subdir: parsed.subdir,
-    headers: { Authorization: opts.auth ? `Bearer ${opts.auth}` : void 0 },
+    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, opts) => {
+const sourcehut = (input, options) => {
   const parsed = parseGitURI(input);
   return {
     name: parsed.repo.replace("/", "-"),
     version: parsed.ref,
     subdir: parsed.subdir,
-    headers: { Authorization: opts.auth ? `Bearer ${opts.auth}` : void 0 },
+    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`
   };
@@ -122,11 +125,11 @@ const registryProvider = (registryEndpoint = DEFAULT_REGISTRY) => {
   return async (input) => {
     const start = Date.now();
     const registryURL = `${registryEndpoint}/${input}.json`;
-    const res = await fetch__default(registryURL);
-    if (res.status >= 400) {
-      throw new Error(`Failed to download ${input} template info from ${registryURL}: ${res.status} ${res.statusText}`);
+    const result = await sendFetch(registryURL);
+    if (result.status >= 400) {
+      throw new Error(`Failed to download ${input} template info from ${registryURL}: ${result.status} ${result.statusText}`);
     }
-    const info = await res.json();
+    const info = await result.json();
     if (!info.tar || !info.name) {
       throw new Error(`Invalid template info from ${registryURL}. name or tar fields are missing!`);
     }
@@ -136,56 +139,56 @@ const registryProvider = (registryEndpoint = DEFAULT_REGISTRY) => {
 };
 
 const sourceProtoRe = /^([\w-.]+):/;
-async function downloadTemplate(input, opts = {}) {
-  opts = defu.defu({
+async function downloadTemplate(input, options = {}) {
+  options = defu.defu({
     registry: process.env.GIGET_REGISTRY,
     auth: process.env.GIGET_AUTH
-  }, opts);
-  const registry = opts.registry !== false ? registryProvider(opts.registry) : null;
-  let providerName = opts.provider || (registryProvider ? "registry" : "github");
+  }, options);
+  const registry = options.registry !== false ? registryProvider(options.registry) : void 0;
+  let providerName = options.provider || (registryProvider ? "registry" : "github");
   let source = input;
   const sourceProvierMatch = input.match(sourceProtoRe);
   if (sourceProvierMatch) {
     providerName = sourceProvierMatch[1];
-    source = input.substring(sourceProvierMatch[0].length);
+    source = input.slice(sourceProvierMatch[0].length);
   }
-  const provider = opts.providers?.[providerName] || providers[providerName] || registry;
+  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: opts.auth })).catch((err) => {
-    throw new Error(`Failed to download template from ${providerName}: ${err.message}`);
+  const template = await Promise.resolve().then(() => provider(source, { auth: options.auth })).catch((error) => {
+    throw new Error(`Failed to download template from ${providerName}: ${error.message}`);
   });
-  template.name = (template.name || "template").replace(/[^a-z0-9-]/gi, "-");
-  template.defaultDir = (template.defaultDir || template.name).replace(/[^a-z0-9-]/gi, "-");
-  const cwd = pathe.resolve(opts.cwd || ".");
-  const extractPath = pathe.resolve(cwd, opts.dir || template.defaultDir);
-  if (opts.forceClean) {
+  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 (!opts.force && node_fs.existsSync(extractPath) && node_fs.readdirSync(extractPath).length) {
+  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 tmpDir = pathe.resolve(node_os.homedir(), ".giget", opts.provider, template.name);
-  const tarPath = pathe.resolve(tmpDir, (template.version || template.name) + ".tar.gz");
-  if (opts.preferOffline && node_fs.existsSync(tarPath)) {
-    opts.offline = true;
+  const temporaryDirectory = pathe.resolve(node_os.homedir(), ".giget", options.provider, template.name);
+  const tarPath = pathe.resolve(temporaryDirectory, (template.version || template.name) + ".tar.gz");
+  if (options.preferOffline && node_fs.existsSync(tarPath)) {
+    options.offline = true;
   }
-  if (!opts.offline) {
+  if (!options.offline) {
     await promises.mkdir(pathe.dirname(tarPath), { recursive: true });
     const s2 = Date.now();
-    await download(template.tar, tarPath, { headers: template.headers }).catch((err) => {
+    await download(template.tar, tarPath, { headers: template.headers }).catch((error) => {
       if (!node_fs.existsSync(tarPath)) {
-        throw err;
+        throw error;
       }
-      debug("Download error. Using cached version:", err);
-      opts.offline = true;
+      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: ${opts.offline})`);
+    throw new Error(`Tarball not found: ${tarPath} (offline: ${options.offline})`);
   }
   const s = Date.now();
   const subdir = template.subdir?.replace(/^\//, "") || "";
@@ -196,7 +199,7 @@ async function downloadTemplate(input, opts = {}) {
       entry.path = entry.path.split("/").splice(1).join("/");
       if (subdir) {
         if (entry.path.startsWith(subdir + "/")) {
-          entry.path = entry.path.substring(subdir.length);
+          entry.path = entry.path.slice(subdir.length);
         } else {
           entry.path = "";
         }

package/dist/shared/{giget.ae887001.mjs → giget.5e7ec864.mjs}

@@ -4,25 +4,27 @@ import { existsSync, createWriteStream, readdirSync } from 'node:fs';
 import { extract } from 'tar';
 import { resolve, relative, dirname } from 'pathe';
 import { defu } from 'defu';
-import { pipeline } from 'node:stream/promises';
+import { pipeline } from 'node:stream';
 import { spawnSync } from 'node:child_process';
-import fetch$1, { fetch } from 'node-fetch-native';
+import { promisify } from 'node:util';
+import { fetch } from 'node-fetch-native';
+import createHttpsProxyAgent from 'https-proxy-agent';
 
-async function download(url, filePath, opts = {}) {
+async function download(url, filePath, options = {}) {
   const infoPath = filePath + ".json";
   const info = JSON.parse(await readFile(infoPath, "utf8").catch(() => "{}"));
-  const headRes = await fetch(url, { method: "HEAD", headers: opts.headers }).catch(() => null);
-  const etag = headRes?.headers.get("etag");
+  const headResponse = await sendFetch(url, { method: "HEAD", headers: options.headers }).catch(() => void 0);
+  const etag = headResponse?.headers.get("etag");
   if (info.etag === etag && existsSync(filePath)) {
     return;
   }
   info.etag = etag;
-  const res = await fetch(url, { headers: opts.headers });
-  if (res.status >= 400) {
-    throw new Error(`Failed to download ${url}: ${res.status} ${res.statusText}`);
+  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 = createWriteStream(filePath);
-  await pipeline(res.body, stream);
+  await promisify(pipeline)(response.body, stream);
   await writeFile(infoPath, JSON.stringify(info), "utf8");
 }
 const inputRegex = /^(?<repo>[\w.-]+\/[\w.-]+)(?<subdir>[^#]+)?(?<ref>#[\w.-]+)?/;
@@ -31,14 +33,19 @@ function parseGitURI(input) {
   return {
     repo: m.repo,
     subdir: m.subdir || "/",
-    ref: m.ref ? m.ref.substring(1) : "main"
+    ref: m.ref ? m.ref.slice(1) : "main"
   };
 }
-function debug(...args) {
+function debug(...arguments_) {
   if (process.env.DEBUG) {
-    console.debug("[giget]", ...args);
+    console.debug("[giget]", ...arguments_);
   }
 }
+async function sendFetch(url, options) {
+  const proxy = process.env.HTTPS_PROXY || process.env.https_proxy || process.env.HTTP_PROXY || process.env.http_proxy;
+  const requestOptions = proxy ? { agent: createHttpsProxyAgent(proxy), ...options } : options;
+  return await fetch(url, requestOptions);
+}
 function currentShell() {
   if (process.env.SHELL) {
     return process.env.SHELL;
@@ -59,46 +66,46 @@ function startShell(cwd) {
   });
 }
 
-const github = (input, opts) => {
+const github = (input, options) => {
   const parsed = parseGitURI(input);
   return {
     name: parsed.repo.replace("/", "-"),
     version: parsed.ref,
     subdir: parsed.subdir,
-    headers: { Authorization: opts.auth ? `Bearer ${opts.auth}` : void 0 },
+    headers: { Authorization: options.auth ? `Bearer ${options.auth}` : void 0 },
     url: `https://github.com/${parsed.repo}/tree/${parsed.ref}${parsed.subdir}`,
     tar: `https://github.com/${parsed.repo}/archive/${parsed.ref}.tar.gz`
   };
 };
-const gitlab = (input, opts) => {
+const gitlab = (input, options) => {
   const parsed = parseGitURI(input);
   return {
     name: parsed.repo.replace("/", "-"),
     version: parsed.ref,
     subdir: parsed.subdir,
-    headers: { Authorization: opts.auth ? `Bearer ${opts.auth}` : void 0 },
+    headers: { Authorization: options.auth ? `Bearer ${options.auth}` : void 0 },
     url: `https://gitlab.com/${parsed.repo}/tree/${parsed.ref}${parsed.subdir}`,
     tar: `https://gitlab.com/${parsed.repo}/-/archive/${parsed.ref}.tar.gz`
   };
 };
-const bitbucket = (input, opts) => {
+const bitbucket = (input, options) => {
   const parsed = parseGitURI(input);
   return {
     name: parsed.repo.replace("/", "-"),
     version: parsed.ref,
     subdir: parsed.subdir,
-    headers: { Authorization: opts.auth ? `Bearer ${opts.auth}` : void 0 },
+    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, opts) => {
+const sourcehut = (input, options) => {
   const parsed = parseGitURI(input);
   return {
     name: parsed.repo.replace("/", "-"),
     version: parsed.ref,
     subdir: parsed.subdir,
-    headers: { Authorization: opts.auth ? `Bearer ${opts.auth}` : void 0 },
+    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`
   };
@@ -116,11 +123,11 @@ const registryProvider = (registryEndpoint = DEFAULT_REGISTRY) => {
   return async (input) => {
     const start = Date.now();
     const registryURL = `${registryEndpoint}/${input}.json`;
-    const res = await fetch$1(registryURL);
-    if (res.status >= 400) {
-      throw new Error(`Failed to download ${input} template info from ${registryURL}: ${res.status} ${res.statusText}`);
+    const result = await sendFetch(registryURL);
+    if (result.status >= 400) {
+      throw new Error(`Failed to download ${input} template info from ${registryURL}: ${result.status} ${result.statusText}`);
     }
-    const info = await res.json();
+    const info = await result.json();
     if (!info.tar || !info.name) {
       throw new Error(`Invalid template info from ${registryURL}. name or tar fields are missing!`);
     }
@@ -130,56 +137,56 @@ const registryProvider = (registryEndpoint = DEFAULT_REGISTRY) => {
 };
 
 const sourceProtoRe = /^([\w-.]+):/;
-async function downloadTemplate(input, opts = {}) {
-  opts = defu({
+async function downloadTemplate(input, options = {}) {
+  options = defu({
     registry: process.env.GIGET_REGISTRY,
     auth: process.env.GIGET_AUTH
-  }, opts);
-  const registry = opts.registry !== false ? registryProvider(opts.registry) : null;
-  let providerName = opts.provider || (registryProvider ? "registry" : "github");
+  }, options);
+  const registry = options.registry !== false ? registryProvider(options.registry) : void 0;
+  let providerName = options.provider || (registryProvider ? "registry" : "github");
   let source = input;
   const sourceProvierMatch = input.match(sourceProtoRe);
   if (sourceProvierMatch) {
     providerName = sourceProvierMatch[1];
-    source = input.substring(sourceProvierMatch[0].length);
+    source = input.slice(sourceProvierMatch[0].length);
   }
-  const provider = opts.providers?.[providerName] || providers[providerName] || registry;
+  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: opts.auth })).catch((err) => {
-    throw new Error(`Failed to download template from ${providerName}: ${err.message}`);
+  const template = await Promise.resolve().then(() => provider(source, { auth: options.auth })).catch((error) => {
+    throw new Error(`Failed to download template from ${providerName}: ${error.message}`);
   });
-  template.name = (template.name || "template").replace(/[^a-z0-9-]/gi, "-");
-  template.defaultDir = (template.defaultDir || template.name).replace(/[^a-z0-9-]/gi, "-");
-  const cwd = resolve(opts.cwd || ".");
-  const extractPath = resolve(cwd, opts.dir || template.defaultDir);
-  if (opts.forceClean) {
+  template.name = (template.name || "template").replace(/[^\da-z-]/gi, "-");
+  template.defaultDir = (template.defaultDir || template.name).replace(/[^\da-z-]/gi, "-");
+  const cwd = resolve(options.cwd || ".");
+  const extractPath = resolve(cwd, options.dir || template.defaultDir);
+  if (options.forceClean) {
     await rm(extractPath, { recursive: true, force: true });
   }
-  if (!opts.force && existsSync(extractPath) && readdirSync(extractPath).length) {
+  if (!options.force && existsSync(extractPath) && readdirSync(extractPath).length > 0) {
     throw new Error(`Destination ${extractPath} already exists.`);
   }
   await mkdir(extractPath, { recursive: true });
-  const tmpDir = resolve(homedir(), ".giget", opts.provider, template.name);
-  const tarPath = resolve(tmpDir, (template.version || template.name) + ".tar.gz");
-  if (opts.preferOffline && existsSync(tarPath)) {
-    opts.offline = true;
+  const temporaryDirectory = resolve(homedir(), ".giget", options.provider, template.name);
+  const tarPath = resolve(temporaryDirectory, (template.version || template.name) + ".tar.gz");
+  if (options.preferOffline && existsSync(tarPath)) {
+    options.offline = true;
   }
-  if (!opts.offline) {
+  if (!options.offline) {
     await mkdir(dirname(tarPath), { recursive: true });
     const s2 = Date.now();
-    await download(template.tar, tarPath, { headers: template.headers }).catch((err) => {
+    await download(template.tar, tarPath, { headers: template.headers }).catch((error) => {
       if (!existsSync(tarPath)) {
-        throw err;
+        throw error;
       }
-      debug("Download error. Using cached version:", err);
-      opts.offline = true;
+      debug("Download error. Using cached version:", error);
+      options.offline = true;
     });
     debug(`Downloaded ${template.tar} to ${tarPath} in ${Date.now() - s2}ms`);
   }
   if (!existsSync(tarPath)) {
-    throw new Error(`Tarball not found: ${tarPath} (offline: ${opts.offline})`);
+    throw new Error(`Tarball not found: ${tarPath} (offline: ${options.offline})`);
   }
   const s = Date.now();
   const subdir = template.subdir?.replace(/^\//, "") || "";
@@ -190,7 +197,7 @@ async function downloadTemplate(input, opts = {}) {
       entry.path = entry.path.split("/").splice(1).join("/");
       if (subdir) {
         if (entry.path.startsWith(subdir + "/")) {
-          entry.path = entry.path.substring(subdir.length);
+          entry.path = entry.path.slice(subdir.length);
         } else {
           entry.path = "";
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "giget",
-  "version": "0.1.6",
+  "version": "1.0.0",
   "description": "Download templates and git repositories with pleasure!",
   "repository": "unjs/giget",
   "license": "MIT",
@@ -12,6 +12,7 @@
   "exports": {
     ".": {
       "import": "./dist/index.mjs",
+      "types": "./dist/index.d.ts",
       "require": "./dist/index.cjs"
     }
   },
@@ -21,34 +22,36 @@
   "files": [
     "dist"
   ],
-  "dependencies": {
-    "colorette": "^2.0.19",
-    "defu": "^6.1.0",
-    "mri": "^1.2.0",
-    "node-fetch-native": "^0.1.4",
-    "pathe": "^0.3.7",
-    "tar": "^6.1.11"
-  },
-  "devDependencies": {
-    "@nuxtjs/eslint-config-typescript": "^11.0.0",
-    "@types/node": "^18.7.16",
-    "@types/tar": "^6.1.2",
-    "@vitest/coverage-c8": "^0.23.2",
-    "eslint": "^8.23.1",
-    "jiti": "^1.15.0",
-    "standard-version": "^9.5.0",
-    "typescript": "^4.8.3",
-    "unbuild": "^0.8.11",
-    "vitest": "^0.23.2"
-  },
-  "packageManager": "pnpm@7.11.0",
   "scripts": {
     "build": "unbuild",
     "dev": "vitest dev",
     "giget": "jiti ./src/cli.ts",
     "lint": "eslint --ext .ts,.js,.mjs,.cjs .",
+    "prepack": "unbuild",
     "play": "pnpm giget --force-clean --verbose unjs .tmp/clone",
     "release": "pnpm test && standard-version && git push --follow-tags && pnpm publish",
     "test": "pnpm lint && vitest run --coverage"
-  }
-}
+  },
+  "dependencies": {
+    "colorette": "^2.0.19",
+    "defu": "^6.1.1",
+    "https-proxy-agent": "^5.0.1",
+    "mri": "^1.2.0",
+    "node-fetch-native": "^1.0.1",
+    "pathe": "^1.0.0",
+    "tar": "^6.1.12"
+  },
+  "devDependencies": {
+    "@types/node": "^18.11.9",
+    "@types/tar": "^6.1.3",
+    "@vitest/coverage-c8": "^0.25.2",
+    "eslint": "^8.27.0",
+    "eslint-config-unjs": "^0.0.2",
+    "jiti": "^1.16.0",
+    "standard-version": "^9.5.0",
+    "typescript": "^4.8.4",
+    "unbuild": "^0.9.4",
+    "vitest": "^0.25.2"
+  },
+  "packageManager": "pnpm@7.16.0"
+}