@pnpm/store-path

import { getStorePath } from "@pnpm/store-path";

const { getStorePath } = require("@pnpm/store-path");

import { getStorePath } from "@pnpm/store-path";

// Resolve store path with explicit location
const storePath = getStorePath({
  pkgRoot: "/home/user/my-project",
  storePath: "/custom/pnpm-store",
  pnpmHomeDir: "/home/user/.local/share/pnpm"
});
// Returns: "/custom/pnpm-store/v10"

// Resolve optimal store path based on filesystem capabilities
const optimalPath = await getStorePath({
  pkgRoot: "/home/user/my-project", 
  pnpmHomeDir: "/home/user/.local/share/pnpm"
});
// Returns: Promise<string> - optimal location based on hard linking support

/**
 * Resolves the optimal pnpm store path based on filesystem capabilities
 * @param options - Configuration options for store path resolution
 * @returns Store path string (sync) or Promise<string> (async when optimization needed)
 * @throws PnpmError with code 'NO_PNPM_HOME_DIR' when pnpmHomeDir is undefined and storePath not provided
 */
function getStorePath(options: GetStorePathOptions): string | Promise<string>;

interface GetStorePathOptions {
  /** Root directory of the package/project */
  pkgRoot: string;
  /** 
   * Optional explicit store path - can be absolute or home-relative (~/path)
   * When provided, skips filesystem optimization and uses this path directly
   */
  storePath?: string;
  /** 
   * Pnpm home directory for fallback store location
   * Required when storePath is not provided
   */
  pnpmHomeDir: string;
}

import { getStorePath } from "@pnpm/store-path";

// Explicit absolute store path
const explicitPath = getStorePath({
  pkgRoot: "/home/user/project",
  storePath: "/var/cache/pnpm",
  pnpmHomeDir: "/home/user/.local/share/pnpm"
});
// Returns: "/var/cache/pnpm/v10" (synchronous)

// Home-relative store path
const homePath = getStorePath({
  pkgRoot: "/home/user/project", 
  storePath: "~/custom-store",
  pnpmHomeDir: "/home/user/.local/share/pnpm"
});
// Returns: "/home/user/custom-store/v10" (synchronous)

// Optimized store path (filesystem linking detection)
const optimizedPath = await getStorePath({
  pkgRoot: "/mnt/external/project",
  pnpmHomeDir: "/home/user/.local/share/pnpm"
});
// Returns: Promise<string> - optimal location after testing hard linking capabilities

// Error handling
try {
  getStorePath({
    pkgRoot: "/some/project",
    pnpmHomeDir: undefined // This will throw an error
  });
} catch (error) {
  console.log(error.code); // 'NO_PNPM_HOME_DIR'
}

// Error thrown when pnpmHomeDir is not provided and storePath is undefined
interface PnpmError extends Error {
  code: 'NO_PNPM_HOME_DIR';
  message: 'The pnpm home directory is unknown. Cannot calculate the store directory location.';
}