feat: use a BREWLOCK env variable to locate your brew.lock

Author: lott-ai

README.md

@@ -20,7 +20,7 @@
 ### Homebrew (recommended)
 
 ```bash
-brew tap shipworthyai/brewlock
+brew tap shipworthyai/brewlock https://github.com/ShipWorthyAI/brewlock.git
 brew install brewlock
 ```
 
@@ -66,7 +66,7 @@ After adding the alias, restart your shell or run `source ~/.zshrc` (or equivale
 
 ```bash
 # Install brewlock
-brew tap shipworthyai/brewlock
+brew tap shipworthyai/brewlock https://github.com/ShipWorthyAI/brewlock.git
 brew install brewlock
 
 # Set up the alias (add to your ~/.zshrc)
@@ -111,7 +111,11 @@ brew bundle install    # Installs from brew.lock with version checking
 ### Syncing Across Machines
 
 ```bash
-# On your main machine: commit your brew.lock to your dotfiles
+# Option 1: Point BREWLOCK directly to your dotfiles (recommended)
+# Add to your shell config (~/.zshrc or ~/.bashrc):
+export BREWLOCK="$HOME/dotfiles/brew.lock"
+
+# Option 2: Copy (or symlink) the lock file to your dotfiles
 cp ~/brew.lock ~/dotfiles/
 cd ~/dotfiles && git add brew.lock && git commit -m "Update brew.lock"
 
@@ -122,7 +126,17 @@ brew bundle install
 
 ## The `brew.lock` File
 
-The lock file is stored at `~/brew.lock` (in your home directory) and uses standard Brewfile syntax with added version information:
+By default, the lock file is stored at `~/brew.lock` (in your home directory). You can customize this location using the `BREWLOCK` environment variable:
+
+```bash
+# Set a custom lock file path
+export BREWLOCK=/path/to/your/brew.lock
+
+# Example: Store in your dotfiles repo
+export BREWLOCK="$HOME/dotfiles/brew.lock"
+```
+
+The lock file uses standard Brewfile syntax with added version information:
 
 ```ruby
 # brewlock v1

package.json

@@ -1,6 +1,6 @@
 {
   "name": "brewlock",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "module": "src/index.ts",
   "type": "module",
   "bin": {

src/index.ts

@@ -11,8 +11,8 @@ import { bundleInstall } from "./bundle-install.ts";
 import { executeBrewCommandStreaming } from "./executor.ts";
 import {
   checkLockFile,
-  DEFAULT_LOCK_FILE,
   generateLockFile,
+  getLockFilePath,
   readLockFile,
   removeEntry,
   upsertEntry,
@@ -28,6 +28,7 @@ export {
   checkLockFile,
   DEFAULT_LOCK_FILE,
   generateLockFile,
+  getLockFilePath,
   parseLockFile,
   readLockFile,
   removeEntry,
@@ -97,6 +98,10 @@ EXAMPLES:
   brewlock check             Verify installed versions match brew.lock
   brewlock bundle install    Install from Brewfile using version constraints
 
+ENVIRONMENT VARIABLES:
+  BREWLOCK     Path to the lock file (default: ~/brew.lock)
+               Example: export BREWLOCK=/path/to/your/brew.lock
+
 FILES:
   brew.lock    Lock file in Brewfile format with version information
 `);
@@ -108,10 +113,11 @@ FILES:
 async function handleLock(): Promise<void> {
   console.log("Generating brew.lock from installed packages...");
 
+  const lockFilePath = getLockFilePath();
   const lockFile = await generateLockFile();
-  await writeLockFile(lockFile, DEFAULT_LOCK_FILE);
+  await writeLockFile(lockFile, lockFilePath);
 
-  console.log(`\nGenerated ${DEFAULT_LOCK_FILE} with:`);
+  console.log(`\nGenerated ${lockFilePath} with:`);
   console.log(
     `  - ${lockFile.entries.filter((e) => e.type === "tap").length} taps`
   );
@@ -132,7 +138,7 @@ async function handleLock(): Promise<void> {
 async function handleCheck(): Promise<void> {
   console.log("Checking installed packages against brew.lock...");
 
-  const result = await checkLockFile(DEFAULT_LOCK_FILE);
+  const result = await checkLockFile(getLockFilePath());
 
   if (result.matches) {
     console.log("\n✓ All installed packages match brew.lock");
@@ -155,7 +161,8 @@ async function updateLockFile(
   packages: string[],
   isCask: boolean
 ): Promise<void> {
-  let lockFile = await readLockFile(DEFAULT_LOCK_FILE);
+  const lockFilePath = getLockFilePath();
+  let lockFile = await readLockFile(lockFilePath);
   const type: PackageType = isCask ? "cask" : "brew";
 
   if (
@@ -203,7 +210,7 @@ async function updateLockFile(
     }
   }
 
-  await writeLockFile(lockFile, DEFAULT_LOCK_FILE);
+  await writeLockFile(lockFile, lockFilePath);
 }
 
 /**
@@ -215,7 +222,7 @@ async function handleBundleInstall(): Promise<boolean> {
   );
 
   const success = await bundleInstall({
-    lockFilePath: DEFAULT_LOCK_FILE,
+    lockFilePath: getLockFilePath(),
     verbose: true,
   });
 

src/lock-manager.ts

@@ -17,6 +17,18 @@ import {
 /** Default lock file path */
 export const DEFAULT_LOCK_FILE = join(homedir(), "brew.lock");
 
+/**
+ * Get the lock file path, checking the BREWLOCK environment variable first.
+ * Falls back to DEFAULT_LOCK_FILE if not set.
+ */
+export function getLockFilePath(): string {
+  const envPath = process.env.BREWLOCK;
+  if (envPath) {
+    return envPath;
+  }
+  return DEFAULT_LOCK_FILE;
+}
+
 /** Lock file format version */
 const LOCK_VERSION = 1;