giget 0.1.1 → 0.1.4

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 gh: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 gh: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
@@ -84,8 +78,9 @@ If you want to add your template to the built-in registry, just drop a PR to add
 
 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).
 
-  - `name`: (required) Name of the template. It will be used as default cloning dir too.
+  - `name`: (required) Name of the template.
   - `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.
 

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.971c96e2.cjs');
+const giget = require('./shared/giget.774476cb.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.9c9971fe.mjs';
+import { d as downloadTemplate, s as startShell } from './shared/giget.1430f5a2.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.971c96e2.cjs');
+const giget = require('./shared/giget.774476cb.cjs');
 require('node:fs/promises');
 require('node:os');
 require('node:fs');

package/dist/index.d.ts

@@ -10,6 +10,7 @@ interface TemplateInfo {
     version?: string;
     subdir?: string;
     url?: string;
+    defaultDir?: string;
     source?: never;
     dir?: never;
     [key: string]: any;
@@ -34,6 +35,7 @@ declare function downloadTemplate(input: string, opts?: DownloadTemplateOptions)
     version?: string;
     subdir?: string;
     url?: string;
+    defaultDir?: string;
 }>;
 
 declare const registryProvider: (registryEndpoint?: string) => TemplateProvider;

package/dist/index.mjs

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

package/dist/shared/{giget.9c9971fe.mjs → giget.1430f5a2.mjs}

@@ -63,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`
   };
@@ -72,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`
   };
@@ -81,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`
   };
@@ -127,8 +130,9 @@ async function downloadTemplate(input, opts = {}) {
   const template = await Promise.resolve().then(() => provider(source)).catch((err) => {
     throw new Error(`Failed to download template from ${providerName}: ${err.message}`);
   });
-  template.name = template.name.replace(/[^a-zA-Z0-9-]/g, "-");
-  const extractPath = resolve(opts.dir || template.name);
+  template.name = (template.name || "template").replace(/[^a-z0-9-]/gi, "-");
+  template.defaultDir = (template.defaultDir || template.name).replace(/[^a-z0-9-]/gi, "-");
+  const extractPath = resolve(opts.dir || template.defaultDir);
   if (opts.forceClean) {
     await rm(extractPath, { recursive: true, force: true });
   }

package/dist/shared/{giget.971c96e2.cjs → giget.774476cb.cjs}

@@ -69,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`
   };
@@ -78,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`
   };
@@ -87,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`
   };
@@ -133,8 +136,9 @@ async function downloadTemplate(input, opts = {}) {
   const template = await Promise.resolve().then(() => provider(source)).catch((err) => {
     throw new Error(`Failed to download template from ${providerName}: ${err.message}`);
   });
-  template.name = template.name.replace(/[^a-zA-Z0-9-]/g, "-");
-  const extractPath = pathe.resolve(opts.dir || template.name);
+  template.name = (template.name || "template").replace(/[^a-z0-9-]/gi, "-");
+  template.defaultDir = (template.defaultDir || template.name).replace(/[^a-z0-9-]/gi, "-");
+  const extractPath = pathe.resolve(opts.dir || template.defaultDir);
   if (opts.forceClean) {
     await promises.rm(extractPath, { recursive: true, force: true });
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "giget",
-  "version": "0.1.1",
+  "version": "0.1.4",
   "description": "Download templates and git repositories with pleasure!",
   "repository": "unjs/giget",
   "license": "MIT",
@@ -46,7 +46,7 @@
     "dev": "vitest dev",
     "giget": "jiti ./src/cli.ts",
     "lint": "eslint --ext .ts,.js,.mjs,.cjs .",
-    "play": "DEBUG=1 pnpm giget unjs .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"
   }