-
-
Notifications
You must be signed in to change notification settings - Fork 933
/
import.ts
283 lines (256 loc) · 8.69 KB
/
import.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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
import path from 'path'
import { docsUrl } from '@pnpm/cli-utils'
import { WANTED_LOCKFILE } from '@pnpm/constants'
import PnpmError from '@pnpm/error'
import { readProjectManifestOnly } from '@pnpm/read-project-manifest'
import {
createOrConnectStoreController,
CreateStoreControllerOptions,
} from '@pnpm/store-connection-manager'
import gfs from '@pnpm/graceful-fs'
import { install, InstallOptions } from '@pnpm/core'
import { Config } from '@pnpm/config'
import findWorkspacePackages from '@pnpm/find-workspace-packages'
import { Project } from '@pnpm/types'
import logger from '@pnpm/logger'
import { sequenceGraph } from '@pnpm/sort-packages'
import rimraf from '@zkochan/rimraf'
import loadJsonFile from 'load-json-file'
import renderHelp from 'render-help'
import { parse as parseYarnLock } from '@yarnpkg/lockfile'
import exists from 'path-exists'
import recursive from './recursive'
import { yarnLockFileKeyNormalizer } from 'snyk-nodejs-lockfile-parser/dist/parsers/yarn-utils'
import * as yarnCore from '@yarnpkg/core'
import { parseSyml } from '@yarnpkg/parsers'
interface NpmPackageLock {
dependencies: LockedPackagesMap
}
interface LockedPackage {
version: string
dependencies?: LockedPackagesMap
}
interface LockedPackagesMap {
[name: string]: LockedPackage
}
interface YarnLockPackage {
version: string
resolved: string
integrity: string
dependencies?: {
[name: string]: string
}
optionalDependencies?: {
[depName: string]: string;
}
}
interface YarnPackgeLock {
[name: string]: YarnLockPackage
}
enum YarnLockType {
yarn = 'yarn',
yarn2 = 'yarn2',
}
// copy from yarn v1
interface YarnLock2Struct {
type: YarnLockType.yarn2
object: any;
}
export const rcOptionsTypes = cliOptionsTypes
export function cliOptionsTypes () {
return {}
}
export function help () {
return renderHelp({
description: `Generates ${WANTED_LOCKFILE} from an npm package-lock.json (or npm-shrinkwrap.json, yarn.lock) file.`,
url: docsUrl('import'),
usages: [
'pnpm import',
],
})
}
export const commandNames = ['import']
export type ImportCommandOptions = Pick<Config,
| 'allProjects'
| 'selectedProjectsGraph'
| 'workspaceDir'
> & CreateStoreControllerOptions & Omit<InstallOptions, 'storeController' | 'lockfileOnly' | 'preferredVersions'>
export async function handler (
opts: ImportCommandOptions,
params: string[]
) {
// Removing existing pnpm lockfile
// it should not influence the new one
await rimraf(path.join(opts.dir, WANTED_LOCKFILE))
const versionsByPackageNames = {}
let preferredVersions = {}
if (await exists(path.join(opts.dir, 'yarn.lock'))) {
const yarnPackgeLockFile = await readYarnLockFile(opts.dir)
getAllVersionsFromYarnLockFile(yarnPackgeLockFile, versionsByPackageNames)
} else if (
await exists(path.join(opts.dir, 'package-lock.json')) ||
await exists(path.join(opts.dir, 'npm-shrinkwrap.json'))
) {
const npmPackageLock = await readNpmLockfile(opts.dir)
getAllVersionsByPackageNames(npmPackageLock, versionsByPackageNames)
} else {
throw new PnpmError('LOCKFILE_NOT_FOUND', 'No lockfile found')
}
preferredVersions = getPreferredVersions(versionsByPackageNames)
// For a workspace with shared lockfile
if (opts.workspaceDir) {
const allProjects = opts.allProjects ?? await findWorkspacePackages(opts.workspaceDir, opts)
const selectedProjectsGraph = opts.selectedProjectsGraph ?? selectProjectByDir(allProjects, opts.dir)
if (selectedProjectsGraph != null) {
const sequencedGraph = sequenceGraph(selectedProjectsGraph)
// Check and warn if there are cyclic dependencies
if (!sequencedGraph.safe) {
const cyclicDependenciesInfo = sequencedGraph.cycles.length > 0
? `: ${sequencedGraph.cycles.map(deps => deps.join(', ')).join('; ')}`
: ''
logger.warn({
message: `There are cyclic workspace dependencies${cyclicDependenciesInfo}`,
prefix: opts.workspaceDir,
})
}
await recursive(allProjects,
params,
// @ts-expect-error
{
...opts,
lockfileOnly: true,
selectedProjectsGraph,
preferredVersions,
workspaceDir: opts.workspaceDir,
},
'import'
)
}
return
}
const store = await createOrConnectStoreController(opts)
const installOpts = {
...opts,
lockfileOnly: true,
preferredVersions,
storeController: store.ctrl,
storeDir: store.dir,
}
await install(await readProjectManifestOnly(opts.dir), installOpts)
}
async function readYarnLockFile (dir: string) {
try {
const yarnLockFile = await gfs.readFile(path.join(dir, 'yarn.lock'), 'utf8')
let lockJsonFile
const yarnLockFileType = getYarnLockfileType(yarnLockFile)
if (yarnLockFileType === YarnLockType.yarn) {
lockJsonFile = await parseYarnLock(yarnLockFile)
if (lockJsonFile.type === 'success') {
return lockJsonFile.object
} else {
throw new PnpmError('GET_YARN_LOCKFILE_ERR', `Failed With ${lockJsonFile.type}`)
}
} else if (yarnLockFileType === YarnLockType.yarn2) {
lockJsonFile = parseYarn2Lock(yarnLockFile)
if (lockJsonFile.type === YarnLockType.yarn2) {
return lockJsonFile.object
}
}
} catch (err: any) { // eslint-disable-line
if (err['code'] !== 'ENOENT') throw err // eslint-disable-line @typescript-eslint/dot-notation
}
throw new PnpmError('YARN_LOCKFILE_NOT_FOUND', 'No yarn.lock found')
}
function parseYarn2Lock (lockFileContents: string): YarnLock2Struct {
// eslint-disable-line
const parseYarnLock: any = parseSyml(lockFileContents)
delete parseYarnLock.__metadata
const dependencies: YarnPackgeLock = {}
const { structUtils } = yarnCore
const { parseDescriptor, parseRange } = structUtils
const keyNormalizer = yarnLockFileKeyNormalizer(
parseDescriptor,
parseRange,
)
Object.entries(parseYarnLock).forEach(
([fullDescriptor, versionData]: [string, any]) => {
keyNormalizer(fullDescriptor).forEach((descriptor) => {
dependencies[descriptor] = versionData;
})
},
)
return {
object: dependencies,
type: YarnLockType.yarn2
}
}
async function readNpmLockfile (dir: string) {
try {
return await loadJsonFile<LockedPackage>(path.join(dir, 'package-lock.json'))
} catch (err: any) { // eslint-disable-line
if (err['code'] !== 'ENOENT') throw err // eslint-disable-line @typescript-eslint/dot-notation
}
try {
return await loadJsonFile<LockedPackage>(path.join(dir, 'npm-shrinkwrap.json'))
} catch (err: any) { // eslint-disable-line
if (err['code'] !== 'ENOENT') throw err // eslint-disable-line @typescript-eslint/dot-notation
}
throw new PnpmError('NPM_LOCKFILE_NOT_FOUND', 'No package-lock.json or npm-shrinkwrap.json found')
}
function getPreferredVersions (
versionsByPackageNames: {
[packageName: string]: Set<string>
}
) {
const preferredVersions = {}
for (const packageName of Object.keys(versionsByPackageNames)) {
preferredVersions[packageName] = Array.from(versionsByPackageNames[packageName]).reduce((acc, version) => {
acc[version] = 'version'
return acc
}, {})
}
return preferredVersions
}
function getAllVersionsByPackageNames (
npmPackageLock: NpmPackageLock | LockedPackage,
versionsByPackageNames: {
[packageName: string]: Set<string>
}
) {
if (npmPackageLock.dependencies == null) return
for (const packageName of Object.keys(npmPackageLock.dependencies)) {
if (!versionsByPackageNames[packageName]) {
versionsByPackageNames[packageName] = new Set()
}
versionsByPackageNames[packageName].add(npmPackageLock.dependencies[packageName].version)
}
for (const packageName of Object.keys(npmPackageLock.dependencies)) {
getAllVersionsByPackageNames(npmPackageLock.dependencies[packageName], versionsByPackageNames)
}
}
function getAllVersionsFromYarnLockFile (
yarnPackageLock: YarnPackgeLock,
versionsByPackageNames: {
[packageName: string]: Set<string>
}
) {
for (const packageName of Object.keys(yarnPackageLock)) {
const pkgName = packageName.substring(0, packageName.lastIndexOf('@'))
if (!versionsByPackageNames[pkgName]) {
versionsByPackageNames[pkgName] = new Set()
}
versionsByPackageNames[pkgName].add(yarnPackageLock[packageName].version)
}
}
function selectProjectByDir (projects: Project[], searchedDir: string) {
const project = projects.find(({ dir }) => path.relative(dir, searchedDir) === '')
if (project == null) return undefined
return { [searchedDir]: { dependencies: [], package: project } }
}
function getYarnLockfileType (
lockFileContents: string
): YarnLockType {
return lockFileContents.includes('__metadata')
? YarnLockType.yarn2
: YarnLockType.yarn
}