just-git 0.1.1 → 0.1.3

package/README.md

@@ -15,12 +15,12 @@ import { Bash } from "just-bash";
 import { createGit } from "just-git";
 
 const git = createGit({
-	identity: { name: "Alice", email: "alice@example.com" },
+  identity: { name: "Alice", email: "alice@example.com" },
 });
 
 const bash = new Bash({
-	cwd: "/repo",
-	customCommands: [git],
+  cwd: "/repo",
+  customCommands: [git],
 });
 
 await bash.exec("git init");
@@ -43,10 +43,10 @@ await bash.exec("git log --oneline");
 
 ```ts
 const git = createGit({
-	identity: { name: "Agent Bot", email: "bot@company.com", locked: true },
-	credentials: async (url) => ({ type: "bearer", token: "ghp_..." }),
-	disabled: ["rebase"],
-	network: { allowed: ["github.com"] },
+  identity: { name: "Agent Bot", email: "bot@company.com", locked: true },
+  credentials: async (url) => ({ type: "bearer", token: "ghp_..." }),
+  disabled: ["rebase"],
+  network: { allowed: ["github.com"] },
 });
 ```
 
@@ -59,31 +59,31 @@ The `CommandEvent` provides the execution context: `{ command, rawArgs, fs, cwd,
 ```ts
 // Audit log — record every command the agent runs
 git.use(async (event, next) => {
-	const result = await next();
-	auditLog.push({ command: `git ${event.command}`, exitCode: result.exitCode });
-	return result;
+  const result = await next();
+  auditLog.push({ command: `git ${event.command}`, exitCode: result.exitCode });
+  return result;
 });
 
 // Gate pushes on human approval
 git.use(async (event, next) => {
-	if (event.command === "push" && !(await getHumanApproval(event.rawArgs))) {
-		return { stdout: "", stderr: "Push blocked — awaiting approval.\n", exitCode: 1 };
-	}
-	return next();
+  if (event.command === "push" && !(await getHumanApproval(event.rawArgs))) {
+    return { stdout: "", stderr: "Push blocked — awaiting approval.\n", exitCode: 1 };
+  }
+  return next();
 });
 
 // Block commits that add large files (uses event.fs to read the worktree)
 git.use(async (event, next) => {
-	if (event.command === "add") {
-		for (const path of event.rawArgs.filter((a) => !a.startsWith("-"))) {
-			const resolved = path.startsWith("/") ? path : `${event.cwd}/${path}`;
-			const stat = await event.fs.stat(resolved).catch(() => null);
-			if (stat && stat.size > 5_000_000) {
-				return { stdout: "", stderr: `Blocked: ${path} exceeds 5 MB\n`, exitCode: 1 };
-			}
-		}
-	}
-	return next();
+  if (event.command === "add") {
+    for (const path of event.rawArgs.filter((a) => !a.startsWith("-"))) {
+      const resolved = path.startsWith("/") ? path : `${event.cwd}/${path}`;
+      const stat = await event.fs.stat(resolved).catch(() => null);
+      if (stat && stat.size > 5_000_000) {
+        return { stdout: "", stderr: `Blocked: ${path} exceeds 5 MB\n`, exitCode: 1 };
+      }
+    }
+  }
+  return next();
 });
 ```
 
@@ -100,17 +100,17 @@ Pre-hooks can abort the operation by returning `{ abort: true, message? }`.
 ```ts
 // Block secrets from being committed
 git.on("pre-commit", (event) => {
-	const forbidden = event.index.entries.filter((e) => /\.(env|pem|key)$/.test(e.path));
-	if (forbidden.length) {
-		return { abort: true, message: `Blocked: ${forbidden.map((e) => e.path).join(", ")}` };
-	}
+  const forbidden = event.index.entries.filter((e) => /\.(env|pem|key)$/.test(e.path));
+  if (forbidden.length) {
+    return { abort: true, message: `Blocked: ${forbidden.map((e) => e.path).join(", ")}` };
+  }
 });
 
 // Enforce conventional commit messages
 git.on("commit-msg", (event) => {
-	if (!/^(feat|fix|docs|refactor|test|chore)(\(.+\))?:/.test(event.message)) {
-		return { abort: true, message: "Commit message must follow conventional commits format" };
-	}
+  if (!/^(feat|fix|docs|refactor|test|chore)(\(.+\))?:/.test(event.message)) {
+    return { abort: true, message: "Commit message must follow conventional commits format" };
+  }
 });
 ```
 
@@ -140,11 +140,11 @@ Post-hooks are observational -- return value is ignored. Handlers are awaited in
 ```ts
 // Feed agent activity to your UI or orchestration layer
 git.on("post-commit", (event) => {
-	onAgentCommit({ hash: event.hash, branch: event.branch, message: event.message });
+  onAgentCommit({ hash: event.hash, branch: event.branch, message: event.message });
 });
 
 git.on("post-push", (event) => {
-	onAgentPush({ remote: event.remote, refs: event.refs });
+  onAgentPush({ remote: event.remote, refs: event.refs });
 });
 ```
 
@@ -233,7 +233,7 @@ Fire-and-forget events emitted on every object/ref write. Handler errors are cau
 
 High fidelity to real git (2.53.0) state and output. Tested using real git as an [oracle](test/oracle/README.md) across hundreds of randomized command traces.
 
-If you're running just-bash over a real filesystem, mixing commands between this implementation and real git in the same repo has not been extensively tested yet.
+This library is not yet interoperable with real git on the same filesystem (e.g. if you're using just-bash backed by a real filesystem where real git is also used to interact with repos). Interoperability happens at the network layer — clone, fetch, and push speak the Smart HTTP protocol and exchange standard packfiles. The internal `.git` directory layout is not guaranteed to be compatible with real git.
 
 ## Disclaimer
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "just-git",
-	"version": "0.1.1",
+	"version": "0.1.3",
 	"description": "Git implementation for virtual bash environments. Pure TypeScript, zero dependencies.",
 	"keywords": [
 		"agent",
@@ -15,7 +15,7 @@
 	"author": "blindmansion",
 	"repository": {
 		"type": "git",
-		"url": "https://github.com/blindmansion/just-git.git"
+		"url": "git+https://github.com/blindmansion/just-git.git"
 	},
 	"files": [
 		"dist"