Add more bun/pnpm/vlt/yarn constants

Author: jdalton

registry/lib/constants/bun-cache-path.d.ts

@@ -0,0 +1,2 @@
+declare const bunCachePath: string
+export = bunCachePath

registry/lib/constants/bun-cache-path.js

@@ -0,0 +1,42 @@
+'use strict'
+
+const path = require('node:path')
+const ENV = /*@__PURE__*/ require('./env')
+const WIN32 = /*@__PURE__*/ require('./win32')
+
+// Bun cache directory path.
+// Bun stores its cache in a platform-specific location.
+//
+// Default locations:
+// - macOS: ~/Library/Caches/bun
+// - Linux: ~/.bun/install/cache
+// - Windows: %TEMP%/bun
+//
+// Can be overridden by:
+// - BUN_INSTALL_CACHE_DIR environment variable
+// - cache.dir setting in bunfig.toml
+//
+// Documentation: https://bun.sh/docs/runtime/bunfig#cache-dir
+function getBunCachePath() {
+  // Check for explicit BUN_INSTALL_CACHE_DIR environment variable.
+  const bunCacheDir = process.env.BUN_INSTALL_CACHE_DIR
+  if (bunCacheDir) {
+    return bunCacheDir
+  }
+
+  if (WIN32) {
+    // On Windows, Bun uses TEMP directory.
+    const temp = process.env.TEMP || process.env.TMP
+    return temp ? path.join(temp, 'bun') : ''
+  }
+
+  // On macOS, use Library/Caches.
+  if (process.platform === 'darwin' && ENV.HOME) {
+    return path.join(ENV.HOME, 'Library', 'Caches', 'bun')
+  }
+
+  // On Linux/Unix, use ~/.bun/install/cache.
+  return ENV.HOME ? path.join(ENV.HOME, '.bun', 'install', 'cache') : ''
+}
+
+module.exports = getBunCachePath()

registry/lib/constants/index.d.ts

@@ -3,6 +3,7 @@ import abortSignal from './abort-signal'
 import AT_LATEST from './at-latest'
 import BIOME_JSON from './biome-json'
 import BUN from './bun'
+import bunCachePath from './bun-cache-path'
 import BUN_LOCK from './bun-lock'
 import BUN_LOCKB from './bun-lockb'
 import CI from './ci'
@@ -60,6 +61,7 @@ import nodeNoWarningsFlags from './node-no-warnings-flags'
 import NODE_VERSION from './node-version'
 import NPM from './npm'
 import npmExecPath from './npm-exec-path'
+import npmLifecycleEvent from './npm-lifecycle-event'
 import npmRealExecPath from './npm-real-exec-path'
 import NPM_SHRINKWRAP_JSON from './npm-shrinkwrap-json'
 import NPX from './npx'
@@ -70,11 +72,13 @@ import PACKAGE_DEFAULT_VERSION from './package-default-version'
 import packageExtensions from './package-extensions'
 import PACKAGE_JSON from './package-json'
 import PACKAGE_LOCK_JSON from './package-lock-json'
+import packageManagerCacheNames from './package-manager-cache-names'
 import packumentCache from './packument-cache'
 import pacoteCachePath from './pacote-cache-path'
 import PNPM from './pnpm'
 import pnpmExecPath from './pnpm-exec-path'
 import PNPM_LOCK_YAML from './pnpm-lock-yaml'
+import pnpmStorePath from './pnpm-store-path'
 import PRE_COMMIT from './pre-commit'
 import README_GLOB from './readme-glob'
 import README_GLOB_RECURSIVE from './readme-glob-recursive'
@@ -110,10 +114,12 @@ import UNLICENSED from './unlicensed'
 import UTF8 from './utf8'
 import VITEST from './vitest'
 import VLT from './vlt'
+import vltCachePath from './vlt-cache-path'
 import VLT_LOCK_JSON from './vlt-lock-json'
 import WIN32 from './win32'
 import YARN from './yarn'
 import YARN_BERRY from './yarn-berry'
+import yarnCachePath from './yarn-cache-path'
 import YARN_CLASSIC from './yarn-classic'
 import yarnExecPath from './yarn-exec-path'
 import YARN_LOCK from './yarn-lock'
@@ -136,6 +142,7 @@ declare const Constants: {
   readonly AT_LATEST: typeof AT_LATEST
   readonly BIOME_JSON: typeof BIOME_JSON
   readonly BUN: typeof BUN
+  readonly bunCachePath: typeof bunCachePath
   readonly BUN_LOCK: typeof BUN_LOCK
   readonly BUN_LOCKB: typeof BUN_LOCKB
   readonly CI: typeof CI
@@ -183,6 +190,7 @@ declare const Constants: {
   readonly NODE_MODULES_GLOB_RECURSIVE: typeof NODE_MODULES_GLOB_RECURSIVE
   readonly NODE_VERSION: typeof NODE_VERSION
   readonly NPM: typeof NPM
+  readonly npmLifecycleEvent: typeof npmLifecycleEvent
   readonly NPM_SHRINKWRAP_JSON: typeof NPM_SHRINKWRAP_JSON
   readonly NPX: typeof NPX
   readonly OVERRIDES: typeof OVERRIDES
@@ -193,6 +201,7 @@ declare const Constants: {
   readonly PACKAGE_LOCK_JSON: typeof PACKAGE_LOCK_JSON
   readonly PNPM: typeof PNPM
   readonly PNPM_LOCK_YAML: typeof PNPM_LOCK_YAML
+  readonly pnpmStorePath: typeof pnpmStorePath
   readonly PRE_COMMIT: typeof PRE_COMMIT
   readonly README_GLOB: typeof README_GLOB
   readonly README_GLOB_RECURSIVE: typeof README_GLOB_RECURSIVE
@@ -225,10 +234,12 @@ declare const Constants: {
   readonly UTF8: typeof UTF8
   readonly VITEST: typeof VITEST
   readonly VLT: typeof VLT
+  readonly vltCachePath: typeof vltCachePath
   readonly VLT_LOCK_JSON: typeof VLT_LOCK_JSON
   readonly WIN32: typeof WIN32
   readonly YARN: typeof YARN
   readonly YARN_BERRY: typeof YARN_BERRY
+  readonly yarnCachePath: typeof yarnCachePath
   readonly YARN_CLASSIC: typeof YARN_CLASSIC
   readonly YARN_LOCK: typeof YARN_LOCK
   readonly abortController: typeof abortController
@@ -244,6 +255,7 @@ declare const Constants: {
   readonly npmExecPath: typeof npmExecPath
   readonly npmRealExecPath: typeof npmRealExecPath
   readonly packageExtensions: typeof packageExtensions
+  readonly packageManagerCacheNames: typeof packageManagerCacheNames
   readonly packumentCache: typeof packumentCache
   readonly pacoteCachePath: typeof pacoteCachePath
   readonly pnpmExecPath: typeof pnpmExecPath

registry/lib/constants/index.js

@@ -11,6 +11,7 @@ const props = {
   BUN: 'bun',
   BUN_LOCK: 'bun.lock',
   BUN_LOCKB: 'bun.lockb',
+  bunCachePath: undefined,
   CI: 'CI',
   COLUMN_LIMIT: 80,
   DARWIN: undefined,
@@ -55,6 +56,7 @@ const props = {
   NODE_MODULES_GLOB_RECURSIVE: '**/node_modules',
   NODE_VERSION: undefined,
   NPM: 'npm',
+  npmLifecycleEvent: undefined,
   NPM_SHRINKWRAP_JSON: 'npm-shrinkwrap.json',
   NPX: 'npx',
   OVERRIDES: 'overrides',
@@ -65,6 +67,7 @@ const props = {
   PACKAGE_LOCK_JSON: 'package-lock.json',
   PNPM: 'pnpm',
   PNPM_LOCK_YAML: 'pnpm-lock.yaml',
+  pnpmStorePath: undefined,
   PRE_COMMIT: 'PRE_COMMIT',
   README_GLOB: 'README{.*,}',
   README_GLOB_RECURSIVE: '**/README{.*,}',
@@ -99,9 +102,11 @@ const props = {
   VITEST: 'VITEST',
   VLT: 'vlt',
   VLT_LOCK_JSON: 'vlt-lock.json',
+  vltCachePath: undefined,
   WIN32: undefined,
   YARN: 'yarn',
   YARN_BERRY: 'yarn/berry',
+  yarnCachePath: undefined,
   YARN_CLASSIC: 'yarn/classic',
   YARN_LOCK: 'yarn.lock',
   abortController: undefined,
@@ -117,6 +122,7 @@ const props = {
   npmExecPath: undefined,
   npmRealExecPath: undefined,
   packageExtensions: undefined,
+  packageManagerCacheNames: undefined,
   pnpmExecPath: undefined,
   packumentCache: undefined,
   pacoteCachePath: undefined,

registry/lib/constants/npm-lifecycle-event.d.ts

@@ -0,0 +1,2 @@
+declare const npmLifecycleEvent: string
+export = npmLifecycleEvent

registry/lib/constants/npm-lifecycle-event.js

@@ -0,0 +1,23 @@
+'use strict'
+
+const { envAsString } = /*@__PURE__*/ require('../env')
+
+// npm_lifecycle_event is set by npm, pnpm, yarn, bun, and vlt during script execution.
+// This environment variable contains the name of the script being run (e.g., 'test', 'build', 'start').
+// It's universally supported across all major package managers:
+// - npm: Sets this for all lifecycle scripts since early versions
+// - pnpm: Fully compatible with npm's behavior
+// - yarn: Both Classic (v1) and Berry (v2+) set this variable
+// - bun: Sets this when running scripts via 'bun run'
+// - vlt: The new Volt package manager by npm also sets this
+//
+// Examples:
+// - When running 'npm test', npm_lifecycle_event = 'test'
+// - When running 'pnpm build', npm_lifecycle_event = 'build'
+// - When running 'yarn start', npm_lifecycle_event = 'start'
+// - When running 'bun run dev', npm_lifecycle_event = 'dev'
+// - When running 'vlt run lint', npm_lifecycle_event = 'lint'
+//
+// This is useful for scripts that need to know which lifecycle event triggered them,
+// allowing conditional behavior based on the current script context.
+module.exports = envAsString(process.env.npm_lifecycle_event)

registry/lib/constants/package-manager-cache-names.d.ts

@@ -0,0 +1,10 @@
+interface PackageManagerCacheNames {
+  readonly NPM_CACHE_DIR: '.npm'
+  readonly PNPM_STORE_DIR: 'pnpm'
+  readonly YARN_CLASSIC_CACHE_DIR: 'yarn'
+  readonly YARN_BERRY_CACHE_DIR: '.yarn/cache'
+  readonly BUN_CACHE_DIR: 'bun'
+  readonly VLT_CACHE_DIR: 'vlt'
+}
+declare const packageManagerCacheNames: PackageManagerCacheNames
+export = packageManagerCacheNames

registry/lib/constants/package-manager-cache-names.js

@@ -0,0 +1,35 @@
+'use strict'
+
+const { freeze: ObjectFreeze } = Object
+
+// Package manager cache directory names.
+// These are the standard directory names used by each package manager
+// for their cache storage. These names are consistent across platforms.
+//
+// npm: Uses .npm directory
+// pnpm: Uses pnpm/store directory structure
+// yarn classic: Uses yarn directory
+// yarn berry: Uses .yarn/cache directory structure
+// bun: Uses bun directory
+// vlt: Uses vlt directory
+//
+// These constants are useful for:
+// - Identifying cache directories in file systems
+// - Creating gitignore patterns
+// - Cleaning up cache directories
+// - Detecting which package manager created a cache
+module.exports = ObjectFreeze({
+  __proto__: null,
+  // npm cache directory name (usually in home directory as .npm).
+  NPM_CACHE_DIR: '.npm',
+  // pnpm store directory name.
+  PNPM_STORE_DIR: 'pnpm',
+  // Yarn Classic cache directory name.
+  YARN_CLASSIC_CACHE_DIR: 'yarn',
+  // Yarn Berry cache directory path relative to project.
+  YARN_BERRY_CACHE_DIR: '.yarn/cache',
+  // Bun cache directory name.
+  BUN_CACHE_DIR: 'bun',
+  // Vlt cache directory name.
+  VLT_CACHE_DIR: 'vlt'
+})

registry/lib/constants/pnpm-store-path.d.ts

@@ -0,0 +1,2 @@
+declare const pnpmStorePath: string
+export = pnpmStorePath

registry/lib/constants/pnpm-store-path.js

@@ -0,0 +1,45 @@
+'use strict'
+
+const path = require('node:path')
+const ENV = /*@__PURE__*/ require('./env')
+const WIN32 = /*@__PURE__*/ require('./win32')
+
+// PNPM store path - the global package store location.
+// By default:
+// - macOS: ~/Library/pnpm/store
+// - Linux: ~/.local/share/pnpm/store (or $XDG_DATA_HOME/pnpm/store if set)
+// - Windows: %LOCALAPPDATA%/pnpm/store
+//
+// Can be overridden by:
+// - PNPM_HOME environment variable
+// - pnpm config store-dir setting
+// - .npmrc store-dir setting
+//
+// Documentation: https://pnpm.io/npmrc#store-dir
+function getPnpmStorePath() {
+  // Check for explicit PNPM_HOME environment variable.
+  const pnpmHome = process.env.PNPM_HOME
+  if (pnpmHome) {
+    return path.join(pnpmHome, 'store')
+  }
+
+  if (WIN32) {
+    // On Windows, use LOCALAPPDATA.
+    return ENV.LOCALAPPDATA ? path.join(ENV.LOCALAPPDATA, 'pnpm', 'store') : ''
+  }
+
+  // On Unix-like systems, follow XDG Base Directory specification.
+  if (ENV.XDG_DATA_HOME) {
+    return path.join(ENV.XDG_DATA_HOME, 'pnpm', 'store')
+  }
+
+  // macOS default location.
+  if (process.platform === 'darwin' && ENV.HOME) {
+    return path.join(ENV.HOME, 'Library', 'pnpm', 'store')
+  }
+
+  // Linux/Unix default location.
+  return ENV.HOME ? path.join(ENV.HOME, '.local', 'share', 'pnpm', 'store') : ''
+}
+
+module.exports = getPnpmStorePath()