Files
pnpm/resolving/default-resolver/src/index.ts
Zoltan Kochan 96704a1c58 refactor(config): rename rawConfig to authConfig, add nodeDownloadMirrors, simplify config reader (#11194)
Major cleanup of the config system after migrating settings from `.npmrc` to `pnpm-workspace.yaml`.

### Config reader simplification
- Remove `checkUnknownSetting` (dead code, always `false`)
- Trim `npmConfigTypes` from ~127 to ~67 keys (remove unused npm config keys)
- Replace `rcOptions` iteration over all type keys with direct construction from defaults + auth overlay
- Remove `rcOptionsTypes` parameter from `getConfig()` and its assembly chain

### Rename `rawConfig` to `authConfig`
- `rawConfig` was a confusing mix of auth data and general settings
- Non-auth settings are already on the typed `Config` object — stop duplicating them in `rawConfig`
- Rename `rawConfig` → `authConfig` across the codebase to clarify it only contains auth/registry data from `.npmrc`

### Remove `rawConfig` from non-auth consumers
- **Lifecycle hooks**: replace `rawConfig: object` with `userAgent?: string` — only user-agent was read
- **Fetchers**: remove unused `rawConfig` from git fetcher, binary fetcher, tarball fetcher, prepare-package
- **Update command**: use `opts.production/dev/optional` instead of `rawConfig.*`
- **`pnpm init`**: accept typed init properties instead of parsing `rawConfig`

### Add `nodeDownloadMirrors` setting
- New `nodeDownloadMirrors?: Record<string, string>` on `PnpmSettings` and `Config`
- Replaces the `node-mirror:<channel>` pattern that was stored in `rawConfig`
- Configured in `pnpm-workspace.yaml`:
  ```yaml
  nodeDownloadMirrors:
    release: https://my-mirror.example.com/download/release/
  ```
- Remove unused `rawConfig` from deno-resolver and bun-resolver

### Refactor `pnpm config get/list`
- New `configToRecord()` builds display data from typed Config properties on the fly
- Excludes sensitive internals (`authInfos`, `sslConfigs`, etc.)
- Non-types keys (e.g., `package-extensions`) resolve through `configToRecord` instead of direct property access
- Delete `processConfig.ts` (replaced by `configToRecord.ts`)

### Pre-push hook improvement
- Add `compile-only` (`tsgo --build`) to pre-push hook to catch type errors before push
2026-04-04 20:33:43 +02:00

132 lines
5.2 KiB
TypeScript

import { type BunRuntimeResolveResult, resolveBunRuntime } from '@pnpm/engine.runtime.bun-resolver'
import { type DenoRuntimeResolveResult, resolveDenoRuntime } from '@pnpm/engine.runtime.deno-resolver'
import { type NodeRuntimeResolveResult, resolveNodeRuntime } from '@pnpm/engine.runtime.node-resolver'
import { PnpmError } from '@pnpm/error'
import type { FetchFromRegistry, GetAuthHeader } from '@pnpm/fetching.types'
import { checkCustomResolverCanResolve, type CustomResolver } from '@pnpm/hooks.types'
import { createGitResolver, type GitResolveResult } from '@pnpm/resolving.git-resolver'
import { type LocalResolveResult, resolveFromLocal } from '@pnpm/resolving.local-resolver'
import {
createNpmResolver,
type JsrResolveResult,
type NpmResolveResult,
type PackageMeta,
type PackageMetaCache,
type ResolveFromNpmOptions,
type ResolverFactoryOptions,
type WorkspaceResolveResult,
} from '@pnpm/resolving.npm-resolver'
import type {
ResolveFunction,
ResolveOptions,
ResolveResult,
WantedDependency,
} from '@pnpm/resolving.resolver-base'
import { resolveFromTarball, type TarballResolveResult } from '@pnpm/resolving.tarball-resolver'
export type {
PackageMeta,
PackageMetaCache,
ResolveFunction,
ResolverFactoryOptions,
}
export interface CustomResolverResolveResult extends ResolveResult {
resolvedVia: 'custom-resolver'
}
export type DefaultResolveResult =
| NpmResolveResult
| JsrResolveResult
| GitResolveResult
| LocalResolveResult
| TarballResolveResult
| WorkspaceResolveResult
| NodeRuntimeResolveResult
| DenoRuntimeResolveResult
| BunRuntimeResolveResult
| CustomResolverResolveResult
export type DefaultResolver = (wantedDependency: WantedDependency, opts: ResolveOptions) => Promise<DefaultResolveResult>
async function resolveFromCustomResolvers (
customResolvers: CustomResolver[],
wantedDependency: WantedDependency,
opts: ResolveOptions
): Promise<DefaultResolveResult | null> {
if (!customResolvers || customResolvers.length === 0) {
return null
}
for (const customResolver of customResolvers) {
// Skip custom resolvers that don't support both canResolve and resolve
if (!customResolver.canResolve || !customResolver.resolve) continue
// eslint-disable-next-line no-await-in-loop
const canResolve = await checkCustomResolverCanResolve(customResolver, wantedDependency)
if (canResolve) {
// eslint-disable-next-line no-await-in-loop
const result = await customResolver.resolve(wantedDependency, {
lockfileDir: opts.lockfileDir,
projectDir: opts.projectDir,
preferredVersions: (opts.preferredVersions ?? {}) as unknown as Record<string, string>,
currentPkg: opts.currentPkg,
})
return {
...result,
resolvedVia: 'custom-resolver',
} as DefaultResolveResult
}
}
return null
}
export function createResolver (
fetchFromRegistry: FetchFromRegistry,
getAuthHeader: GetAuthHeader,
pnpmOpts: ResolverFactoryOptions & {
nodeDownloadMirrors?: Record<string, string>
customResolvers?: CustomResolver[]
}
): { resolve: DefaultResolver, clearCache: () => void } {
const { resolveFromNpm, resolveFromJsr, clearCache } = createNpmResolver(fetchFromRegistry, getAuthHeader, pnpmOpts)
const resolveFromGit = createGitResolver(pnpmOpts)
const _resolveFromLocal = resolveFromLocal.bind(null, {
preserveAbsolutePaths: pnpmOpts.preserveAbsolutePaths,
})
const _resolveNodeRuntime = resolveNodeRuntime.bind(null, { fetchFromRegistry, offline: pnpmOpts.offline, nodeDownloadMirrors: pnpmOpts.nodeDownloadMirrors })
const _resolveDenoRuntime = resolveDenoRuntime.bind(null, { fetchFromRegistry, offline: pnpmOpts.offline, resolveFromNpm })
const _resolveBunRuntime = resolveBunRuntime.bind(null, { fetchFromRegistry, offline: pnpmOpts.offline, resolveFromNpm })
const _resolveFromCustomResolvers = pnpmOpts.customResolvers
? resolveFromCustomResolvers.bind(null, pnpmOpts.customResolvers)
: null
return {
resolve: async (wantedDependency, opts) => {
const resolution = await _resolveFromCustomResolvers?.(wantedDependency, opts) ??
await resolveFromNpm(wantedDependency, opts as ResolveFromNpmOptions) ??
await resolveFromJsr(wantedDependency, opts as ResolveFromNpmOptions) ??
(wantedDependency.bareSpecifier && (
await resolveFromGit(wantedDependency as { bareSpecifier: string }, opts) ??
await resolveFromTarball(fetchFromRegistry, wantedDependency as { bareSpecifier: string }) ??
await _resolveFromLocal(wantedDependency as { bareSpecifier: string }, opts)
)) ??
await _resolveNodeRuntime(wantedDependency, opts) ??
await _resolveDenoRuntime(wantedDependency, opts) ??
await _resolveBunRuntime(wantedDependency, opts)
if (!resolution) {
let specifier = `${wantedDependency.alias ? wantedDependency.alias + '@' : ''}${wantedDependency.bareSpecifier ?? ''}`
if (specifier !== '') {
specifier = `"${specifier}"`
}
throw new PnpmError(
'SPEC_NOT_SUPPORTED_BY_ANY_RESOLVER',
`${specifier} isn't supported by any available resolver.`)
}
return resolution
},
clearCache,
}
}