giget 0.1.0 → 0.1.3

package/README.md

@@ -11,7 +11,7 @@
 
 ✔ Support popular git providers (GitHub, GitLab, and Bitbucket) out of the box.
 
-✔ Built-in and custom template registry.
+✔ Built-in and custom [template registry](#template-registry).
 
 ✔ Fast cloning using tarball gzip without depending on local `git` and `tar`.
 
@@ -24,22 +24,15 @@
 ## Usage (CLI)
 
 ```bash
-npx giget@latest <repo> [<dir>] [...options]
+npx giget@latest <template> [<dir>] [...options]
 ```
 
-```bash
-npx giget@latest unjs/template my-lib
-# ✨ Successfully cloned https://github.com/unjs/template/tree/main/ to my-lib
-```
+### Arguments
 
-**Arguments:**
+- **template**: Template name or a a URI describing provider, repository, subdir, and branch/ref. (See [Examples](#examples))
+- **dir**: A relative or absolute path where to extract the template.
 
-- **repo**: A URI describing provider, repository, subdir, and branch/ref.
-  - Format is `[provider]:repo[/subpath][#ref]`.
-- **dir**: A relative or absolute path where to extract the repository.
-  - If not provided, the name of the org + repo will be used as the name.
-
-**Options:**
+### Options
 
 - `--force`: Clone to exsiting directory even if exists.
 - `--offline`: Do not attempt to download and use cached version.
@@ -48,8 +41,9 @@ npx giget@latest unjs/template my-lib
 - `--shell`: ⚠️ Open a new shell with current working directory in cloned dir. (Experimental).
 - `--registry`: URL to a custom registry.
 - `--no-registry`: Disable registry lookup and functionality.
+- `--verbose`: Show verbose debugging info.
 
-**Examples:**
+### Examples
 
 ```sh
 # Clone the main branch of github.com/unjs/template to unjs-template directory
@@ -82,15 +76,12 @@ If you want to add your template to the built-in registry, just drop a PR to add
 
 ### Custom Registry
 
-A custom registry should provide one required and one optional endpoint:
+A custom registry should provide an endpoint with dynamic path `/:template.json` that returns a JSON response with keys same as [custom providers](#custom-providers).
 
-- `/:template.json`: (Required) Returns a JSON object same as custom provider response. Keys:
   - `name`: (required) Name of the template. It will be used as default cloning dir too.
   - `tar` (required) Link to the tar download link.
   - `url`: (optional) Webpage of the template.
-  - `subpath` (optional) Subpath of the tar file to clone.
-- `/_info.json`: (Optional) Returns a JSON object with following keys:
-  - `templates`: A string array of possible templates.
+  - `subpath` (optional) Subpath inside the tar file.
 
 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.
 
@@ -152,7 +143,7 @@ The return value is a promise that resolves to the resolved template.
 - [other provider template keys]
   - `url`: (string) URL of repostiroy that can be opened in browser. Useful for logging.
 
-## Custom providers
+## Custom Providers
 
 Using programmatic method, you can make your own custom template providers.
 
@@ -171,6 +162,17 @@ const rainbow: TemplateProvider = async (input) => {
 const { source, dir } = await downloadRepo('rainbow:one', { providers: { rainbow } })
 ```
 
+### Custom Registry Providers
+
+You can define additional [custom registry](#custom-registry) providers using `registryProvider` utility and register to `providers`.
+
+```ts
+import { registryProvider } from 'giget'
+
+const themes = registryProvider('https://raw.githubusercontent.com/unjs/giget/main/templates')
+
+const { source, dir } = await downloadRepo('themes:test', { providers: { themes } })
+```
 
 ## 💻 Development
 

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.9473a836.cjs');
+const giget = require('./shared/giget.2ac4718b.cjs');
 require('node:fs/promises');
 require('node:os');
 require('node:fs');
@@ -19,13 +19,18 @@ function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'defau
 const mri__default = /*#__PURE__*/_interopDefaultLegacy(mri);
 
 async function main() {
-  const args = mri__default(process.argv.slice(2));
+  const args = mri__default(process.argv.slice(2), {
+    boolean: ["help", "force", "force-clean", "offline", "prefer-offline", "shell", "registry", "verbose"]
+  });
   const input = args._[0];
   const dir = args._[1];
   if (!input || args.help || args.h) {
-    console.error("Usage: npx getgit@latest <input> [<dir>] [--force] [--force-clean] [--offline] [--prefer-offline] [--shell] [--registry] [--no-registry]");
+    console.error("Usage: npx getgit@latest <input> [<dir>] [--force] [--force-clean] [--offline] [--prefer-offline] [--shell] [--registry]  [--no-registry] [--verbose]");
     process.exit(1);
   }
+  if (args.verbose) {
+    process.env.DEBUG = process.env.DEBUG || "true";
+  }
   const r = await giget.downloadTemplate(input, {
     dir,
     force: args.force,
@@ -33,7 +38,7 @@ async function main() {
     offline: args.offline,
     registry: args.registry
   });
-  console.log(`\u2728 Successfully cloned ${colorette.cyan(r.url)} to ${colorette.cyan(node_path.relative(process.cwd(), r.dir))}
+  console.log(`\u2728 Successfully cloned ${colorette.cyan(r.name || r.url)} to ${colorette.cyan(node_path.relative(process.cwd(), r.dir))}
 `);
   if (args.shell) {
     giget.startShell(r.dir);

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.3990f4ae.mjs';
+import { d as downloadTemplate, s as startShell } from './shared/giget.4b579418.mjs';
 import 'node:fs/promises';
 import 'node:os';
 import 'node:fs';
@@ -13,13 +13,18 @@ import 'node:child_process';
 import 'node-fetch-native';
 
 async function main() {
-  const args = mri(process.argv.slice(2));
+  const args = mri(process.argv.slice(2), {
+    boolean: ["help", "force", "force-clean", "offline", "prefer-offline", "shell", "registry", "verbose"]
+  });
   const input = args._[0];
   const dir = args._[1];
   if (!input || args.help || args.h) {
-    console.error("Usage: npx getgit@latest <input> [<dir>] [--force] [--force-clean] [--offline] [--prefer-offline] [--shell] [--registry] [--no-registry]");
+    console.error("Usage: npx getgit@latest <input> [<dir>] [--force] [--force-clean] [--offline] [--prefer-offline] [--shell] [--registry]  [--no-registry] [--verbose]");
     process.exit(1);
   }
+  if (args.verbose) {
+    process.env.DEBUG = process.env.DEBUG || "true";
+  }
   const r = await downloadTemplate(input, {
     dir,
     force: args.force,
@@ -27,7 +32,7 @@ async function main() {
     offline: args.offline,
     registry: args.registry
   });
-  console.log(`\u2728 Successfully cloned ${cyan(r.url)} to ${cyan(relative(process.cwd(), r.dir))}
+  console.log(`\u2728 Successfully cloned ${cyan(r.name || r.url)} to ${cyan(relative(process.cwd(), r.dir))}
 `);
   if (args.shell) {
     startShell(r.dir);

package/dist/index.cjs

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-const giget = require('./shared/giget.9473a836.cjs');
+const giget = require('./shared/giget.2ac4718b.cjs');
 require('node:fs/promises');
 require('node:os');
 require('node:fs');
@@ -15,4 +15,5 @@ require('node-fetch-native');
 
 
 exports.downloadTemplate = giget.downloadTemplate;
+exports.registryProvider = giget.registryProvider;
 exports.startShell = giget.startShell;

package/dist/index.d.ts

@@ -36,6 +36,8 @@ declare function downloadTemplate(input: string, opts?: DownloadTemplateOptions)
     url?: string;
 }>;
 
+declare const registryProvider: (registryEndpoint?: string) => TemplateProvider;
+
 declare function startShell(cwd: string): void;
 
-export { DownloadTemplateOptions, GitInfo, TemplateInfo, TemplateProvider, downloadTemplate, startShell };
+export { DownloadTemplateOptions, GitInfo, TemplateInfo, TemplateProvider, downloadTemplate, registryProvider, startShell };

package/dist/index.mjs

@@ -1,4 +1,4 @@
-export { d as downloadTemplate, s as startShell } from './shared/giget.3990f4ae.mjs';
+export { d as downloadTemplate, r as registryProvider, s as startShell } from './shared/giget.4b579418.mjs';
 import 'node:fs/promises';
 import 'node:os';
 import 'node:fs';

package/dist/shared/{giget.9473a836.cjs → giget.2ac4718b.cjs}

@@ -30,11 +30,10 @@ async function download(url, filePath) {
   await promises$1.pipeline(res.body, stream);
   await promises.writeFile(infoPath, JSON.stringify(info), "utf8");
 }
-const inputRegex = /^(?<repo>\w+\/\w+)(?<subdir>[^#]+)?(?<ref>#\w+)?/;
+const inputRegex = /^(?<repo>[\w.-]+\/[\w.-]+)(?<subdir>[^#]+)?(?<ref>#[\w.-]+)?/;
 function parseGitURI(input) {
   const m = input.match(inputRegex)?.groups;
   return {
-    provider: m.provider ? m.provider.substring(0, m.provider.length - 1) : "github",
     repo: m.repo,
     subdir: m.subdir || "/",
     ref: m.ref ? m.ref.substring(1) : "main"
@@ -70,6 +69,7 @@ const github = (input) => {
   return {
     name: parsed.repo.replace("/", "-"),
     version: parsed.ref,
+    subdir: parsed.subdir,
     url: `https://github.com/${parsed.repo}/tree/${parsed.ref}${parsed.subdir}`,
     tar: `https://github.com/${parsed.repo}/archive/${parsed.ref}.tar.gz`
   };
@@ -79,6 +79,7 @@ const gitlab = (input) => {
   return {
     name: parsed.repo.replace("/", "-"),
     version: parsed.ref,
+    subdir: parsed.subdir,
     url: `https://gitlab.com/${parsed.repo}/tree/${parsed.ref}${parsed.subdir}`,
     tar: `https://gitlab.com/${parsed.repo}/-/archive/${parsed.ref}.tar.gz`
   };
@@ -88,6 +89,7 @@ const bitbucket = (input) => {
   return {
     name: parsed.repo.replace("/", "-"),
     version: parsed.ref,
+    subdir: parsed.subdir,
     url: `https://bitbucket.com/${parsed.repo}/src/${parsed.ref}${parsed.subdir}`,
     tar: `https://bitbucket.org/${parsed.repo}/get/${parsed.ref}.tar.gz`
   };
@@ -100,8 +102,9 @@ const providers = {
 };
 
 const DEFAULT_REGISTRY = "https://raw.githubusercontent.com/unjs/giget/main/templates";
-const createRegistryProvider = (registryEndpoint = DEFAULT_REGISTRY) => {
+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) {
@@ -111,13 +114,14 @@ const createRegistryProvider = (registryEndpoint = DEFAULT_REGISTRY) => {
     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]+):/;
+const sourceProtoRe = /^([\w-.]+):/;
 async function downloadTemplate(input, opts = {}) {
-  const registryProvider = opts.registry !== false ? createRegistryProvider(opts.registry) : null;
+  const registry = opts.registry !== false ? registryProvider(opts.registry) : null;
   let providerName = opts.provider || (registryProvider ? "registry" : "github");
   let source = input;
   const sourceProvierMatch = input.match(sourceProtoRe);
@@ -125,7 +129,7 @@ async function downloadTemplate(input, opts = {}) {
     providerName = sourceProvierMatch[1];
     source = input.substring(sourceProvierMatch[0].length);
   }
-  const provider = opts.providers?.[providerName] || providers[providerName] || registryProvider;
+  const provider = opts.providers?.[providerName] || providers[providerName] || registry;
   if (!provider) {
     throw new Error(`Unsupported provider: ${providerName}`);
   }
@@ -186,4 +190,5 @@ async function downloadTemplate(input, opts = {}) {
 }
 
 exports.downloadTemplate = downloadTemplate;
+exports.registryProvider = registryProvider;
 exports.startShell = startShell;

package/dist/shared/{giget.3990f4ae.mjs → giget.4b579418.mjs}

@@ -24,11 +24,10 @@ async function download(url, filePath) {
   await pipeline(res.body, stream);
   await writeFile(infoPath, JSON.stringify(info), "utf8");
 }
-const inputRegex = /^(?<repo>\w+\/\w+)(?<subdir>[^#]+)?(?<ref>#\w+)?/;
+const inputRegex = /^(?<repo>[\w.-]+\/[\w.-]+)(?<subdir>[^#]+)?(?<ref>#[\w.-]+)?/;
 function parseGitURI(input) {
   const m = input.match(inputRegex)?.groups;
   return {
-    provider: m.provider ? m.provider.substring(0, m.provider.length - 1) : "github",
     repo: m.repo,
     subdir: m.subdir || "/",
     ref: m.ref ? m.ref.substring(1) : "main"
@@ -64,6 +63,7 @@ const github = (input) => {
   return {
     name: parsed.repo.replace("/", "-"),
     version: parsed.ref,
+    subdir: parsed.subdir,
     url: `https://github.com/${parsed.repo}/tree/${parsed.ref}${parsed.subdir}`,
     tar: `https://github.com/${parsed.repo}/archive/${parsed.ref}.tar.gz`
   };
@@ -73,6 +73,7 @@ const gitlab = (input) => {
   return {
     name: parsed.repo.replace("/", "-"),
     version: parsed.ref,
+    subdir: parsed.subdir,
     url: `https://gitlab.com/${parsed.repo}/tree/${parsed.ref}${parsed.subdir}`,
     tar: `https://gitlab.com/${parsed.repo}/-/archive/${parsed.ref}.tar.gz`
   };
@@ -82,6 +83,7 @@ const bitbucket = (input) => {
   return {
     name: parsed.repo.replace("/", "-"),
     version: parsed.ref,
+    subdir: parsed.subdir,
     url: `https://bitbucket.com/${parsed.repo}/src/${parsed.ref}${parsed.subdir}`,
     tar: `https://bitbucket.org/${parsed.repo}/get/${parsed.ref}.tar.gz`
   };
@@ -94,8 +96,9 @@ const providers = {
 };
 
 const DEFAULT_REGISTRY = "https://raw.githubusercontent.com/unjs/giget/main/templates";
-const createRegistryProvider = (registryEndpoint = DEFAULT_REGISTRY) => {
+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) {
@@ -105,13 +108,14 @@ const createRegistryProvider = (registryEndpoint = DEFAULT_REGISTRY) => {
     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]+):/;
+const sourceProtoRe = /^([\w-.]+):/;
 async function downloadTemplate(input, opts = {}) {
-  const registryProvider = opts.registry !== false ? createRegistryProvider(opts.registry) : null;
+  const registry = opts.registry !== false ? registryProvider(opts.registry) : null;
   let providerName = opts.provider || (registryProvider ? "registry" : "github");
   let source = input;
   const sourceProvierMatch = input.match(sourceProtoRe);
@@ -119,7 +123,7 @@ async function downloadTemplate(input, opts = {}) {
     providerName = sourceProvierMatch[1];
     source = input.substring(sourceProvierMatch[0].length);
   }
-  const provider = opts.providers?.[providerName] || providers[providerName] || registryProvider;
+  const provider = opts.providers?.[providerName] || providers[providerName] || registry;
   if (!provider) {
     throw new Error(`Unsupported provider: ${providerName}`);
   }
@@ -179,4 +183,4 @@ async function downloadTemplate(input, opts = {}) {
   };
 }
 
-export { downloadTemplate as d, startShell as s };
+export { downloadTemplate as d, registryProvider as r, startShell as s };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "giget",
-  "version": "0.1.0",
+  "version": "0.1.3",
   "description": "Download templates and git repositories with pleasure!",
   "repository": "unjs/giget",
   "license": "MIT",
@@ -32,13 +32,13 @@
     "@nuxtjs/eslint-config-typescript": "^11.0.0",
     "@types/node": "^18.7.16",
     "@types/tar": "^6.1.2",
-    "@vitest/coverage-c8": "^0.23.1",
+    "@vitest/coverage-c8": "^0.23.2",
     "eslint": "^8.23.0",
     "jiti": "^1.15.0",
     "standard-version": "^9.5.0",
-    "typescript": "^4.8.2",
+    "typescript": "^4.8.3",
     "unbuild": "^0.8.10",
-    "vitest": "^0.23.1"
+    "vitest": "^0.23.2"
   },
   "packageManager": "pnpm@7.11.0",
   "scripts": {
@@ -46,7 +46,7 @@
     "dev": "vitest dev",
     "giget": "jiti ./src/cli.ts",
     "lint": "eslint --ext .ts,.js,.mjs,.cjs .",
-    "play": "DEBUG=1 pnpm giget gh:unjs/template .tmp/clone --force-clean",
+    "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"
   }