Files
pnpm/exec/commands/src/buildCommandNotFoundHint.ts
Zoltan Kochan 7a304b17c4 refactor: rename directories and unify command packages per domain (#10993)
- Rename `installing/core` → `installing/deps-installer` and `installing/headless` → `installing/deps-restorer` for clearer naming
- Rename all `plugin-commands-*` directories to use `-commands` suffix convention
- Merge multiple command packages per domain into a single `commands/` directory (one commands package per domain rule):
  - `building/{build-commands,policy-commands}` → `building/commands`
  - `deps/compliance/{audit-commands,licenses-commands,sbom-commands}` → `deps/compliance/commands`
  - `deps/inspection/{listing-commands,outdated-commands}` → `deps/inspection/commands`
  - `store/{store-commands,inspecting-commands}` → `store/commands`
  - `releasing/{publish-commands,deploy-commands}` → `releasing/commands`
  - `cli/{completion-commands,doctor-commands}` → `cli/commands`
  - `engine/pm/{self-updater-commands,setup-commands}` → `engine/pm/commands`
  - `engine/runtime/{runtime-commands,env-commands}` → `engine/runtime/commands`
  - `cache/cache-commands` → `cache/commands`
- Fix relative paths in merged test files (pnpmBin, __typings__ references)
- Update jest config to ignore `utils/` dirs at any nesting depth under `test/`
- Fix stale package names in changeset files
2026-03-17 17:42:20 +01:00

63 lines
1.8 KiB
TypeScript

import { readdirSync } from 'node:fs'
import path from 'node:path'
import type { PackageScripts } from '@pnpm/types'
import didYouMean, { ReturnTypeEnums } from 'didyoumean2'
export function getNearestProgram ({
dir,
modulesDir,
programName,
workspaceDir,
}: {
dir: string
modulesDir: string
programName: string
workspaceDir: string | undefined
}): string | null {
try {
const binDir = path.join(dir, modulesDir, '.bin')
const programList = readProgramsFromDir(binDir)
if (workspaceDir && workspaceDir !== dir) {
const workspaceBinDir = path.join(workspaceDir, modulesDir, '.bin')
programList.push(...readProgramsFromDir(workspaceBinDir))
}
return getNearest(programName, programList)
} catch {
return null
}
}
function readProgramsFromDir (binDir: string): string[] {
const files = readdirSync(binDir)
if (process.platform !== 'win32') return files
const executableExtensions = ['.cmd', '.bat', '.ps1', '.exe', '.com']
return files.map((fullName) => {
const { name, ext } = path.parse(fullName)
return executableExtensions.includes(ext.toLowerCase()) ? name : fullName
})
}
export function buildCommandNotFoundHint (scriptName: string, scripts?: PackageScripts | undefined): string {
let hint = `Command "${scriptName}" not found.`
const nearestCommand = getNearestScript(scriptName, scripts)
if (nearestCommand) {
hint += ` Did you mean "pnpm run ${nearestCommand}"?`
}
return hint
}
export function getNearestScript (scriptName: string, scripts?: PackageScripts | undefined): string | null {
return getNearest(scriptName, Object.keys(scripts ?? []))
}
export function getNearest (name: string, list: readonly string[]): string | null {
if (list == null || list.length === 0) return null
return didYouMean(name, list, {
returnType: ReturnTypeEnums.FIRST_CLOSEST_MATCH,
})
}