-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
types.ts
79 lines (70 loc) · 2 KB
/
types.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
interface LockFilePackage {
name?: string;
version?: string;
resolved?: string;
integrity?: string;
link?: boolean;
dev?: boolean;
optional?: boolean;
devOptional?: boolean;
inBundle?: boolean;
hasInstallScript?: boolean;
hasShrinkwrap?: boolean;
bin?: string | Record<string, string>;
license?: string;
engines?: Record<string, string>;
dependencies?: Record<string, string>;
optionalDependencies?: Record<string, string>;
}
interface LockFileDependency {
version: string;
integrity: string;
resolved: string;
bundled?: boolean;
dev?: boolean;
optional?: boolean;
requires?: Record<string, string>;
dependencies?: Record<string, LockFileDependency>;
}
interface LockFileBase {
name?: string;
version?: string;
requires?: boolean; // not documented
}
// https://docs.npmjs.com/cli/v6/configuring-npm/package-lock-json#file-format
interface LockFile1 extends LockFileBase {
lockfileVersion: 1;
packageIntegrity?: string;
preserveSymlinks?: string;
dependencies?: Record<string, LockFileDependency>;
}
// https://docs.npmjs.com/cli/v7/configuring-npm/package-lock-json#file-format
// https://docs.npmjs.com/cli/v8/configuring-npm/package-lock-json#file-format
interface LockFile2 extends LockFileBase {
lockfileVersion: 2;
packages: Record<string, LockFilePackage>;
dependencies?: Record<string, LockFileDependency>;
}
// currently only hinted in the npm v7 and v8 docs
interface LockFile3 extends LockFileBase {
lockfileVersion: 3;
packages: Record<string, LockFilePackage>;
}
export type LockFile = LockFile1 | LockFile2 | LockFile3;
export interface ParseLockFileResult {
detectedIndent: string;
lockFileParsed: LockFile | undefined;
}
export type NpmDepType =
| 'dependencies'
| 'devDependencies'
| 'optionalDependencies'
| 'overrides'
| 'peerDependencies'
| 'resolutions';
export interface NpmManagerData extends Record<string, any> {
hasPackageManager?: boolean;
lernaJsonFile?: string;
parents?: string[];
yarnZeroInstall?: boolean;
}