/
extendInstallOptions.ts
246 lines (238 loc) · 7.65 KB
/
extendInstallOptions.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
import { WANTED_LOCKFILE } from '@pnpm/constants'
import PnpmError from '@pnpm/error'
import { HoistingLimits } from '@pnpm/headless'
import { createReadPackageHook } from '@pnpm/hooks.read-package-hook'
import { Lockfile } from '@pnpm/lockfile-file'
import { IncludedDependencies } from '@pnpm/modules-yaml'
import normalizeRegistries, { DEFAULT_REGISTRIES } from '@pnpm/normalize-registries'
import { WorkspacePackages } from '@pnpm/resolver-base'
import { StoreController } from '@pnpm/store-controller-types'
import {
AllowedDeprecatedVersions,
PackageExtension,
PeerDependencyRules,
ReadPackageHook,
Registries,
} from '@pnpm/types'
import pnpmPkgJson from '../pnpmPkgJson'
import { ReporterFunction } from '../types'
import { PreResolutionHookContext } from './hooks'
export interface StrictInstallOptions {
autoInstallPeers: boolean
forceSharedLockfile: boolean
frozenLockfile: boolean
frozenLockfileIfExists: boolean
enablePnp: boolean
extraBinPaths: string[]
extraEnv: Record<string, string>
hoistingLimits?: HoistingLimits
useLockfile: boolean
saveLockfile: boolean
useGitBranchLockfile: boolean
mergeGitBranchLockfiles: boolean
useInlineSpecifiersLockfileFormat: boolean
linkWorkspacePackagesDepth: number
lockfileOnly: boolean
fixLockfile: boolean
ignoreCompatibilityDb: boolean
ignoreDepScripts: boolean
ignorePackageManifest: boolean
preferFrozenLockfile: boolean
saveWorkspaceProtocol: boolean | 'rolling'
lockfileIncludeTarballUrl: boolean
preferWorkspacePackages: boolean
preserveWorkspaceProtocol: boolean
scriptsPrependNodePath: boolean | 'warn-only'
scriptShell?: string
shellEmulator: boolean
storeController: StoreController
storeDir: string
reporter: ReporterFunction
force: boolean
forcePublicHoistPattern: boolean
update: boolean
updateMatching?: (pkgName: string) => boolean
updatePackageManifest?: boolean
depth: number
lockfileDir: string
modulesDir: string
rawConfig: object
verifyStoreIntegrity: boolean
engineStrict: boolean
neverBuiltDependencies?: string[]
onlyBuiltDependencies?: string[]
nodeExecPath?: string
nodeLinker: 'isolated' | 'hoisted' | 'pnp'
nodeVersion: string
packageExtensions: Record<string, PackageExtension>
packageManager: {
name: string
version: string
}
pruneLockfileImporters: boolean
hooks: {
readPackage?: ReadPackageHook[]
preResolution?: (ctx: PreResolutionHookContext) => Promise<void>
afterAllResolved?: Array<(lockfile: Lockfile) => Lockfile | Promise<Lockfile>>
}
sideEffectsCacheRead: boolean
sideEffectsCacheWrite: boolean
strictPeerDependencies: boolean
include: IncludedDependencies
includeDirect: IncludedDependencies
ignoreCurrentPrefs: boolean
ignoreScripts: boolean
childConcurrency: number
userAgent: string
unsafePerm: boolean
registries: Registries
tag: string
overrides: Record<string, string>
ownLifecycleHooksStdio: 'inherit' | 'pipe'
workspacePackages: WorkspacePackages
pruneStore: boolean
virtualStoreDir?: string
dir: string
symlink: boolean
enableModulesDir: boolean
modulesCacheMaxAge: number
peerDependencyRules: PeerDependencyRules
allowedDeprecatedVersions: AllowedDeprecatedVersions
allowNonAppliedPatches: boolean
preferSymlinkedExecutables: boolean
resolutionMode: 'highest' | 'time-based'
publicHoistPattern: string[] | undefined
hoistPattern: string[] | undefined
forceHoistPattern: boolean
shamefullyHoist: boolean
forceShamefullyHoist: boolean
global: boolean
globalBin?: string
patchedDependencies?: Record<string, string>
}
export type InstallOptions =
& Partial<StrictInstallOptions>
& Pick<StrictInstallOptions, 'storeDir' | 'storeController'>
const defaults = async (opts: InstallOptions) => {
const packageManager = opts.packageManager ?? {
name: pnpmPkgJson.name,
version: pnpmPkgJson.version,
}
return {
allowedDeprecatedVersions: {},
allowNonAppliedPatches: false,
autoInstallPeers: false,
childConcurrency: 5,
depth: 0,
enablePnp: false,
engineStrict: false,
force: false,
forceSharedLockfile: false,
frozenLockfile: false,
hoistPattern: undefined,
publicHoistPattern: undefined,
hooks: {},
ignoreCurrentPrefs: false,
ignoreDepScripts: false,
ignoreScripts: false,
include: {
dependencies: true,
devDependencies: true,
optionalDependencies: true,
},
includeDirect: {
dependencies: true,
devDependencies: true,
optionalDependencies: true,
},
lockfileDir: opts.lockfileDir ?? opts.dir ?? process.cwd(),
lockfileOnly: false,
nodeVersion: process.version,
nodeLinker: 'isolated',
overrides: {},
ownLifecycleHooksStdio: 'inherit',
ignoreCompatibilityDb: false,
ignorePackageManifest: false,
packageExtensions: {},
packageManager,
preferFrozenLockfile: true,
preferWorkspacePackages: false,
preserveWorkspaceProtocol: true,
pruneLockfileImporters: false,
pruneStore: false,
rawConfig: {},
registries: DEFAULT_REGISTRIES,
resolutionMode: 'highest',
saveWorkspaceProtocol: true,
lockfileIncludeTarballUrl: false,
scriptsPrependNodePath: false,
shamefullyHoist: false,
shellEmulator: false,
sideEffectsCacheRead: false,
sideEffectsCacheWrite: false,
symlink: true,
storeController: opts.storeController,
storeDir: opts.storeDir,
strictPeerDependencies: true,
tag: 'latest',
unsafePerm: process.platform === 'win32' ||
process.platform === 'cygwin' ||
!process.setgid ||
process.getuid() !== 0,
update: false,
useLockfile: true,
saveLockfile: true,
useGitBranchLockfile: false,
useInlineSpecifiersLockfileFormat: false,
mergeGitBranchLockfiles: false,
userAgent: `${packageManager.name}/${packageManager.version} npm/? node/${process.version} ${process.platform} ${process.arch}`,
verifyStoreIntegrity: true,
workspacePackages: {},
enableModulesDir: true,
modulesCacheMaxAge: 7 * 24 * 60,
} as StrictInstallOptions
}
export type ProcessedInstallOptions = StrictInstallOptions & {
readPackageHook?: ReadPackageHook
}
export default async (
opts: InstallOptions
): Promise<ProcessedInstallOptions> => {
if (opts) {
for (const key in opts) {
if (opts[key] === undefined) {
delete opts[key]
}
}
}
if (opts.onlyBuiltDependencies && opts.neverBuiltDependencies) {
throw new PnpmError('CONFIG_CONFLICT_BUILT_DEPENDENCIES', 'Cannot have both neverBuiltDependencies and onlyBuiltDependencies')
}
const defaultOpts = await defaults(opts)
const extendedOpts: ProcessedInstallOptions = {
...defaultOpts,
...opts,
storeDir: defaultOpts.storeDir,
}
extendedOpts.readPackageHook = createReadPackageHook({
ignoreCompatibilityDb: extendedOpts.ignoreCompatibilityDb,
readPackageHook: extendedOpts.hooks?.readPackage,
overrides: extendedOpts.overrides,
lockfileDir: extendedOpts.lockfileDir,
packageExtensions: extendedOpts.packageExtensions,
peerDependencyRules: extendedOpts.peerDependencyRules,
})
if (extendedOpts.lockfileOnly) {
extendedOpts.ignoreScripts = true
if (!extendedOpts.useLockfile) {
throw new PnpmError('CONFIG_CONFLICT_LOCKFILE_ONLY_WITH_NO_LOCKFILE',
`Cannot generate a ${WANTED_LOCKFILE} because lockfile is set to false`)
}
}
if (extendedOpts.userAgent.startsWith('npm/')) {
extendedOpts.userAgent = `${extendedOpts.packageManager.name}/${extendedOpts.packageManager.version} ${extendedOpts.userAgent}`
}
extendedOpts.registries = normalizeRegistries(extendedOpts.registries)
extendedOpts.rawConfig['registry'] = extendedOpts.registries.default
return extendedOpts
}