@variablelab/vland 0.3.6 → 0.3.8-git-fdf054c.0

package/README.md

@@ -43,23 +43,25 @@ See [`CLI.md`](./CLI.md) for the full reference (auto-generated per release).
 | `backend`  | An Elysia (`@elysiajs/node`) backend with evlog, Vitest, Dockerfile, CI shape.            |
 | `monorepo` | pnpm + Turbo workspace with an Elysia API, a Vite-React SPA, and a few internal packages. |
 
-All templates target Node.js, use pnpm, and ship [`@rrlab/cli`](https://github.com/withvariablelab/dx/tree/main/run-run) (`rr`) as the single entry point for lint, format, type-check, and build. The per-tool config files (`biome.json`, `tsconfig.json`, `tsdown.config.ts`) are not bundled — run `rr plugins add biome ts tsdown` (one at a time) in your new project to opt in. See the scaffolded README for the exact post-install setup.
+All templates target Node.js, pin Node.js and pnpm with [mise](https://mise.jdx.dev) (`mise.toml` and `mise.lock`), run their GitHub Actions on SHA-pinned actions checked by [zizmor](https://docs.zizmor.sh), and ship [`@rrlab/cli`](https://github.com/withvariablelab/dx/tree/main/run-run) (`rr`) as the single entry point for lint, format, type-check, and build. The per-tool config files (`biome.json`, `tsconfig.json`, `tsdown.config.ts`) are not bundled — run `rr plugins add biome ts tsdown` (one at a time) in your new project to opt in. See the scaffolded README for the exact post-install setup.
 
 ## Shell completion
 
-`vland` ships a `completion` subcommand that prints a shell-specific script. Add it to your shell rc file:
+`vland` ships a `completion` subcommand that prints a shell-specific script. Add a guarded eval to your shell rc file:
 
 ```sh
 # zsh — ~/.zshrc
-eval "$(vland completion zsh)"
+command -v vland >/dev/null 2>&1 && eval "$(vland completion zsh 2>/dev/null)"
 
 # bash — ~/.bashrc
-eval "$(vland completion bash)"
+command -v vland >/dev/null 2>&1 && eval "$(vland completion bash 2>/dev/null)"
 
 # fish — ~/.config/fish/config.fish
-vland completion fish | source
+command -v vland >/dev/null 2>&1; and vland completion fish 2>/dev/null | source
 ```
 
+The `command -v` guard skips the line when no `vland` is on `PATH`. The `2>/dev/null` covers a mise shim with no active version: it passes the guard, then fails on stderr. If completion doesn't load, run `vland completion zsh` by hand to see why.
+
 **Prerequisite:** the [`usage`](https://usage.jdx.dev) CLI must be on your `PATH` (it powers completion at runtime). Install via one of:
 
 ```sh

package/dist/cli.usage.kdl

@@ -1,11 +1,11 @@
 // @generated by @usage-spec/commander from Commander.js metadata
 name vland
 bin vland
-version "0.3.6"
+version "0.3.8-git-fdf054c.0"
 usage "[options] [command]"
 flag --usage help="print KDL spec for this CLI (https://kdl.dev)"
 cmd completion help="print shell completion script (usage)" {
-	long_help "Prints a shell completion script for vland. Add to your shell rc file:\n\n  bash: eval \"$(vland completion bash)\"\n  zsh:  eval \"$(vland completion zsh)\"\n  fish: vland completion fish | source"
+	long_help "Prints a shell completion script for vland. Add your shell's line to its rc file:\n\n    # bash — ~/.bashrc\n    command -v vland >/dev/null 2>&1 && eval \"$(vland completion bash 2>/dev/null)\"\n\n    # zsh — ~/.zshrc\n    command -v vland >/dev/null 2>&1 && eval \"$(vland completion zsh 2>/dev/null)\"\n\n    # fish — ~/.config/fish/config.fish\n    command -v vland >/dev/null 2>&1; and vland completion fish 2>/dev/null | source"
 	arg <shell> help="target shell" {
 		choices bash zsh fish
 	}

package/dist/run.mjs

@@ -56,11 +56,16 @@ const SHELLS = [
 	"fish"
 ];
 function createCompletionCommand() {
-	return createCommand("completion").summary(`print shell completion script (${TOOL_LABELS.USAGE})`).description(`Prints a shell completion script for vland. Add to your shell rc file:
+	return createCommand("completion").summary(`print shell completion script (${TOOL_LABELS.USAGE})`).description(`Prints a shell completion script for vland. Add your shell's line to its rc file:
 
-  bash: eval "$(vland completion bash)"
-  zsh:  eval "$(vland completion zsh)"
-  fish: vland completion fish | source`).addArgument(new Argument("<shell>", `target shell`).choices(SHELLS)).addHelpText("afterAll", `\nUnder the hood, this command uses ${TOOL_LABELS.USAGE} (https://usage.jdx.dev).
+    # bash — ~/.bashrc
+    command -v vland >/dev/null 2>&1 && eval "$(vland completion bash 2>/dev/null)"
+
+    # zsh — ~/.zshrc
+    command -v vland >/dev/null 2>&1 && eval "$(vland completion zsh 2>/dev/null)"
+
+    # fish — ~/.config/fish/config.fish
+    command -v vland >/dev/null 2>&1; and vland completion fish 2>/dev/null | source`).configureHelp({ helpWidth: Number.POSITIVE_INFINITY }).addArgument(new Argument("<shell>", `target shell`).choices(SHELLS)).addHelpText("afterAll", `\nUnder the hood, this command uses ${TOOL_LABELS.USAGE} (https://usage.jdx.dev).
 Make sure to have it installed and available in your PATH.`);
 }
 //#endregion
@@ -94,6 +99,15 @@ const LIBRARY_SCOPES = {
 	private: "@variableland",
 	public: "@variablelab"
 };
+/**
+* The GitHub owner of a project's repository, indexed by visibility: public
+* projects live in the open-source `withvariablelab` org, private ones in
+* `variableland`.
+*/
+const GITHUB_OWNERS = {
+	private: "variableland",
+	public: "withvariablelab"
+};
 const GITHUB_SOURCE = "github:withvariablelab/dx";
 const GITHUB_REF = "main";
 /**
@@ -197,7 +211,7 @@ async function walk(root, onFile) {
 	}));
 }
 function applyPlaceholders(content, values) {
-	return content.replaceAll("{{projectName}}", values.projectName).replaceAll("{{author}}", values.author).replaceAll("{{year}}", values.year);
+	return content.replaceAll("{{projectName}}", values.projectName).replaceAll("{{author}}", values.author).replaceAll("{{year}}", values.year).replaceAll("{{packageName}}", values.packageName).replaceAll("{{githubOwner}}", values.githubOwner);
 }
 async function replacePlaceholders(rootDir, values) {
 	const debug = logger.subdebug("placeholders");
@@ -216,30 +230,29 @@ async function replacePlaceholders(rootDir, values) {
 	return { touched };
 }
 /**
-* Writes the root `package.json`'s `name` and `private` fields based on the
-* chosen template and visibility. Uses `pkg-types` so field ordering and
-* JSON formatting survive.
-*
-* Naming rules:
-* - `library` private → `@variableland/<projectName>`, `private: true`
+* The root package's name:
+* - `library` private → `@variableland/<projectName>`
 * - `library` public  → `@variablelab/<projectName>`
-* - `backend`         → `<projectName>`, `private: true`
-* - `monorepo`        → `<projectName>`, `private: true` (root never publishes)
+* - `backend`, `monorepo` → `<projectName>`
+*/
+function rootPackageName({ template, projectName, visibility }) {
+	return template === "library" ? `${LIBRARY_SCOPES[visibility ?? "public"]}/${projectName}` : projectName;
+}
+/**
+* Writes the root `package.json`'s `name` ({@link rootPackageName}) and
+* `private` fields based on the chosen template and visibility. Uses
+* `pkg-types` so field ordering and JSON formatting survive. `private: true`
+* goes on a private library and on every backend and monorepo root, which
+* never publishes.
 */
 async function applyRootPackage(rootDir, options) {
 	const debug = logger.subdebug("apply-root-package");
 	const pkg = await createPkg(fs.realpathSync(rootDir));
 	if (!pkg) throw new Error("Could not find package.json");
-	const { template, projectName, visibility } = options;
+	const { template, visibility } = options;
 	try {
-		if (template === "library") {
-			const scope = LIBRARY_SCOPES[visibility ?? "public"];
-			pkg.packageJson.name = `${scope}/${projectName}`;
-			if (visibility === "private") pkg.packageJson.private = true;
-		} else {
-			pkg.packageJson.name = projectName;
-			pkg.packageJson.private = true;
-		}
+		pkg.packageJson.name = rootPackageName(options);
+		if (template !== "library" || visibility === "private") pkg.packageJson.private = true;
 		await pkg.write(pkg.packageJson);
 	} catch (error) {
 		debug("skipped %s", error);
@@ -264,7 +277,12 @@ async function isDirEmpty(dir) {
 		throw error;
 	}
 }
-async function readGitAuthor(shell) {
+const FALLBACK_GIT_IDENTITY = {
+	name: "vland",
+	email: "noreply@variable.land"
+};
+/** The `user.name` and `user.email` git resolves from the shell's cwd. Each is empty when unset. */
+async function readGitIdentity(shell) {
 	try {
 		const [name, email] = await Promise.all([shell.runCaptured("git", [
 			"config",
@@ -275,14 +293,31 @@ async function readGitAuthor(shell) {
 			"--get",
 			"user.email"
 		], { throwOnError: false })]);
-		const trimmedName = name.stdout.trim();
-		const trimmedEmail = email.stdout.trim();
-		if (!trimmedName) return void 0;
-		return trimmedEmail ? `${trimmedName} <${trimmedEmail}>` : trimmedName;
+		return {
+			name: name.stdout.trim(),
+			email: email.stdout.trim()
+		};
 	} catch {
-		return;
+		return {
+			name: "",
+			email: ""
+		};
 	}
 }
+async function readGitAuthor(shell) {
+	const { name, email } = await readGitIdentity(shell);
+	if (!name) return void 0;
+	return email ? `${name} <${email}>` : name;
+}
+/**
+* `-c` flags that fill in only the half of the identity git can't resolve. A
+* configured identity is left alone, so `commit.gpgsign` signs with the user's
+* own email.
+*/
+async function gitIdentityFallbackArgs(shell) {
+	const { name, email } = await readGitIdentity(shell);
+	return [...name ? [] : ["-c", `user.name=${FALLBACK_GIT_IDENTITY.name}`], ...email ? [] : ["-c", `user.email=${FALLBACK_GIT_IDENTITY.email}`]];
+}
 function abort(message) {
 	cancel(message);
 	process.exit(1);
@@ -368,7 +403,13 @@ async function runInit(ctx, options) {
 	await replacePlaceholders(dir, {
 		projectName: name,
 		author,
-		year: (/* @__PURE__ */ new Date()).getFullYear().toString()
+		year: (/* @__PURE__ */ new Date()).getFullYear().toString(),
+		packageName: rootPackageName({
+			template,
+			projectName: name,
+			visibility
+		}),
+		githubOwner: GITHUB_OWNERS[template === "library" ? visibility ?? "public" : "private"]
 	});
 	await applyRootPackage(dir, {
 		template,
@@ -378,6 +419,13 @@ async function runInit(ctx, options) {
 	placeholderSpin.stop("Placeholders applied");
 	const shouldInstall = await resolveYesNo(options.install, "Install dependencies?");
 	const shouldGit = await resolveYesNo(options.git, "Initialise a git repository?");
+	const gitShell = shell.at(dir);
+	let gitInitError;
+	if (shouldGit) try {
+		await gitShell.runCaptured("git", ["init"]);
+	} catch (error) {
+		gitInitError = error;
+	}
 	if (shouldInstall) {
 		const installSpin = spinner();
 		installSpin.start(`Installing dependencies with ${palette.highlight(PACKAGE_MANAGER)}`);
@@ -401,16 +449,13 @@ async function runInit(ctx, options) {
 		const gitSpin = spinner();
 		gitSpin.start("Initialising git repository");
 		try {
-			const gitShell = shell.at(dir).child({ env: {
-				GIT_AUTHOR_NAME: process.env.GIT_AUTHOR_NAME ?? "vland",
-				GIT_AUTHOR_EMAIL: process.env.GIT_AUTHOR_EMAIL ?? "noreply@variable.land",
-				GIT_COMMITTER_NAME: process.env.GIT_COMMITTER_NAME ?? "vland",
-				GIT_COMMITTER_EMAIL: process.env.GIT_COMMITTER_EMAIL ?? "noreply@variable.land"
-			} });
-			await gitShell.runCaptured("git", ["init"]);
+			if (gitInitError) throw gitInitError;
 			await gitShell.runCaptured("git", ["add", "-A"]);
+			const identityArgs = await gitIdentityFallbackArgs(gitShell);
 			await gitShell.runCaptured("git", [
+				...identityArgs,
 				"commit",
+				"--no-verify",
 				"-m",
 				"chore: initial commit from vland"
 			]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@variablelab/vland",
-  "version": "0.3.6",
+  "version": "0.3.8-git-fdf054c.0",
   "description": "The CLI to init a new project in Variable Land",
   "homepage": "https://github.com/withvariablelab/dx/tree/main/vland/cli#readme",
   "bugs": {
@@ -35,8 +35,8 @@
     "commander": "14.0.3",
     "giget": "2.0.0",
     "nypm": "0.6.0",
-    "@variablelab/clibuddy": "0.7.4",
-    "@variablelab/loggy": "0.2.3"
+    "@variablelab/loggy": "0.2.3",
+    "@variablelab/clibuddy": "0.7.4"
   },
   "publishConfig": {
     "access": "public"

package/src/actions/init.ts

@@ -5,8 +5,8 @@ import { hasTTY, palette } from "@variablelab/clibuddy";
 import { installDependencies } from "nypm";
 import type { Context } from "#src/services/ctx.ts";
 import { logger } from "#src/services/logger.ts";
-import { applyRootPackage, replacePlaceholders } from "./placeholders.ts";
-import { fetchTemplate, TEMPLATE_META, TEMPLATES, type TemplateName, type Visibility } from "./template.ts";
+import { applyRootPackage, replacePlaceholders, rootPackageName } from "./placeholders.ts";
+import { fetchTemplate, GITHUB_OWNERS, TEMPLATE_META, TEMPLATES, type TemplateName, type Visibility } from "./template.ts";
 
 export type InitOptions = {
   name?: string;
@@ -45,21 +45,42 @@ async function isDirEmpty(dir: string): Promise<boolean> {
   }
 }
 
-async function readGitAuthor(shell: Context["shell"]): Promise<string | undefined> {
+type GitIdentity = { name: string; email: string };
+
+const FALLBACK_GIT_IDENTITY: GitIdentity = { name: "vland", email: "noreply@variable.land" };
+
+/** The `user.name` and `user.email` git resolves from the shell's cwd. Each is empty when unset. */
+async function readGitIdentity(shell: Context["shell"]): Promise<GitIdentity> {
   try {
     const [name, email] = await Promise.all([
       shell.runCaptured("git", ["config", "--get", "user.name"], { throwOnError: false }),
       shell.runCaptured("git", ["config", "--get", "user.email"], { throwOnError: false }),
     ]);
-    const trimmedName = name.stdout.trim();
-    const trimmedEmail = email.stdout.trim();
-    if (!trimmedName) return undefined;
-    return trimmedEmail ? `${trimmedName} <${trimmedEmail}>` : trimmedName;
+    return { name: name.stdout.trim(), email: email.stdout.trim() };
   } catch {
-    return undefined;
+    return { name: "", email: "" };
   }
 }
 
+async function readGitAuthor(shell: Context["shell"]): Promise<string | undefined> {
+  const { name, email } = await readGitIdentity(shell);
+  if (!name) return undefined;
+  return email ? `${name} <${email}>` : name;
+}
+
+/**
+ * `-c` flags that fill in only the half of the identity git can't resolve. A
+ * configured identity is left alone, so `commit.gpgsign` signs with the user's
+ * own email.
+ */
+async function gitIdentityFallbackArgs(shell: Context["shell"]): Promise<string[]> {
+  const { name, email } = await readGitIdentity(shell);
+  return [
+    ...(name ? [] : ["-c", `user.name=${FALLBACK_GIT_IDENTITY.name}`]),
+    ...(email ? [] : ["-c", `user.email=${FALLBACK_GIT_IDENTITY.email}`]),
+  ];
+}
+
 function abort(message: string): never {
   cancel(message);
   process.exit(1);
@@ -167,6 +188,9 @@ export async function runInit(ctx: Context, options: InitOptions) {
     projectName: name,
     author,
     year: new Date().getFullYear().toString(),
+    packageName: rootPackageName({ template, projectName: name, visibility }),
+    // Only a library picks its visibility: backend and monorepo roots are always private.
+    githubOwner: GITHUB_OWNERS[template === "library" ? (visibility ?? "public") : "private"],
   });
   await applyRootPackage(dir, { template, projectName: name, visibility });
   placeholderSpin.stop("Placeholders applied");
@@ -174,6 +198,17 @@ export async function runInit(ctx: Context, options: InitOptions) {
   const shouldInstall = await resolveYesNo(options.install, "Install dependencies?");
   const shouldGit = await resolveYesNo(options.git, "Initialise a git repository?");
 
+  const gitShell = shell.at(dir);
+  let gitInitError: unknown;
+  if (shouldGit) {
+    // Before the install, so a postinstall that sets up git hooks (lefthook's) finds the repo.
+    try {
+      await gitShell.runCaptured("git", ["init"]);
+    } catch (error) {
+      gitInitError = error;
+    }
+  }
+
   if (shouldInstall) {
     const installSpin = spinner();
     installSpin.start(`Installing dependencies with ${palette.highlight(PACKAGE_MANAGER)}`);
@@ -197,17 +232,12 @@ export async function runInit(ctx: Context, options: InitOptions) {
     const gitSpin = spinner();
     gitSpin.start("Initialising git repository");
     try {
-      const gitShell = shell.at(dir).child({
-        env: {
-          GIT_AUTHOR_NAME: process.env.GIT_AUTHOR_NAME ?? "vland",
-          GIT_AUTHOR_EMAIL: process.env.GIT_AUTHOR_EMAIL ?? "noreply@variable.land",
-          GIT_COMMITTER_NAME: process.env.GIT_COMMITTER_NAME ?? "vland",
-          GIT_COMMITTER_EMAIL: process.env.GIT_COMMITTER_EMAIL ?? "noreply@variable.land",
-        },
-      });
-      await gitShell.runCaptured("git", ["init"]);
+      if (gitInitError) throw gitInitError;
       await gitShell.runCaptured("git", ["add", "-A"]);
-      await gitShell.runCaptured("git", ["commit", "-m", "chore: initial commit from vland"]);
+      // Read after `git init`, so an `includeIf "gitdir:…"` identity for the new repo applies.
+      const identityArgs = await gitIdentityFallbackArgs(gitShell);
+      // --no-verify: the hooks the install just set up are for the user's commits, not the template as generated.
+      await gitShell.runCaptured("git", [...identityArgs, "commit", "--no-verify", "-m", "chore: initial commit from vland"]);
       gitSpin.stop("Initialised git repository");
     } catch (error) {
       gitSpin.stop("Failed to initialise git", 1);

package/src/actions/placeholders.ts

@@ -9,6 +9,8 @@ export type Placeholders = {
   projectName: string;
   author: string;
   year: string;
+  packageName: string;
+  githubOwner: string;
 };
 
 const TEXT_EXTENSIONS = new Set([
@@ -86,7 +88,9 @@ function applyPlaceholders(content: string, values: Placeholders) {
   return content
     .replaceAll("{{projectName}}", values.projectName)
     .replaceAll("{{author}}", values.author)
-    .replaceAll("{{year}}", values.year);
+    .replaceAll("{{year}}", values.year)
+    .replaceAll("{{packageName}}", values.packageName)
+    .replaceAll("{{githubOwner}}", values.githubOwner);
 }
 
 export async function replacePlaceholders(rootDir: string, values: Placeholders) {
@@ -119,15 +123,21 @@ export type ApplyRootPackageOptions = {
 };
 
 /**
- * Writes the root `package.json`'s `name` and `private` fields based on the
- * chosen template and visibility. Uses `pkg-types` so field ordering and
- * JSON formatting survive.
- *
- * Naming rules:
- * - `library` private → `@variableland/<projectName>`, `private: true`
+ * The root package's name:
+ * - `library` private → `@variableland/<projectName>`
  * - `library` public  → `@variablelab/<projectName>`
- * - `backend`         → `<projectName>`, `private: true`
- * - `monorepo`        → `<projectName>`, `private: true` (root never publishes)
+ * - `backend`, `monorepo` → `<projectName>`
+ */
+export function rootPackageName({ template, projectName, visibility }: ApplyRootPackageOptions): string {
+  return template === "library" ? `${LIBRARY_SCOPES[visibility ?? "public"]}/${projectName}` : projectName;
+}
+
+/**
+ * Writes the root `package.json`'s `name` ({@link rootPackageName}) and
+ * `private` fields based on the chosen template and visibility. Uses
+ * `pkg-types` so field ordering and JSON formatting survive. `private: true`
+ * goes on a private library and on every backend and monorepo root, which
+ * never publishes.
  */
 export async function applyRootPackage(rootDir: string, options: ApplyRootPackageOptions) {
   const debug = logger.subdebug("apply-root-package");
@@ -136,18 +146,11 @@ export async function applyRootPackage(rootDir: string, options: ApplyRootPackag
   const pkg = await createPkg(rootPath);
   if (!pkg) throw new Error("Could not find package.json");
 
-  const { template, projectName, visibility } = options;
+  const { template, visibility } = options;
 
   try {
-    if (template === "library") {
-      const scope = LIBRARY_SCOPES[visibility ?? "public"];
-      pkg.packageJson.name = `${scope}/${projectName}`;
-      if (visibility === "private") {
-        pkg.packageJson.private = true;
-      }
-    } else {
-      // backend + monorepo: bare project name, private root.
-      pkg.packageJson.name = projectName;
+    pkg.packageJson.name = rootPackageName(options);
+    if (template !== "library" || visibility === "private") {
       pkg.packageJson.private = true;
     }
     await pkg.write(pkg.packageJson);

package/src/actions/template.ts

@@ -25,6 +25,16 @@ export const LIBRARY_SCOPES: Record<Visibility, string> = {
   public: "@variablelab",
 };
 
+/**
+ * The GitHub owner of a project's repository, indexed by visibility: public
+ * projects live in the open-source `withvariablelab` org, private ones in
+ * `variableland`.
+ */
+export const GITHUB_OWNERS: Record<Visibility, string> = {
+  private: "variableland",
+  public: "withvariablelab",
+};
+
 const GITHUB_SOURCE = "github:withvariablelab/dx";
 const GITHUB_REF = "main";
 

package/src/program/commands/completion.ts

@@ -11,12 +11,21 @@ export function createCompletionCommand() {
   return createCommand("completion")
     .summary(`print shell completion script (${TOOL_LABELS.USAGE})`)
     .description(
-      `Prints a shell completion script for vland. Add to your shell rc file:
+      `Prints a shell completion script for vland. Add your shell's line to its rc file:
 
-  bash: eval "$(vland completion bash)"
-  zsh:  eval "$(vland completion zsh)"
-  fish: vland completion fish | source`,
+    # bash — ~/.bashrc
+    command -v vland >/dev/null 2>&1 && eval "$(vland completion bash 2>/dev/null)"
+
+    # zsh — ~/.zshrc
+    command -v vland >/dev/null 2>&1 && eval "$(vland completion zsh 2>/dev/null)"
+
+    # fish — ~/.config/fish/config.fish
+    command -v vland >/dev/null 2>&1; and vland completion fish 2>/dev/null | source`,
     )
+    .configureHelp({
+      // Commander hard-wraps help at the terminal width; a wrapped rc line breaks when pasted.
+      helpWidth: Number.POSITIVE_INFINITY,
+    })
     .addArgument(new Argument("<shell>", `target shell`).choices(SHELLS))
     .addHelpText(
       "afterAll",