-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
Copy pathcheck-dependencies.js
206 lines (162 loc) · 5.5 KB
/
check-dependencies.js
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
const fs = require("fs");
const path = require("path");
// An array of dependencies whose version checks are ignored for all the
// packages
const IGNORE_SAME_VERSION_FROM_ALL = ["web3", "hardhat"];
// A map from dependencies to package names where it should be ignored
const IGNORE_SAME_VERSION_FOR_PACKAGES = {
chai: ["@nomiclabs/hardhat-truffle4", "@nomiclabs/hardhat-truffle5"],
"@types/chai": ["@nomiclabs/hardhat-truffle4", "@nomiclabs/hardhat-truffle5"],
"truffle-contract": [
"@nomiclabs/hardhat-truffle4",
"@nomiclabs/hardhat-truffle5",
],
ethers: ["@nomicfoundation/hardhat-verify"],
["ts-node"]: ["hardhat"],
["typescript"]: ["hardhat"],
};
const IGNORE_PEER_DEPENDENCIES_CHECK_FOR_PACKAGES = {
typescript: ["hardhat"],
["ts-node"]: ["hardhat"],
};
function checkPeerDependencies(packageJson) {
if (packageJson.peerDependencies === undefined) {
return true;
}
if (packageJson.devDependencies === undefined) {
console.error(
`${packageJson.name} has peerDependencies but no devDependencies`
);
return false;
}
let success = true;
for (const dependency of Object.keys(packageJson.peerDependencies)) {
if (
IGNORE_PEER_DEPENDENCIES_CHECK_FOR_PACKAGES[dependency]?.includes(
packageJson.name
)
) {
continue;
}
if (packageJson.devDependencies[dependency] === undefined) {
console.error(
`${packageJson.name} has ${dependency} as peerDependency, but not as devDependency`
);
success = false;
continue;
}
const peerDep = packageJson.peerDependencies[dependency];
const devDep = packageJson.devDependencies[dependency];
if (peerDep !== devDep) {
console.error(
`${packageJson.name} has different versions of ${dependency} as peerDependency and devDependency`
);
success = false;
}
}
return success;
}
function addDependencies(packageName, dependenciesToAdd, allDependenciesMap) {
if (dependenciesToAdd === undefined) {
return;
}
for (const [name, specWithWorspace] of Object.entries(dependenciesToAdd)) {
const spec = specWithWorspace.replace(/^workspace:/, "");
if (IGNORE_SAME_VERSION_FROM_ALL.includes(name)) {
continue;
}
if (
IGNORE_SAME_VERSION_FOR_PACKAGES[name] !== undefined &&
IGNORE_SAME_VERSION_FOR_PACKAGES[name].includes(packageName)
) {
continue;
}
if (allDependenciesMap[name] === undefined) {
allDependenciesMap[name] = {};
}
if (allDependenciesMap[name][spec] === undefined) {
allDependenciesMap[name][spec] = new Set();
}
allDependenciesMap[name][spec].add(packageName);
}
}
function getDependencyMap(packageJson) {
// Map of: dependencyName => versionSpec => set of module names
const dependencies = {};
addDependencies(packageJson.name, packageJson.dependencies, dependencies);
addDependencies(packageJson.name, packageJson.devDependencies, dependencies);
addDependencies(packageJson.name, packageJson.peerDependencies, dependencies);
return dependencies;
}
function mergeDependenciesMap(dependencyMaps) {
// Map of: dependencyName => versionSpec => set of module names
const dependencies = {};
for (const map of dependencyMaps) {
for (const [name, specs] of Object.entries(map)) {
if (dependencies[name] === undefined) {
dependencies[name] = {};
}
for (const spec of Object.keys(specs)) {
if (dependencies[name][spec] === undefined) {
dependencies[name][spec] = new Set();
}
for (const packageName of map[name][spec]) {
dependencies[name][spec].add(packageName);
}
}
}
}
return dependencies;
}
function getAllPackageJsonPaths() {
const packageNames = fs.readdirSync(path.join(__dirname, "..", "packages"));
const packageJsons = packageNames
// ignore hh-etherscan and hh-waffle because they only have a readme
.filter((p) => !["hardhat-etherscan", "hardhat-waffle"].includes(p))
.map((p) => path.join(__dirname, "..", "packages", p, "package.json"));
packageJsons.push(path.join(__dirname, "..", "package.json"));
return packageJsons;
}
function main() {
let success = true;
const dependencyMaps = [];
for (const packageJsonPath of getAllPackageJsonPaths()) {
if (!fs.existsSync(packageJsonPath)) {
console.warn(`${packageJsonPath} doesn't exist, skipping it`);
continue;
}
const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, "utf-8"));
// temporarily ignore hardhat toolboxs
if (
packageJson.name === "@nomicfoundation/hardhat-toolbox" ||
packageJson.name === "@nomicfoundation/hardhat-toolbox-viem"
) {
continue;
}
const peersOk = checkPeerDependencies(packageJson);
const dependencyMap = getDependencyMap(packageJson);
dependencyMaps.push(dependencyMap);
if (peersOk === false) {
success = false;
}
}
const allDependenciesMap = mergeDependenciesMap(dependencyMaps);
for (const dependency of Object.keys(allDependenciesMap)) {
if (Object.keys(allDependenciesMap[dependency]).length !== 1) {
console.error(`Incompatible versions of dependency: ${dependency}`);
for (const [spec, packageNames] of Object.entries(
allDependenciesMap[dependency]
)) {
console.log(` Packages with version ${spec}:`);
for (const packageName of packageNames) {
console.log(` ${packageName}`);
}
}
success = false;
}
}
if (success === false) {
process.exit(1);
}
}
main();