@monorepolint/rules 0.5.0-beta.0 → 0.5.0-beta.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.turbo/turbo-clean.log +4 -0
- package/.turbo/turbo-compile-typescript.log +4 -0
- package/.turbo/turbo-lint.log +4 -0
- package/.turbo/turbo-test.log +667 -0
- package/.turbo/turbo-transpile-typescript.log +14 -0
- package/CHANGELOG.md +33 -0
- package/build/js/index.js +1422 -0
- package/build/js/index.js.map +1 -0
- package/build/tsconfig.tsbuildinfo +1 -0
- package/build/types/__tests__/alphabeticalScripts.spec.d.ts +8 -0
- package/build/types/__tests__/alphabeticalScripts.spec.d.ts.map +1 -0
- package/build/types/__tests__/bannedDependencies.spec.d.ts +2 -0
- package/build/types/__tests__/bannedDependencies.spec.d.ts.map +1 -0
- package/build/types/__tests__/consistentDependencies.spec.d.ts +2 -0
- package/build/types/__tests__/consistentDependencies.spec.d.ts.map +1 -0
- package/build/types/__tests__/consistentVersions.spec.d.ts +8 -0
- package/build/types/__tests__/consistentVersions.spec.d.ts.map +1 -0
- package/build/types/__tests__/fileContents.spec.d.ts +8 -0
- package/build/types/__tests__/fileContents.spec.d.ts.map +1 -0
- package/build/types/__tests__/mustSatisfyPeerDependencies.spec.d.ts +8 -0
- package/build/types/__tests__/mustSatisfyPeerDependencies.spec.d.ts.map +1 -0
- package/build/types/__tests__/nestedWorkspaces.spec.d.ts +2 -0
- package/build/types/__tests__/nestedWorkspaces.spec.d.ts.map +1 -0
- package/build/types/__tests__/packageEntry.spec.d.ts +8 -0
- package/build/types/__tests__/packageEntry.spec.d.ts.map +1 -0
- package/build/types/__tests__/packageOrder.spec.d.ts +8 -0
- package/build/types/__tests__/packageOrder.spec.d.ts.map +1 -0
- package/build/types/__tests__/packageScript.spec.d.ts +8 -0
- package/build/types/__tests__/packageScript.spec.d.ts.map +1 -0
- package/build/types/__tests__/requireDependency.spec.d.ts +2 -0
- package/build/types/__tests__/requireDependency.spec.d.ts.map +1 -0
- package/build/types/__tests__/utils.d.ts +81 -0
- package/build/types/__tests__/utils.d.ts.map +1 -0
- package/build/types/alphabeticalDependencies.d.ts +8 -0
- package/build/types/alphabeticalDependencies.d.ts.map +1 -0
- package/build/types/alphabeticalScripts.d.ts +8 -0
- package/build/types/alphabeticalScripts.d.ts.map +1 -0
- package/build/types/bannedDependencies.d.ts +48 -0
- package/build/types/bannedDependencies.d.ts.map +1 -0
- package/build/types/consistentDependencies.d.ts +16 -0
- package/build/types/consistentDependencies.d.ts.map +1 -0
- package/build/types/consistentVersions.d.ts +19 -0
- package/build/types/consistentVersions.d.ts.map +1 -0
- package/build/types/fileContents.d.ts +24 -0
- package/build/types/fileContents.d.ts.map +1 -0
- package/build/types/index.d.ts +21 -0
- package/build/types/index.d.ts.map +1 -0
- package/build/types/mustSatisfyPeerDependencies.d.ts +333 -0
- package/build/types/mustSatisfyPeerDependencies.d.ts.map +1 -0
- package/build/types/nestedWorkspaces.d.ts +10 -0
- package/build/types/nestedWorkspaces.d.ts.map +1 -0
- package/build/types/packageEntry.d.ts +43 -0
- package/build/types/packageEntry.d.ts.map +1 -0
- package/build/types/packageOrder.d.ts +10 -0
- package/build/types/packageOrder.d.ts.map +1 -0
- package/build/types/packageScript.d.ts +32 -0
- package/build/types/packageScript.d.ts.map +1 -0
- package/build/types/requireDependency.d.ts +29 -0
- package/build/types/requireDependency.d.ts.map +1 -0
- package/build/types/standardTsconfig.d.ts +29 -0
- package/build/types/standardTsconfig.d.ts.map +1 -0
- package/build/types/util/checkAlpha.d.ts +10 -0
- package/build/types/util/checkAlpha.d.ts.map +1 -0
- package/build/types/util/createRuleFactory.d.ts +14 -0
- package/build/types/util/createRuleFactory.d.ts.map +1 -0
- package/build/types/util/makeDirectory.d.ts +8 -0
- package/build/types/util/makeDirectory.d.ts.map +1 -0
- package/build/types/util/packageDependencyGraphService.d.ts +37 -0
- package/build/types/util/packageDependencyGraphService.d.ts.map +1 -0
- package/package.json +4 -4
- package/src/alphabeticalDependencies.ts +2 -2
- package/src/alphabeticalScripts.ts +2 -2
- package/src/bannedDependencies.ts +2 -2
- package/src/consistentDependencies.ts +2 -2
- package/src/consistentVersions.ts +2 -2
- package/src/fileContents.ts +2 -2
- package/src/index.ts +8 -0
- package/src/mustSatisfyPeerDependencies.ts +2 -2
- package/src/nestedWorkspaces.ts +4 -4
- package/src/packageEntry.ts +2 -2
- package/src/packageOrder.ts +2 -2
- package/src/packageScript.ts +2 -2
- package/src/requireDependency.ts +2 -2
- package/src/standardTsconfig.ts +2 -2
- package/src/util/createRuleFactory.ts +33 -0
- package/src/public/util.ts +0 -1
- package/src/util/makeRule.ts +0 -29
|
@@ -0,0 +1,1422 @@
|
|
|
1
|
+
// src/util/checkAlpha.ts
|
|
2
|
+
import { diff } from "jest-diff";
|
|
3
|
+
function checkAlpha(context, block) {
|
|
4
|
+
const packageJson = context.getPackageJson();
|
|
5
|
+
const packagePath = context.getPackageJsonPath();
|
|
6
|
+
const blockToSort = packageJson[block];
|
|
7
|
+
if (blockToSort === void 0) {
|
|
8
|
+
return;
|
|
9
|
+
}
|
|
10
|
+
const actualOrder = Object.keys(blockToSort);
|
|
11
|
+
const expectedOrder = actualOrder.slice().sort();
|
|
12
|
+
if (!arrayOrderCompare(actualOrder, expectedOrder)) {
|
|
13
|
+
context.addError({
|
|
14
|
+
file: packagePath,
|
|
15
|
+
message: createIncorrectOrderErrorMessage(block, packageJson.name),
|
|
16
|
+
longMessage: diff(expectedOrder, actualOrder, { expand: true }),
|
|
17
|
+
fixer: () => {
|
|
18
|
+
const expectedDependencies = {};
|
|
19
|
+
expectedOrder.forEach((dep) => {
|
|
20
|
+
expectedDependencies[dep] = blockToSort[dep];
|
|
21
|
+
});
|
|
22
|
+
const newPackageJson = { ...packageJson };
|
|
23
|
+
newPackageJson[block] = expectedDependencies;
|
|
24
|
+
context.host.writeJson(packagePath, newPackageJson);
|
|
25
|
+
}
|
|
26
|
+
});
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
function arrayOrderCompare(a, b) {
|
|
30
|
+
for (let index = 0; index < a.length; index++) {
|
|
31
|
+
if (a[index] !== b[index]) {
|
|
32
|
+
return false;
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
return true;
|
|
36
|
+
}
|
|
37
|
+
function createIncorrectOrderErrorMessage(block, packageName) {
|
|
38
|
+
return `Incorrect order of ${block} in ${packageName}'s package.json`;
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
// src/util/createRuleFactory.ts
|
|
42
|
+
var globalId = 0;
|
|
43
|
+
function createRuleFactory({
|
|
44
|
+
name,
|
|
45
|
+
check,
|
|
46
|
+
validateOptions,
|
|
47
|
+
printStats
|
|
48
|
+
}) {
|
|
49
|
+
return function(ruleEntry) {
|
|
50
|
+
const id = ruleEntry.id ?? `${name} :: ${globalId++}`;
|
|
51
|
+
return {
|
|
52
|
+
id,
|
|
53
|
+
// eslint-disable-next-line @typescript-eslint/no-extra-non-null-assertion
|
|
54
|
+
check: (context) => check(context, ruleEntry.options, { id }),
|
|
55
|
+
name,
|
|
56
|
+
validateOptions,
|
|
57
|
+
ruleEntry,
|
|
58
|
+
printStats
|
|
59
|
+
};
|
|
60
|
+
};
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
// src/alphabeticalDependencies.ts
|
|
64
|
+
var alphabeticalDependencies = createRuleFactory({
|
|
65
|
+
name: "alphabeticalDependencies",
|
|
66
|
+
check: (context) => {
|
|
67
|
+
checkAlpha(context, "dependencies");
|
|
68
|
+
checkAlpha(context, "devDependencies");
|
|
69
|
+
checkAlpha(context, "peerDependencies");
|
|
70
|
+
},
|
|
71
|
+
validateOptions: () => {
|
|
72
|
+
}
|
|
73
|
+
});
|
|
74
|
+
|
|
75
|
+
// src/alphabeticalScripts.ts
|
|
76
|
+
var alphabeticalScripts = createRuleFactory({
|
|
77
|
+
name: "alphabeticalScripts",
|
|
78
|
+
check: (context) => {
|
|
79
|
+
checkAlpha(context, "scripts");
|
|
80
|
+
},
|
|
81
|
+
validateOptions: () => {
|
|
82
|
+
}
|
|
83
|
+
});
|
|
84
|
+
|
|
85
|
+
// src/bannedDependencies.ts
|
|
86
|
+
import { matchesAnyGlob } from "@monorepolint/utils";
|
|
87
|
+
import { AggregateTiming } from "@monorepolint/utils";
|
|
88
|
+
import * as path2 from "node:path";
|
|
89
|
+
import * as r from "runtypes";
|
|
90
|
+
|
|
91
|
+
// src/util/packageDependencyGraphService.ts
|
|
92
|
+
import * as path from "node:path";
|
|
93
|
+
import resolvePackagePath from "resolve-package-path";
|
|
94
|
+
var PackageDependencyGraphService = class {
|
|
95
|
+
/** Construct a graph of package dependencies and return the root node. */
|
|
96
|
+
buildDependencyGraph(startPackageJsonPath, host, maxDepth) {
|
|
97
|
+
const nodes = /* @__PURE__ */ new Map();
|
|
98
|
+
const visit = (packageJsonPath, currentDepth) => {
|
|
99
|
+
if (nodes.has(packageJsonPath)) {
|
|
100
|
+
return nodes.get(packageJsonPath);
|
|
101
|
+
}
|
|
102
|
+
const packageJson = host.readJson(packageJsonPath);
|
|
103
|
+
const node = {
|
|
104
|
+
packageJson,
|
|
105
|
+
dependencies: /* @__PURE__ */ new Map(),
|
|
106
|
+
paths: {
|
|
107
|
+
packageJsonPath,
|
|
108
|
+
rootDirectory: path.dirname(packageJsonPath)
|
|
109
|
+
}
|
|
110
|
+
};
|
|
111
|
+
nodes.set(packageJsonPath, node);
|
|
112
|
+
const nextDepth = currentDepth + 1;
|
|
113
|
+
if (maxDepth == null || nextDepth <= maxDepth) {
|
|
114
|
+
const dependencies = packageJson.dependencies != null ? Object.keys(packageJson.dependencies) : [];
|
|
115
|
+
for (const dependency of dependencies) {
|
|
116
|
+
const dependencyPackageJsonPath = resolvePackagePath(dependency, node.paths.rootDirectory);
|
|
117
|
+
if (dependencyPackageJsonPath == null) {
|
|
118
|
+
throw new Error(`Could not resolve ${dependency} from ${node.paths.rootDirectory}`);
|
|
119
|
+
}
|
|
120
|
+
node.dependencies.set(dependency, visit(dependencyPackageJsonPath, nextDepth));
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
return node;
|
|
124
|
+
};
|
|
125
|
+
return visit(startPackageJsonPath, 0);
|
|
126
|
+
}
|
|
127
|
+
/** Traverse a package dependency graph with an iterator. */
|
|
128
|
+
*traverse(root, opts = { traverseAllPaths: false }) {
|
|
129
|
+
const visited = /* @__PURE__ */ new Set();
|
|
130
|
+
function* visit(node, importPath = []) {
|
|
131
|
+
if (!opts.traverseAllPaths && visited.has(node)) {
|
|
132
|
+
return;
|
|
133
|
+
}
|
|
134
|
+
if (importPath.indexOf(node) !== -1) {
|
|
135
|
+
return;
|
|
136
|
+
}
|
|
137
|
+
visited.add(node);
|
|
138
|
+
importPath = [...importPath, node];
|
|
139
|
+
yield { ...node, importPath };
|
|
140
|
+
for (const dependency of node.dependencies.values()) {
|
|
141
|
+
yield* visit(dependency, importPath);
|
|
142
|
+
}
|
|
143
|
+
}
|
|
144
|
+
yield* visit(root);
|
|
145
|
+
}
|
|
146
|
+
};
|
|
147
|
+
|
|
148
|
+
// src/bannedDependencies.ts
|
|
149
|
+
var bannedDepGlobsField = r.Union(
|
|
150
|
+
r.Array(r.String),
|
|
151
|
+
r.Record({
|
|
152
|
+
glob: r.Array(r.String).optional(),
|
|
153
|
+
exact: r.Array(r.String).optional()
|
|
154
|
+
})
|
|
155
|
+
);
|
|
156
|
+
var Options = r.Union(
|
|
157
|
+
r.Record({
|
|
158
|
+
bannedDependencies: bannedDepGlobsField,
|
|
159
|
+
bannedTransitiveDependencies: r.Undefined.optional()
|
|
160
|
+
}),
|
|
161
|
+
r.Record({
|
|
162
|
+
bannedDependencies: bannedDepGlobsField.optional(),
|
|
163
|
+
bannedTransitiveDependencies: r.Array(r.String)
|
|
164
|
+
}),
|
|
165
|
+
r.Record({
|
|
166
|
+
bannedDependencies: bannedDepGlobsField.optional(),
|
|
167
|
+
bannedTransitiveDependencies: r.Array(r.String).optional()
|
|
168
|
+
})
|
|
169
|
+
);
|
|
170
|
+
var setCache = /* @__PURE__ */ new Map();
|
|
171
|
+
var aggregateTiming = new AggregateTiming(":bannedDependencies stats");
|
|
172
|
+
var bannedDependencies = createRuleFactory({
|
|
173
|
+
name: "bannedDependencies",
|
|
174
|
+
check: (context, opts, extra) => {
|
|
175
|
+
aggregateTiming.start((extra == null ? void 0 : extra.id) ?? "unknown id");
|
|
176
|
+
const packageJson = context.getPackageJson();
|
|
177
|
+
const packagePath = context.getPackageJsonPath();
|
|
178
|
+
const curDeps = packageJson.dependencies && Object.keys(packageJson.dependencies);
|
|
179
|
+
const curDevDeps = packageJson.devDependencies && Object.keys(packageJson.devDependencies);
|
|
180
|
+
const curPeerDeps = packageJson.peerDependencies && Object.keys(packageJson.peerDependencies);
|
|
181
|
+
const { bannedDependencies: banned, bannedTransitiveDependencies: transitives } = opts;
|
|
182
|
+
const globs = banned && (Array.isArray(banned) ? banned : banned.glob);
|
|
183
|
+
const exacts = banned && (Array.isArray(banned) ? void 0 : banned.exact);
|
|
184
|
+
const violations = /* @__PURE__ */ new Set();
|
|
185
|
+
if (globs) {
|
|
186
|
+
if (curDeps)
|
|
187
|
+
populateProblemsGlobs(globs, curDeps, violations);
|
|
188
|
+
if (curDevDeps)
|
|
189
|
+
populateProblemsGlobs(globs, curDevDeps, violations);
|
|
190
|
+
if (curPeerDeps)
|
|
191
|
+
populateProblemsGlobs(globs, curPeerDeps, violations);
|
|
192
|
+
}
|
|
193
|
+
if (exacts) {
|
|
194
|
+
let set = setCache.get(exacts);
|
|
195
|
+
if (set === void 0) {
|
|
196
|
+
set = new Set(exacts);
|
|
197
|
+
setCache.set(exacts, set);
|
|
198
|
+
}
|
|
199
|
+
if (curDeps)
|
|
200
|
+
populateProblemsExact(set, curDeps, violations);
|
|
201
|
+
if (curDevDeps)
|
|
202
|
+
populateProblemsExact(set, curDevDeps, violations);
|
|
203
|
+
if (curPeerDeps)
|
|
204
|
+
populateProblemsExact(set, curPeerDeps, violations);
|
|
205
|
+
}
|
|
206
|
+
if (violations.size > 0) {
|
|
207
|
+
context.addError({
|
|
208
|
+
file: packagePath,
|
|
209
|
+
message: `Found ${violations.size} banned dependencies of package.json:
|
|
210
|
+
` + Array.from(violations).map((v) => `'${v}'`).join(", ")
|
|
211
|
+
});
|
|
212
|
+
}
|
|
213
|
+
if (transitives) {
|
|
214
|
+
let set = setCache.get(transitives);
|
|
215
|
+
if (set === void 0) {
|
|
216
|
+
set = new Set(transitives);
|
|
217
|
+
setCache.set(transitives, set);
|
|
218
|
+
}
|
|
219
|
+
checkTransitives(context, set);
|
|
220
|
+
}
|
|
221
|
+
aggregateTiming.stop();
|
|
222
|
+
},
|
|
223
|
+
validateOptions: Options.check,
|
|
224
|
+
printStats: () => {
|
|
225
|
+
aggregateTiming.printResults();
|
|
226
|
+
}
|
|
227
|
+
});
|
|
228
|
+
function populateProblemsExact(banned, dependencies, violations) {
|
|
229
|
+
for (const dependency of dependencies) {
|
|
230
|
+
if (banned.has(dependency)) {
|
|
231
|
+
violations.add(dependency);
|
|
232
|
+
}
|
|
233
|
+
}
|
|
234
|
+
}
|
|
235
|
+
function populateProblemsGlobs(bannedDependencyGlobs, dependencies, violations) {
|
|
236
|
+
for (const dependency of dependencies) {
|
|
237
|
+
if (matchesAnyGlob(dependency, bannedDependencyGlobs)) {
|
|
238
|
+
violations.add(dependency);
|
|
239
|
+
}
|
|
240
|
+
}
|
|
241
|
+
}
|
|
242
|
+
function checkTransitives(context, banned) {
|
|
243
|
+
const graphService = new PackageDependencyGraphService();
|
|
244
|
+
const root = graphService.buildDependencyGraph(path2.resolve(context.getPackageJsonPath()), context.host);
|
|
245
|
+
for (const { dependencies, importPath } of graphService.traverse(root)) {
|
|
246
|
+
for (const [dependency] of dependencies) {
|
|
247
|
+
if (banned.has(dependency)) {
|
|
248
|
+
const [, ...importPathWithoutRoot] = importPath;
|
|
249
|
+
const pathing = [...importPathWithoutRoot.map(nameOrPackageJsonPath), dependency].join(" -> ");
|
|
250
|
+
context.addError({
|
|
251
|
+
file: root.paths.packageJsonPath,
|
|
252
|
+
message: `Banned transitive dependencies in repo: ${pathing}`
|
|
253
|
+
});
|
|
254
|
+
}
|
|
255
|
+
}
|
|
256
|
+
}
|
|
257
|
+
}
|
|
258
|
+
function nameOrPackageJsonPath(node) {
|
|
259
|
+
return node.packageJson.name ?? node.paths.packageJsonPath;
|
|
260
|
+
}
|
|
261
|
+
|
|
262
|
+
// src/consistentDependencies.ts
|
|
263
|
+
import { diff as diff2 } from "jest-diff";
|
|
264
|
+
import * as r2 from "runtypes";
|
|
265
|
+
var Options2 = r2.Record({
|
|
266
|
+
ignoredDependencies: r2.Array(r2.String).Or(r2.Undefined)
|
|
267
|
+
}).Or(r2.Undefined);
|
|
268
|
+
var skippedVersions = ["*", "latest"];
|
|
269
|
+
var consistentDependencies = createRuleFactory({
|
|
270
|
+
name: "consistentDependencies",
|
|
271
|
+
check: (context, args) => {
|
|
272
|
+
checkDeps(context, args, "dependencies");
|
|
273
|
+
checkDeps(context, args, "devDependencies");
|
|
274
|
+
},
|
|
275
|
+
validateOptions: Options2.check
|
|
276
|
+
});
|
|
277
|
+
function checkDeps(context, args, block) {
|
|
278
|
+
const packageJson = context.getPackageJson();
|
|
279
|
+
const packagePath = context.getPackageJsonPath();
|
|
280
|
+
const dependencies = packageJson[block];
|
|
281
|
+
const workspacePackageJson = context.getWorkspaceContext().getPackageJson();
|
|
282
|
+
const workspaceDependencies = workspacePackageJson[block];
|
|
283
|
+
const ignoredDeps = (args == null ? void 0 : args.ignoredDependencies) ?? [];
|
|
284
|
+
const depsToCheck = workspaceDependencies == null || ignoredDeps.length === 0 ? workspaceDependencies : omit(workspaceDependencies, ignoredDeps);
|
|
285
|
+
if (dependencies === void 0 || depsToCheck === void 0) {
|
|
286
|
+
return;
|
|
287
|
+
}
|
|
288
|
+
const expectedDependencies = {
|
|
289
|
+
...dependencies,
|
|
290
|
+
...filterKeys(depsToCheck, dependencies)
|
|
291
|
+
};
|
|
292
|
+
if (JSON.stringify(dependencies) !== JSON.stringify(expectedDependencies)) {
|
|
293
|
+
context.addError({
|
|
294
|
+
file: packagePath,
|
|
295
|
+
message: `Inconsistent ${block} with root in package.json`,
|
|
296
|
+
longMessage: diff2(expectedDependencies, dependencies, { expand: true }),
|
|
297
|
+
fixer: () => {
|
|
298
|
+
const newPackageJson = { ...packageJson };
|
|
299
|
+
newPackageJson[block] = expectedDependencies;
|
|
300
|
+
context.host.writeJson(packagePath, newPackageJson);
|
|
301
|
+
}
|
|
302
|
+
});
|
|
303
|
+
}
|
|
304
|
+
}
|
|
305
|
+
function filterKeys(ob, filterOb) {
|
|
306
|
+
const newOb = {};
|
|
307
|
+
for (const key of Object.keys(filterOb)) {
|
|
308
|
+
if (ob[key] !== void 0 && skippedVersions.indexOf(filterOb[key]) === -1) {
|
|
309
|
+
newOb[key] = ob[key];
|
|
310
|
+
}
|
|
311
|
+
}
|
|
312
|
+
return newOb;
|
|
313
|
+
}
|
|
314
|
+
function omit(obj, keysToOmit) {
|
|
315
|
+
const newObj = {};
|
|
316
|
+
const filtered = Object.entries(obj).filter(([key]) => !keysToOmit.includes(key));
|
|
317
|
+
for (const [key, value] of filtered) {
|
|
318
|
+
newObj[key] = value;
|
|
319
|
+
}
|
|
320
|
+
return newObj;
|
|
321
|
+
}
|
|
322
|
+
|
|
323
|
+
// src/consistentVersions.ts
|
|
324
|
+
import { mutateJson } from "@monorepolint/utils";
|
|
325
|
+
import * as r3 from "runtypes";
|
|
326
|
+
import { coerce } from "semver";
|
|
327
|
+
var Options3 = r3.Record({
|
|
328
|
+
matchDependencyVersions: r3.Dictionary(r3.Union(r3.String, r3.Array(r3.String)))
|
|
329
|
+
});
|
|
330
|
+
var consistentVersions = createRuleFactory({
|
|
331
|
+
name: "consistentVersions",
|
|
332
|
+
check: checkConsistentVersions,
|
|
333
|
+
validateOptions: Options3.check
|
|
334
|
+
});
|
|
335
|
+
function checkConsistentVersions(context, options) {
|
|
336
|
+
for (const [dependencyPackageName, expectedPackageDependencyValue] of Object.entries(
|
|
337
|
+
options.matchDependencyVersions
|
|
338
|
+
)) {
|
|
339
|
+
if (Array.isArray(expectedPackageDependencyValue)) {
|
|
340
|
+
ensurePackageMatchesSomeVersion(context, dependencyPackageName, expectedPackageDependencyValue);
|
|
341
|
+
} else {
|
|
342
|
+
ensurePackageIsCorrectVersion(context, dependencyPackageName, expectedPackageDependencyValue);
|
|
343
|
+
}
|
|
344
|
+
}
|
|
345
|
+
}
|
|
346
|
+
var ensurePackageIsCorrectVersion = (context, dependencyPackageName, expectedPackageDependencyValue) => {
|
|
347
|
+
const packageJson = context.getPackageJson();
|
|
348
|
+
const packageJsonPath = context.getPackageJsonPath();
|
|
349
|
+
const expectedPackageDependencyVersion = coerce(expectedPackageDependencyValue);
|
|
350
|
+
if (expectedPackageDependencyVersion == null) {
|
|
351
|
+
throw new Error(
|
|
352
|
+
`Malformed expected package dependency version defined in monorepolint configuration: ${dependencyPackageName} @ '${expectedPackageDependencyValue}'`
|
|
353
|
+
);
|
|
354
|
+
}
|
|
355
|
+
const actualPackageDependencyValue = packageJson.dependencies && packageJson.dependencies[dependencyPackageName];
|
|
356
|
+
const actualPackageDependencyVersion = coerce(actualPackageDependencyValue);
|
|
357
|
+
if (actualPackageDependencyVersion != null && actualPackageDependencyVersion.raw !== expectedPackageDependencyVersion.raw) {
|
|
358
|
+
context.addError({
|
|
359
|
+
file: packageJsonPath,
|
|
360
|
+
message: `Expected dependency on ${dependencyPackageName} to match version defined in monorepolint configuration '${expectedPackageDependencyValue}', got '${actualPackageDependencyValue}' instead.`,
|
|
361
|
+
fixer: () => mutateJson(packageJsonPath, context.host, (input) => {
|
|
362
|
+
input.dependencies[dependencyPackageName] = expectedPackageDependencyValue;
|
|
363
|
+
return input;
|
|
364
|
+
})
|
|
365
|
+
});
|
|
366
|
+
}
|
|
367
|
+
const actualPackageDevDependencyValue = packageJson.devDependencies && packageJson.devDependencies[dependencyPackageName];
|
|
368
|
+
const actualPackageDevDependencyVersion = coerce(actualPackageDevDependencyValue);
|
|
369
|
+
if (actualPackageDevDependencyVersion != null && actualPackageDevDependencyVersion.raw !== expectedPackageDependencyVersion.raw) {
|
|
370
|
+
context.addError({
|
|
371
|
+
file: packageJsonPath,
|
|
372
|
+
message: `Expected devDependency on ${dependencyPackageName} to match version defined in monorepolint configuration '${expectedPackageDependencyValue}', got '${actualPackageDevDependencyValue}' instead`,
|
|
373
|
+
fixer: () => mutateJson(packageJsonPath, context.host, (input) => {
|
|
374
|
+
input.devDependencies[dependencyPackageName] = expectedPackageDependencyValue;
|
|
375
|
+
return input;
|
|
376
|
+
})
|
|
377
|
+
});
|
|
378
|
+
}
|
|
379
|
+
};
|
|
380
|
+
var ensurePackageMatchesSomeVersion = (context, dependencyPackageName, acceptedPackageDependencyValues) => {
|
|
381
|
+
const packageJson = context.getPackageJson();
|
|
382
|
+
const packageJsonPath = context.getPackageJsonPath();
|
|
383
|
+
const acceptedPackageDependencyVersions = acceptedPackageDependencyValues.map(
|
|
384
|
+
(acceptedPackageDependencyValue) => {
|
|
385
|
+
const acceptedPackageDependencyVersion = coerce(acceptedPackageDependencyValue);
|
|
386
|
+
if (acceptedPackageDependencyVersion == null) {
|
|
387
|
+
throw new Error(
|
|
388
|
+
`Malformed accepted package dependency version defined in monorepolint configuration: ${dependencyPackageName} @ '${acceptedPackageDependencyValue}'`
|
|
389
|
+
);
|
|
390
|
+
}
|
|
391
|
+
return acceptedPackageDependencyVersion;
|
|
392
|
+
}
|
|
393
|
+
);
|
|
394
|
+
const actualPackageDependencyValue = packageJson.dependencies && packageJson.dependencies[dependencyPackageName];
|
|
395
|
+
const actualPackageDependencyVersion = coerce(actualPackageDependencyValue);
|
|
396
|
+
if (actualPackageDependencyVersion != null && acceptedPackageDependencyVersions.every(
|
|
397
|
+
(acceptedPackageDependencyVersion) => actualPackageDependencyVersion.raw !== acceptedPackageDependencyVersion.raw
|
|
398
|
+
)) {
|
|
399
|
+
context.addError({
|
|
400
|
+
file: packageJsonPath,
|
|
401
|
+
message: `Expected dependency on ${dependencyPackageName} to match one of '${JSON.stringify(
|
|
402
|
+
acceptedPackageDependencyValues
|
|
403
|
+
)}', got '${actualPackageDependencyValue}' instead.`
|
|
404
|
+
});
|
|
405
|
+
}
|
|
406
|
+
const actualPackageDevDependencyValue = packageJson.devDependencies && packageJson.devDependencies[dependencyPackageName];
|
|
407
|
+
const actualPackageDevDependencyVersion = coerce(actualPackageDevDependencyValue);
|
|
408
|
+
if (actualPackageDevDependencyVersion != null && acceptedPackageDependencyVersions.every(
|
|
409
|
+
(acceptedPackageDependencyVersion) => actualPackageDevDependencyVersion.raw !== acceptedPackageDependencyVersion.raw
|
|
410
|
+
)) {
|
|
411
|
+
context.addError({
|
|
412
|
+
file: packageJsonPath,
|
|
413
|
+
message: `Expected devDependency on ${dependencyPackageName} to match one of '${JSON.stringify(
|
|
414
|
+
acceptedPackageDependencyValues
|
|
415
|
+
)}', got '${actualPackageDevDependencyValue}' instead.`
|
|
416
|
+
});
|
|
417
|
+
}
|
|
418
|
+
};
|
|
419
|
+
|
|
420
|
+
// src/fileContents.ts
|
|
421
|
+
import { diff as diff3 } from "jest-diff";
|
|
422
|
+
import * as path3 from "path";
|
|
423
|
+
import * as r4 from "runtypes";
|
|
424
|
+
var Options4 = r4.Union(
|
|
425
|
+
r4.Record({
|
|
426
|
+
file: r4.String,
|
|
427
|
+
generator: r4.Function.withGuard((x) => x != void 0),
|
|
428
|
+
template: r4.Undefined.optional(),
|
|
429
|
+
templateFile: r4.Undefined.optional()
|
|
430
|
+
}),
|
|
431
|
+
r4.Record({
|
|
432
|
+
file: r4.String,
|
|
433
|
+
generator: r4.Undefined.optional(),
|
|
434
|
+
template: r4.String,
|
|
435
|
+
templateFile: r4.Undefined.optional()
|
|
436
|
+
}),
|
|
437
|
+
r4.Record({
|
|
438
|
+
file: r4.String,
|
|
439
|
+
generator: r4.Undefined.optional(),
|
|
440
|
+
template: r4.Undefined.optional(),
|
|
441
|
+
templateFile: r4.String
|
|
442
|
+
})
|
|
443
|
+
);
|
|
444
|
+
var fileContents = createRuleFactory({
|
|
445
|
+
name: "fileContents",
|
|
446
|
+
check: async (context, opts) => {
|
|
447
|
+
const fullPath = path3.join(context.packageDir, opts.file);
|
|
448
|
+
const expectedContent = await getExpectedContents(context, opts);
|
|
449
|
+
const pathExists = context.host.exists(fullPath);
|
|
450
|
+
const actualContent = pathExists ? context.host.readFile(fullPath, { encoding: "utf-8" }) : void 0;
|
|
451
|
+
if (actualContent !== expectedContent) {
|
|
452
|
+
context.addError({
|
|
453
|
+
file: fullPath,
|
|
454
|
+
message: "Expect file contents to match",
|
|
455
|
+
longMessage: diff3(expectedContent, actualContent, { expand: true }),
|
|
456
|
+
fixer: () => {
|
|
457
|
+
if (expectedContent === void 0) {
|
|
458
|
+
if (pathExists)
|
|
459
|
+
context.host.deleteFile(fullPath);
|
|
460
|
+
} else {
|
|
461
|
+
context.host.mkdir(path3.dirname(fullPath), { recursive: true });
|
|
462
|
+
context.host.writeFile(fullPath, expectedContent, { encoding: "utf-8" });
|
|
463
|
+
}
|
|
464
|
+
}
|
|
465
|
+
});
|
|
466
|
+
}
|
|
467
|
+
},
|
|
468
|
+
validateOptions: Options4.check
|
|
469
|
+
});
|
|
470
|
+
var optionsCache = /* @__PURE__ */ new Map();
|
|
471
|
+
async function getExpectedContents(context, opts) {
|
|
472
|
+
if (optionsCache.has(opts)) {
|
|
473
|
+
const cachedEntry = optionsCache.get(opts);
|
|
474
|
+
if (cachedEntry && typeof cachedEntry === "function") {
|
|
475
|
+
return cachedEntry(context);
|
|
476
|
+
}
|
|
477
|
+
return cachedEntry;
|
|
478
|
+
}
|
|
479
|
+
if (opts.generator) {
|
|
480
|
+
optionsCache.set(opts, opts.generator);
|
|
481
|
+
return opts.generator(context);
|
|
482
|
+
} else if (opts.templateFile) {
|
|
483
|
+
const { packageDir: workspacePackageDir } = context.getWorkspaceContext();
|
|
484
|
+
const fullPath = path3.resolve(workspacePackageDir, opts.templateFile);
|
|
485
|
+
const template = context.host.readFile(fullPath, { encoding: "utf-8" });
|
|
486
|
+
optionsCache.set(opts, template);
|
|
487
|
+
return template;
|
|
488
|
+
} else {
|
|
489
|
+
optionsCache.set(opts, opts.template);
|
|
490
|
+
return opts.template;
|
|
491
|
+
}
|
|
492
|
+
}
|
|
493
|
+
|
|
494
|
+
// src/mustSatisfyPeerDependencies.ts
|
|
495
|
+
import { mutateJson as mutateJson2 } from "@monorepolint/utils";
|
|
496
|
+
import * as path4 from "node:path";
|
|
497
|
+
import * as r5 from "runtypes";
|
|
498
|
+
import { coerce as coerce2 } from "semver";
|
|
499
|
+
import resolvePackagePath2 from "resolve-package-path";
|
|
500
|
+
var Options5 = r5.Union(
|
|
501
|
+
r5.Partial({
|
|
502
|
+
skipUnparseableRanges: r5.Undefined,
|
|
503
|
+
dependencyWhitelist: r5.Undefined,
|
|
504
|
+
dependencyBlacklist: r5.Undefined,
|
|
505
|
+
enforceForDevDependencies: r5.Undefined
|
|
506
|
+
}),
|
|
507
|
+
r5.Record({
|
|
508
|
+
skipUnparseableRanges: r5.Boolean
|
|
509
|
+
}).And(
|
|
510
|
+
r5.Partial({
|
|
511
|
+
dependencyWhitelist: r5.Undefined,
|
|
512
|
+
dependencyBlacklist: r5.Undefined,
|
|
513
|
+
enforceForDevDependencies: r5.Undefined
|
|
514
|
+
})
|
|
515
|
+
),
|
|
516
|
+
r5.Record({
|
|
517
|
+
dependencyWhitelist: r5.Array(r5.String)
|
|
518
|
+
}).And(
|
|
519
|
+
r5.Partial({
|
|
520
|
+
skipUnparseableRanges: r5.Undefined,
|
|
521
|
+
dependencyBlacklist: r5.Undefined,
|
|
522
|
+
enforceForDevDependencies: r5.Undefined
|
|
523
|
+
})
|
|
524
|
+
),
|
|
525
|
+
r5.Record({
|
|
526
|
+
dependencyBlacklist: r5.Array(r5.String)
|
|
527
|
+
}).And(
|
|
528
|
+
r5.Partial({
|
|
529
|
+
skipUnparseableRanges: r5.Undefined,
|
|
530
|
+
dependencyWhitelist: r5.Undefined,
|
|
531
|
+
enforceForDevDependencies: r5.Undefined
|
|
532
|
+
})
|
|
533
|
+
),
|
|
534
|
+
r5.Record({
|
|
535
|
+
enforceForDevDependencies: r5.Boolean
|
|
536
|
+
}).And(
|
|
537
|
+
r5.Partial({
|
|
538
|
+
skipUnparseableRanges: r5.Undefined,
|
|
539
|
+
dependencyWhitelist: r5.Undefined,
|
|
540
|
+
dependencyBlacklist: r5.Undefined
|
|
541
|
+
})
|
|
542
|
+
),
|
|
543
|
+
r5.Record({
|
|
544
|
+
skipUnparseableRanges: r5.Boolean,
|
|
545
|
+
dependencyWhitelist: r5.Array(r5.String)
|
|
546
|
+
}).And(
|
|
547
|
+
r5.Partial({
|
|
548
|
+
dependencyBlacklist: r5.Undefined,
|
|
549
|
+
enforceForDevDependencies: r5.Undefined
|
|
550
|
+
})
|
|
551
|
+
),
|
|
552
|
+
r5.Record({
|
|
553
|
+
skipUnparseableRanges: r5.Boolean,
|
|
554
|
+
dependencyBlacklist: r5.Array(r5.String)
|
|
555
|
+
}).And(
|
|
556
|
+
r5.Partial({
|
|
557
|
+
dependencyWhitelist: r5.Undefined,
|
|
558
|
+
enforceForDevDependencies: r5.Undefined
|
|
559
|
+
})
|
|
560
|
+
),
|
|
561
|
+
r5.Record({
|
|
562
|
+
skipUnparseableRanges: r5.Boolean,
|
|
563
|
+
enforceForDevDependencies: r5.Boolean
|
|
564
|
+
}).And(
|
|
565
|
+
r5.Partial({
|
|
566
|
+
dependencyWhitelist: r5.Undefined,
|
|
567
|
+
dependencyBlacklist: r5.Undefined
|
|
568
|
+
})
|
|
569
|
+
),
|
|
570
|
+
r5.Record({
|
|
571
|
+
dependencyWhitelist: r5.Array(r5.String),
|
|
572
|
+
dependencyBlacklist: r5.Array(r5.String)
|
|
573
|
+
}).And(
|
|
574
|
+
r5.Partial({
|
|
575
|
+
skipUnparseableRanges: r5.Undefined,
|
|
576
|
+
enforceForDevDependencies: r5.Undefined
|
|
577
|
+
})
|
|
578
|
+
),
|
|
579
|
+
r5.Record({
|
|
580
|
+
dependencyWhitelist: r5.Array(r5.String),
|
|
581
|
+
enforceForDevDependencies: r5.Boolean
|
|
582
|
+
}).And(
|
|
583
|
+
r5.Partial({
|
|
584
|
+
skipUnparseableRanges: r5.Undefined,
|
|
585
|
+
dependencyBlacklist: r5.Undefined
|
|
586
|
+
})
|
|
587
|
+
),
|
|
588
|
+
r5.Record({
|
|
589
|
+
dependencyBlacklist: r5.Array(r5.String),
|
|
590
|
+
enforceForDevDependencies: r5.Boolean
|
|
591
|
+
}).And(
|
|
592
|
+
r5.Partial({
|
|
593
|
+
skipUnparseableRanges: r5.Undefined,
|
|
594
|
+
dependencyWhitelist: r5.Undefined
|
|
595
|
+
})
|
|
596
|
+
),
|
|
597
|
+
r5.Record({
|
|
598
|
+
skipUnparseableRanges: r5.Boolean,
|
|
599
|
+
dependencyWhitelist: r5.Array(r5.String),
|
|
600
|
+
dependencyBlacklist: r5.Array(r5.String)
|
|
601
|
+
}).And(
|
|
602
|
+
r5.Partial({
|
|
603
|
+
enforceForDevDependencies: r5.Undefined
|
|
604
|
+
})
|
|
605
|
+
),
|
|
606
|
+
r5.Record({
|
|
607
|
+
skipUnparseableRanges: r5.Boolean,
|
|
608
|
+
dependencyWhitelist: r5.Array(r5.String),
|
|
609
|
+
enforceForDevDependencies: r5.Boolean
|
|
610
|
+
}).And(
|
|
611
|
+
r5.Partial({
|
|
612
|
+
dependencyBlacklist: r5.Undefined
|
|
613
|
+
})
|
|
614
|
+
),
|
|
615
|
+
r5.Record({
|
|
616
|
+
skipUnparseableRanges: r5.Boolean,
|
|
617
|
+
dependencyBlacklist: r5.Array(r5.String),
|
|
618
|
+
enforceForDevDependencies: r5.Boolean
|
|
619
|
+
}).And(
|
|
620
|
+
r5.Partial({
|
|
621
|
+
dependencyWhitelist: r5.Undefined
|
|
622
|
+
})
|
|
623
|
+
),
|
|
624
|
+
r5.Record({
|
|
625
|
+
dependencyWhitelist: r5.Array(r5.String),
|
|
626
|
+
dependencyBlacklist: r5.Array(r5.String),
|
|
627
|
+
enforceForDevDependencies: r5.Boolean
|
|
628
|
+
}).And(
|
|
629
|
+
r5.Partial({
|
|
630
|
+
skipUnparseableRanges: r5.Undefined
|
|
631
|
+
})
|
|
632
|
+
),
|
|
633
|
+
r5.Record({
|
|
634
|
+
skipUnparseableRanges: r5.Boolean,
|
|
635
|
+
dependencyWhitelist: r5.Array(r5.String),
|
|
636
|
+
dependencyBlacklist: r5.Array(r5.String),
|
|
637
|
+
enforceForDevDependencies: r5.Boolean
|
|
638
|
+
})
|
|
639
|
+
);
|
|
640
|
+
var mustSatisfyPeerDependencies = createRuleFactory({
|
|
641
|
+
name: "mustSatisfyPeerDependencies",
|
|
642
|
+
check: checkSatisfyPeerDependencies,
|
|
643
|
+
validateOptions: Options5.check
|
|
644
|
+
});
|
|
645
|
+
var MATCH_ANY_VERSION_RANGE = /^(\*|x)$/;
|
|
646
|
+
var MATCH_GREATER_OR_EQUAL_VERSION_RANGE = /^>= ?\d+(?:\.\d+|\.\d+\.\d+(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?)?$/;
|
|
647
|
+
var MATCH_MAJOR_VERSION_RANGE = /^(?:\^?\d+|\^?\d+\.x|\^?\d+\.x\.x|\^\d+\.\d+|\^\d+\.\d+\.x|\^\d+\.\d+\.\d+(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?)$/;
|
|
648
|
+
var RANGE_REGEX = /^(\*|x|>= ?\d+(?:\.\d+|\.\d+\.\d+(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?)?|\^?\d+(\.x|\.x\.x|\.\d+|\.\d+\.x|\.\d+\.\d+(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?)?( \|\| \^?\d+(\.x|\.x\.x|\.\d+|\.\d+\.x|\.\d+\.\d+(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?)?)*)$/;
|
|
649
|
+
function checkSatisfyPeerDependencies(context, opts) {
|
|
650
|
+
const { dependencyBlacklist, dependencyWhitelist, enforceForDevDependencies, skipUnparseableRanges } = opts;
|
|
651
|
+
const packageJsonPath = path4.resolve(context.getPackageJsonPath());
|
|
652
|
+
const packageJson = context.host.readJson(packageJsonPath);
|
|
653
|
+
const packageDependencies = packageJson.dependencies || {};
|
|
654
|
+
const packageDevDependencies = packageJson.devDependencies || {};
|
|
655
|
+
const packagePeerDependencies = packageJson.peerDependencies || {};
|
|
656
|
+
const packageName = packageJson.name || packageJsonPath;
|
|
657
|
+
for (const [peerDependencyName, peerDependencyRange] of Object.entries(packagePeerDependencies)) {
|
|
658
|
+
if (shouldSkipPackage({ dependencyBlacklist, dependencyWhitelist, packageName: peerDependencyName })) {
|
|
659
|
+
continue;
|
|
660
|
+
}
|
|
661
|
+
const dependencyRange = packageDependencies[peerDependencyName];
|
|
662
|
+
if (dependencyRange != null) {
|
|
663
|
+
context.addError({
|
|
664
|
+
file: packageJsonPath,
|
|
665
|
+
message: `[0] Package ${packageName} has overloaded ${peerDependencyName} dependencies.
|
|
666
|
+
Peer dependency '${peerDependencyRange}' and regular dependency '${dependencyRange}'.`
|
|
667
|
+
});
|
|
668
|
+
}
|
|
669
|
+
}
|
|
670
|
+
const allRequiredPeerDependencies = {};
|
|
671
|
+
const allDependencies = enforceForDevDependencies ? [...Object.keys(packageDependencies), ...Object.keys(packageDevDependencies)] : Object.keys(packageDependencies);
|
|
672
|
+
for (const dependency of allDependencies) {
|
|
673
|
+
const dependencyPackageJsonPath = resolvePackagePath2(dependency, path4.dirname(packageJsonPath));
|
|
674
|
+
if (dependencyPackageJsonPath == null) {
|
|
675
|
+
throw new Error(`Could not resolve ${dependency} from ${path4.dirname(packageJsonPath)}`);
|
|
676
|
+
}
|
|
677
|
+
const dependencyPackageJson = context.host.readJson(dependencyPackageJsonPath);
|
|
678
|
+
const requiredPeerDependencies = dependencyPackageJson.peerDependencies;
|
|
679
|
+
if (requiredPeerDependencies == null) {
|
|
680
|
+
continue;
|
|
681
|
+
}
|
|
682
|
+
for (const [peerDependencyName, range] of Object.entries(requiredPeerDependencies)) {
|
|
683
|
+
if (shouldSkipPackage({ dependencyBlacklist, dependencyWhitelist, packageName: peerDependencyName })) {
|
|
684
|
+
continue;
|
|
685
|
+
}
|
|
686
|
+
if (!isValidRange(range)) {
|
|
687
|
+
const message = `Unable to parse ${dependencyPackageJson.name}'s ${peerDependencyName} peer dependency range '${range}'.`;
|
|
688
|
+
if (skipUnparseableRanges) {
|
|
689
|
+
context.addWarning({ file: dependencyPackageJsonPath, message });
|
|
690
|
+
continue;
|
|
691
|
+
}
|
|
692
|
+
throw new Error(message);
|
|
693
|
+
}
|
|
694
|
+
if (allRequiredPeerDependencies[peerDependencyName] == null) {
|
|
695
|
+
allRequiredPeerDependencies[peerDependencyName] = [];
|
|
696
|
+
}
|
|
697
|
+
allRequiredPeerDependencies[peerDependencyName].push({ fromPackageName: dependencyPackageJson.name, range });
|
|
698
|
+
}
|
|
699
|
+
}
|
|
700
|
+
for (const [peerDependencyName, peerDependencyRequirements] of Object.entries(allRequiredPeerDependencies)) {
|
|
701
|
+
let mostStrictPeerRequirement = {
|
|
702
|
+
fromPeerDependencyRequirements: [peerDependencyRequirements[0]],
|
|
703
|
+
range: peerDependencyRequirements[0].range
|
|
704
|
+
};
|
|
705
|
+
for (const peerRequirement of peerDependencyRequirements) {
|
|
706
|
+
if (doesASatisfyB(mostStrictPeerRequirement.range, peerRequirement.range)) {
|
|
707
|
+
continue;
|
|
708
|
+
} else if (doesASatisfyB(peerRequirement.range, mostStrictPeerRequirement.range)) {
|
|
709
|
+
mostStrictPeerRequirement = {
|
|
710
|
+
fromPeerDependencyRequirements: [peerRequirement],
|
|
711
|
+
range: peerRequirement.range
|
|
712
|
+
};
|
|
713
|
+
} else {
|
|
714
|
+
const maybeIntersection = findIntersection(peerRequirement.range, mostStrictPeerRequirement.range);
|
|
715
|
+
if (maybeIntersection !== void 0) {
|
|
716
|
+
mostStrictPeerRequirement = {
|
|
717
|
+
fromPeerDependencyRequirements: [
|
|
718
|
+
...mostStrictPeerRequirement.fromPeerDependencyRequirements,
|
|
719
|
+
peerRequirement
|
|
720
|
+
],
|
|
721
|
+
range: maybeIntersection
|
|
722
|
+
};
|
|
723
|
+
} else {
|
|
724
|
+
context.addError({
|
|
725
|
+
file: packageJsonPath,
|
|
726
|
+
message: `[1] Package ${packageName} has conflicting inherited ${peerDependencyName} peer dependencies.
|
|
727
|
+
Dependency ${peerRequirement.fromPackageName} requires '${peerRequirement.range}' but
|
|
728
|
+
` + getMostStrictStatement(mostStrictPeerRequirement)
|
|
729
|
+
});
|
|
730
|
+
}
|
|
731
|
+
}
|
|
732
|
+
}
|
|
733
|
+
const packageDependencyRange = packageDependencies[peerDependencyName];
|
|
734
|
+
if (packageDependencyRange != null) {
|
|
735
|
+
if (!isValidRange(packageDependencyRange)) {
|
|
736
|
+
const message = `Unable to parse ${packageName}'s ${peerDependencyName} dependency range '${packageDependencyRange}'.`;
|
|
737
|
+
if (skipUnparseableRanges) {
|
|
738
|
+
context.addWarning({ file: packageJsonPath, message });
|
|
739
|
+
} else {
|
|
740
|
+
throw new Error(message);
|
|
741
|
+
}
|
|
742
|
+
} else if (!doesASatisfyB(packageDependencyRange, mostStrictPeerRequirement.range)) {
|
|
743
|
+
context.addError({
|
|
744
|
+
file: packageJsonPath,
|
|
745
|
+
message: `[2] Package ${packageName} dependency on ${peerDependencyName} '${packageDependencyRange}' does not satisfy inherited peer dependencies.
|
|
746
|
+
` + getMostStrictStatement(mostStrictPeerRequirement)
|
|
747
|
+
});
|
|
748
|
+
}
|
|
749
|
+
}
|
|
750
|
+
const packagePeerDependencyRange = packagePeerDependencies[peerDependencyName];
|
|
751
|
+
if (packageDependencyRange == null && packagePeerDependencyRange == null) {
|
|
752
|
+
context.addError({
|
|
753
|
+
file: packageJsonPath,
|
|
754
|
+
message: `[3] Package ${packageName} is missing required ${peerDependencyName} dependency.
|
|
755
|
+
` + getMostStrictStatement(mostStrictPeerRequirement),
|
|
756
|
+
fixer: getAddDependencyTypeFixer({
|
|
757
|
+
packageJsonPath,
|
|
758
|
+
dependencyType: "peerDependencies",
|
|
759
|
+
dependencyName: peerDependencyName,
|
|
760
|
+
version: mostStrictPeerRequirement.range,
|
|
761
|
+
host: context.host
|
|
762
|
+
})
|
|
763
|
+
});
|
|
764
|
+
}
|
|
765
|
+
if (packagePeerDependencyRange != null) {
|
|
766
|
+
if (!isValidRange(packagePeerDependencyRange)) {
|
|
767
|
+
const message = `Unable to parse ${packageName}'s ${peerDependencyName} peer dependency range '${packagePeerDependencyRange}'.`;
|
|
768
|
+
if (skipUnparseableRanges) {
|
|
769
|
+
context.addWarning({ file: packageJsonPath, message });
|
|
770
|
+
} else {
|
|
771
|
+
throw new Error(message);
|
|
772
|
+
}
|
|
773
|
+
} else if (!doesASatisfyB(packagePeerDependencyRange, mostStrictPeerRequirement.range)) {
|
|
774
|
+
context.addError({
|
|
775
|
+
file: packageJsonPath,
|
|
776
|
+
message: `[4] Package ${packageName} peer dependency on ${peerDependencyName} '${packagePeerDependencyRange}' is not strict enough.
|
|
777
|
+
` + getMostStrictStatement(mostStrictPeerRequirement),
|
|
778
|
+
fixer: getAddDependencyTypeFixer({
|
|
779
|
+
packageJsonPath,
|
|
780
|
+
dependencyType: "peerDependencies",
|
|
781
|
+
dependencyName: peerDependencyName,
|
|
782
|
+
version: mostStrictPeerRequirement.range,
|
|
783
|
+
host: context.host
|
|
784
|
+
})
|
|
785
|
+
});
|
|
786
|
+
}
|
|
787
|
+
}
|
|
788
|
+
}
|
|
789
|
+
}
|
|
790
|
+
function shouldSkipPackage({
|
|
791
|
+
dependencyBlacklist,
|
|
792
|
+
dependencyWhitelist,
|
|
793
|
+
packageName
|
|
794
|
+
}) {
|
|
795
|
+
if (dependencyBlacklist != null && dependencyBlacklist.includes(packageName) || dependencyWhitelist != null && !dependencyWhitelist.includes(packageName)) {
|
|
796
|
+
return true;
|
|
797
|
+
}
|
|
798
|
+
return false;
|
|
799
|
+
}
|
|
800
|
+
function getMostStrictStatement(mostStrictPeerRequirement) {
|
|
801
|
+
if (mostStrictPeerRequirement.fromPeerDependencyRequirements.length === 1) {
|
|
802
|
+
const dependencyName = mostStrictPeerRequirement.fromPeerDependencyRequirements[0].fromPackageName;
|
|
803
|
+
return `Dependency ${dependencyName} requires '${mostStrictPeerRequirement.range}'.`;
|
|
804
|
+
} else {
|
|
805
|
+
const dependencyNames = mostStrictPeerRequirement.fromPeerDependencyRequirements.map((peerDependencyRequirement) => peerDependencyRequirement.fromPackageName).join(", ");
|
|
806
|
+
const dependencyRequirements = mostStrictPeerRequirement.fromPeerDependencyRequirements.map((peerDependencyRequirement) => `'${peerDependencyRequirement.range}'`).join(", ");
|
|
807
|
+
return `Dependencies [${dependencyNames}] require [${dependencyRequirements}] respectively, resolving to '${mostStrictPeerRequirement.range}'.`;
|
|
808
|
+
}
|
|
809
|
+
}
|
|
810
|
+
function findIntersection(a, b) {
|
|
811
|
+
if (doesASatisfyB(a, b)) {
|
|
812
|
+
return a;
|
|
813
|
+
} else if (doesASatisfyB(b, a)) {
|
|
814
|
+
return b;
|
|
815
|
+
}
|
|
816
|
+
if (isAnyVersionRange(a) || isAnyVersionRange(b)) {
|
|
817
|
+
throw new Error();
|
|
818
|
+
}
|
|
819
|
+
const aVersions = a.includes("||") ? a.split("||").map((s) => s.trim()) : [a];
|
|
820
|
+
const bVersions = b.includes("||") ? b.split("||").map((s) => s.trim()) : [b];
|
|
821
|
+
const aIsGreaterOrEqualVersionRange = isGreaterOrEqualVersionRange(a);
|
|
822
|
+
const bIsGreaterOrEqualVersionRange = isGreaterOrEqualVersionRange(b);
|
|
823
|
+
if (aIsGreaterOrEqualVersionRange && bIsGreaterOrEqualVersionRange) {
|
|
824
|
+
throw new Error();
|
|
825
|
+
}
|
|
826
|
+
if (aIsGreaterOrEqualVersionRange) {
|
|
827
|
+
const aSemVer = coerce2(a);
|
|
828
|
+
const compatibleBVersions = bVersions.map((bVersion) => {
|
|
829
|
+
const bSemVer = coerce2(bVersion);
|
|
830
|
+
if (bVersion.startsWith("^") && bSemVer.major >= aSemVer.major) {
|
|
831
|
+
return `^${bSemVer.compare(aSemVer) >= 0 ? bSemVer.raw : aSemVer.raw}`;
|
|
832
|
+
}
|
|
833
|
+
return bSemVer.compare(aSemVer) !== -1 ? bVersion : void 0;
|
|
834
|
+
}).filter((bVersion) => bVersion != null);
|
|
835
|
+
if (compatibleBVersions.length === 0) {
|
|
836
|
+
return void 0;
|
|
837
|
+
}
|
|
838
|
+
return compatibleBVersions.join(" || ");
|
|
839
|
+
}
|
|
840
|
+
if (bIsGreaterOrEqualVersionRange) {
|
|
841
|
+
const bSemVer = coerce2(b);
|
|
842
|
+
const compatibleAVersions = aVersions.map((aVersion) => {
|
|
843
|
+
const aSemVer = coerce2(aVersion);
|
|
844
|
+
if (aVersion.startsWith("^") && aSemVer.major >= bSemVer.major) {
|
|
845
|
+
return `^${aSemVer.compare(bSemVer) >= 0 ? aSemVer.raw : bSemVer.raw}`;
|
|
846
|
+
}
|
|
847
|
+
return aSemVer.compare(bSemVer) !== -1 ? aVersion : void 0;
|
|
848
|
+
}).filter((aVersion) => aVersion != null);
|
|
849
|
+
if (compatibleAVersions.length === 0) {
|
|
850
|
+
return void 0;
|
|
851
|
+
}
|
|
852
|
+
return compatibleAVersions.join(" || ");
|
|
853
|
+
}
|
|
854
|
+
const compatibleVersions = aVersions.map((aVersion) => {
|
|
855
|
+
const aSemVer = coerce2(aVersion);
|
|
856
|
+
const majorMatchingBVersion = bVersions.find((m) => coerce2(m).major === aSemVer.major);
|
|
857
|
+
if (majorMatchingBVersion === void 0) {
|
|
858
|
+
return void 0;
|
|
859
|
+
}
|
|
860
|
+
if (doesASatisfyB(aVersion, majorMatchingBVersion)) {
|
|
861
|
+
return aVersion;
|
|
862
|
+
} else if (doesASatisfyB(majorMatchingBVersion, aVersion)) {
|
|
863
|
+
return majorMatchingBVersion;
|
|
864
|
+
} else {
|
|
865
|
+
return void 0;
|
|
866
|
+
}
|
|
867
|
+
}).filter((aVersion) => aVersion !== void 0);
|
|
868
|
+
if (compatibleVersions.length === 0) {
|
|
869
|
+
return void 0;
|
|
870
|
+
}
|
|
871
|
+
return compatibleVersions.join(" || ");
|
|
872
|
+
}
|
|
873
|
+
function doesASatisfyB(a, b) {
|
|
874
|
+
if (a === b) {
|
|
875
|
+
return true;
|
|
876
|
+
}
|
|
877
|
+
const aIsAnyVersionRange = isAnyVersionRange(a);
|
|
878
|
+
const bIsAnyVersionRange = isAnyVersionRange(b);
|
|
879
|
+
if (bIsAnyVersionRange) {
|
|
880
|
+
return true;
|
|
881
|
+
} else if (aIsAnyVersionRange) {
|
|
882
|
+
return false;
|
|
883
|
+
}
|
|
884
|
+
const aVersions = a.includes("||") ? a.split("||").map((s) => s.trim()) : [a];
|
|
885
|
+
const bVersions = b.includes("||") ? b.split("||").map((s) => s.trim()) : [b];
|
|
886
|
+
const aIsGreaterOrEqualVersionRange = isGreaterOrEqualVersionRange(a);
|
|
887
|
+
const bIsGreaterOrEqualVersionRange = isGreaterOrEqualVersionRange(b);
|
|
888
|
+
if (aIsGreaterOrEqualVersionRange && bIsGreaterOrEqualVersionRange) {
|
|
889
|
+
const aSemVer = coerce2(a);
|
|
890
|
+
const bSemVer = coerce2(b);
|
|
891
|
+
return aSemVer.compare(bSemVer) !== -1;
|
|
892
|
+
} else if (bIsGreaterOrEqualVersionRange) {
|
|
893
|
+
const bSemVer = coerce2(b);
|
|
894
|
+
return aVersions.every((aVersion) => {
|
|
895
|
+
const aSemVer = coerce2(aVersion);
|
|
896
|
+
return aSemVer.compare(bSemVer) !== -1;
|
|
897
|
+
});
|
|
898
|
+
} else if (aIsGreaterOrEqualVersionRange) {
|
|
899
|
+
return false;
|
|
900
|
+
}
|
|
901
|
+
return aVersions.every((aVersion) => {
|
|
902
|
+
const aSemVer = coerce2(aVersion);
|
|
903
|
+
const majorMatchingBVersion = bVersions.find((m) => coerce2(m).major === aSemVer.major);
|
|
904
|
+
if (majorMatchingBVersion === void 0) {
|
|
905
|
+
return false;
|
|
906
|
+
}
|
|
907
|
+
const aVersionIsRange = isMajorVersionRange(aVersion);
|
|
908
|
+
const majorMatchingBSemVer = coerce2(majorMatchingBVersion);
|
|
909
|
+
const majorMatchingBVersionIsRange = isMajorVersionRange(majorMatchingBVersion);
|
|
910
|
+
if (majorMatchingBVersionIsRange) {
|
|
911
|
+
return aSemVer.compare(majorMatchingBSemVer) !== -1;
|
|
912
|
+
} else {
|
|
913
|
+
if (aVersionIsRange) {
|
|
914
|
+
return false;
|
|
915
|
+
} else {
|
|
916
|
+
return aSemVer.compare(majorMatchingBSemVer) === 0;
|
|
917
|
+
}
|
|
918
|
+
}
|
|
919
|
+
});
|
|
920
|
+
}
|
|
921
|
+
function isAnyVersionRange(version) {
|
|
922
|
+
return MATCH_ANY_VERSION_RANGE.test(version);
|
|
923
|
+
}
|
|
924
|
+
function isGreaterOrEqualVersionRange(version) {
|
|
925
|
+
return MATCH_GREATER_OR_EQUAL_VERSION_RANGE.test(version);
|
|
926
|
+
}
|
|
927
|
+
function isMajorVersionRange(version) {
|
|
928
|
+
return MATCH_MAJOR_VERSION_RANGE.test(version);
|
|
929
|
+
}
|
|
930
|
+
function isValidRange(version) {
|
|
931
|
+
return RANGE_REGEX.test(version);
|
|
932
|
+
}
|
|
933
|
+
function getAddDependencyTypeFixer({
|
|
934
|
+
packageJsonPath,
|
|
935
|
+
dependencyType,
|
|
936
|
+
dependencyName,
|
|
937
|
+
version,
|
|
938
|
+
host
|
|
939
|
+
}) {
|
|
940
|
+
return () => {
|
|
941
|
+
mutateJson2(packageJsonPath, host, (packageJson) => {
|
|
942
|
+
if (packageJson[dependencyType] == null) {
|
|
943
|
+
packageJson[dependencyType] = {};
|
|
944
|
+
}
|
|
945
|
+
packageJson[dependencyType][dependencyName] = version;
|
|
946
|
+
return packageJson;
|
|
947
|
+
});
|
|
948
|
+
};
|
|
949
|
+
}
|
|
950
|
+
|
|
951
|
+
// src/packageOrder.ts
|
|
952
|
+
import { diff as diff4 } from "jest-diff";
|
|
953
|
+
import * as r6 from "runtypes";
|
|
954
|
+
var Options6 = r6.Record({
|
|
955
|
+
order: r6.Union(r6.Array(r6.String), r6.Function)
|
|
956
|
+
}).Or(r6.Undefined);
|
|
957
|
+
var defaultKeyOrder = [
|
|
958
|
+
"name",
|
|
959
|
+
"version",
|
|
960
|
+
"description",
|
|
961
|
+
"author",
|
|
962
|
+
"contributors",
|
|
963
|
+
"url",
|
|
964
|
+
"license",
|
|
965
|
+
"type",
|
|
966
|
+
"exports",
|
|
967
|
+
"private",
|
|
968
|
+
"engines",
|
|
969
|
+
"bin",
|
|
970
|
+
"types",
|
|
971
|
+
"main",
|
|
972
|
+
"module",
|
|
973
|
+
"typings",
|
|
974
|
+
"style",
|
|
975
|
+
"sideEffects",
|
|
976
|
+
"workspaces",
|
|
977
|
+
"husky",
|
|
978
|
+
"lint-staged",
|
|
979
|
+
"files",
|
|
980
|
+
"scripts",
|
|
981
|
+
"resolutions",
|
|
982
|
+
"dependencies",
|
|
983
|
+
"peerDependencies",
|
|
984
|
+
"devDependencies",
|
|
985
|
+
"optionalDependencies",
|
|
986
|
+
"publishConfig"
|
|
987
|
+
];
|
|
988
|
+
var packageOrder = createRuleFactory({
|
|
989
|
+
name: "packageOrder",
|
|
990
|
+
check: (context, opts) => {
|
|
991
|
+
const packageJson = context.getPackageJson();
|
|
992
|
+
const packagePath = context.getPackageJsonPath();
|
|
993
|
+
const order = opts === void 0 ? defaultKeyOrder : opts.order;
|
|
994
|
+
const comparator = isOrderFunction(order) ? order(context) : createComparator(order);
|
|
995
|
+
const actualOrder = Object.keys(packageJson);
|
|
996
|
+
const expectedOrder = actualOrder.slice().sort(comparator);
|
|
997
|
+
if (!arrayOrderCompare2(actualOrder, expectedOrder)) {
|
|
998
|
+
context.addError({
|
|
999
|
+
file: packagePath,
|
|
1000
|
+
message: "Incorrect order of fields in package.json",
|
|
1001
|
+
longMessage: diff4(expectedOrder, actualOrder, { expand: true }),
|
|
1002
|
+
fixer: () => {
|
|
1003
|
+
const expectedPackageJson = {};
|
|
1004
|
+
expectedOrder.forEach((key) => {
|
|
1005
|
+
expectedPackageJson[key] = packageJson[key];
|
|
1006
|
+
});
|
|
1007
|
+
context.host.writeJson(packagePath, expectedPackageJson);
|
|
1008
|
+
}
|
|
1009
|
+
});
|
|
1010
|
+
}
|
|
1011
|
+
},
|
|
1012
|
+
validateOptions: Options6.check
|
|
1013
|
+
});
|
|
1014
|
+
function arrayOrderCompare2(a, b) {
|
|
1015
|
+
for (let index = 0; index < a.length; index++) {
|
|
1016
|
+
if (a[index] !== b[index]) {
|
|
1017
|
+
return false;
|
|
1018
|
+
}
|
|
1019
|
+
}
|
|
1020
|
+
return true;
|
|
1021
|
+
}
|
|
1022
|
+
function createComparator(order) {
|
|
1023
|
+
return (a, b) => {
|
|
1024
|
+
const aIndex = order.indexOf(a);
|
|
1025
|
+
const bIndex = order.indexOf(b);
|
|
1026
|
+
if (aIndex >= 0 && bIndex < 0) {
|
|
1027
|
+
return -1;
|
|
1028
|
+
} else if (aIndex < 0 && bIndex >= 0) {
|
|
1029
|
+
return 1;
|
|
1030
|
+
}
|
|
1031
|
+
const compared = aIndex - bIndex;
|
|
1032
|
+
if (compared !== 0) {
|
|
1033
|
+
return compared;
|
|
1034
|
+
} else {
|
|
1035
|
+
return a.localeCompare(b);
|
|
1036
|
+
}
|
|
1037
|
+
};
|
|
1038
|
+
}
|
|
1039
|
+
function isOrderFunction(order) {
|
|
1040
|
+
return !Array.isArray(order);
|
|
1041
|
+
}
|
|
1042
|
+
|
|
1043
|
+
// src/packageEntry.ts
|
|
1044
|
+
import { mutateJson as mutateJson3 } from "@monorepolint/utils";
|
|
1045
|
+
import { diff as diff5 } from "jest-diff";
|
|
1046
|
+
import * as r7 from "runtypes";
|
|
1047
|
+
var Options7 = r7.Union(
|
|
1048
|
+
r7.Record({
|
|
1049
|
+
entries: r7.Dictionary(r7.Unknown)
|
|
1050
|
+
// string => unknown, enforces existence of keys and their values
|
|
1051
|
+
}).And(
|
|
1052
|
+
r7.Partial({
|
|
1053
|
+
entriesExist: r7.Undefined
|
|
1054
|
+
})
|
|
1055
|
+
),
|
|
1056
|
+
r7.Record({
|
|
1057
|
+
entriesExist: r7.Array(r7.String)
|
|
1058
|
+
// enforces existence of keys, but not values
|
|
1059
|
+
}).And(
|
|
1060
|
+
r7.Partial({
|
|
1061
|
+
entries: r7.Undefined
|
|
1062
|
+
})
|
|
1063
|
+
),
|
|
1064
|
+
r7.Record({
|
|
1065
|
+
entries: r7.Dictionary(r7.Unknown),
|
|
1066
|
+
// string => unknown, enforces existence of keys and their values
|
|
1067
|
+
entriesExist: r7.Array(r7.String)
|
|
1068
|
+
})
|
|
1069
|
+
);
|
|
1070
|
+
var packageEntry = createRuleFactory({
|
|
1071
|
+
name: "packageEntry",
|
|
1072
|
+
check: (context, options) => {
|
|
1073
|
+
const packageJson = context.getPackageJson();
|
|
1074
|
+
if (options.entries) {
|
|
1075
|
+
for (const key of Object.keys(options.entries)) {
|
|
1076
|
+
const value = options.entries[key];
|
|
1077
|
+
const entryDiff = diff5(JSON.stringify(value) + "\n", (JSON.stringify(packageJson[key]) || "") + "\n");
|
|
1078
|
+
if (typeof value !== "object" && value !== packageJson[key] || entryDiff == null || !entryDiff.includes("Compared values have no visual difference")) {
|
|
1079
|
+
context.addError({
|
|
1080
|
+
file: context.getPackageJsonPath(),
|
|
1081
|
+
message: createStandardizedEntryErrorMessage(key),
|
|
1082
|
+
longMessage: entryDiff,
|
|
1083
|
+
fixer: () => {
|
|
1084
|
+
mutateJson3(context.getPackageJsonPath(), context.host, (input) => {
|
|
1085
|
+
input[key] = value;
|
|
1086
|
+
return input;
|
|
1087
|
+
});
|
|
1088
|
+
}
|
|
1089
|
+
});
|
|
1090
|
+
}
|
|
1091
|
+
}
|
|
1092
|
+
}
|
|
1093
|
+
if (options.entriesExist) {
|
|
1094
|
+
for (const key of options.entriesExist) {
|
|
1095
|
+
if (packageJson[key] === void 0) {
|
|
1096
|
+
context.addError({
|
|
1097
|
+
file: context.getPackageJsonPath(),
|
|
1098
|
+
message: createExpectedEntryErrorMessage(key)
|
|
1099
|
+
});
|
|
1100
|
+
}
|
|
1101
|
+
}
|
|
1102
|
+
}
|
|
1103
|
+
},
|
|
1104
|
+
validateOptions: Options7.check
|
|
1105
|
+
});
|
|
1106
|
+
function createStandardizedEntryErrorMessage(key) {
|
|
1107
|
+
return `Expected standardized entry for '${key}'`;
|
|
1108
|
+
}
|
|
1109
|
+
function createExpectedEntryErrorMessage(key) {
|
|
1110
|
+
return `Expected entry for '${key}' to exist`;
|
|
1111
|
+
}
|
|
1112
|
+
|
|
1113
|
+
// src/packageScript.ts
|
|
1114
|
+
import { mutateJson as mutateJson4 } from "@monorepolint/utils";
|
|
1115
|
+
import { diff as diff6 } from "jest-diff";
|
|
1116
|
+
import * as r8 from "runtypes";
|
|
1117
|
+
var Options8 = r8.Record({
|
|
1118
|
+
scripts: r8.Dictionary(
|
|
1119
|
+
r8.Union(
|
|
1120
|
+
r8.String,
|
|
1121
|
+
r8.Record({
|
|
1122
|
+
options: r8.Array(r8.String.Or(r8.Undefined)),
|
|
1123
|
+
fixValue: r8.Union(r8.String, r8.Undefined, r8.Literal(false)).optional()
|
|
1124
|
+
})
|
|
1125
|
+
)
|
|
1126
|
+
)
|
|
1127
|
+
// string => string
|
|
1128
|
+
});
|
|
1129
|
+
var MSG_NO_SCRIPTS_BLOCK = "No scripts block in package.json";
|
|
1130
|
+
var packageScript = createRuleFactory({
|
|
1131
|
+
name: "packageScript",
|
|
1132
|
+
check: (context, options) => {
|
|
1133
|
+
const packageJson = context.getPackageJson();
|
|
1134
|
+
if (packageJson.scripts === void 0) {
|
|
1135
|
+
context.addError({
|
|
1136
|
+
file: context.getPackageJsonPath(),
|
|
1137
|
+
message: MSG_NO_SCRIPTS_BLOCK,
|
|
1138
|
+
fixer: () => {
|
|
1139
|
+
mutateJson4(context.getPackageJsonPath(), context.host, (input) => {
|
|
1140
|
+
input.scripts = {};
|
|
1141
|
+
return input;
|
|
1142
|
+
});
|
|
1143
|
+
}
|
|
1144
|
+
});
|
|
1145
|
+
return;
|
|
1146
|
+
}
|
|
1147
|
+
for (const [name, value] of Object.entries(options.scripts)) {
|
|
1148
|
+
const allowedValues = /* @__PURE__ */ new Set();
|
|
1149
|
+
let fixValue;
|
|
1150
|
+
let allowEmpty = false;
|
|
1151
|
+
let fixToEmpty = false;
|
|
1152
|
+
if (typeof value === "string") {
|
|
1153
|
+
allowedValues.add(value);
|
|
1154
|
+
fixValue = value;
|
|
1155
|
+
} else {
|
|
1156
|
+
for (const q of value.options) {
|
|
1157
|
+
if (q === void 0) {
|
|
1158
|
+
allowEmpty = true;
|
|
1159
|
+
}
|
|
1160
|
+
allowedValues.add(q);
|
|
1161
|
+
}
|
|
1162
|
+
fixToEmpty = Object.prototype.hasOwnProperty.call(value, "fixValue") && value.fixValue === void 0;
|
|
1163
|
+
fixValue = value.fixValue;
|
|
1164
|
+
}
|
|
1165
|
+
const actualValue = packageJson.scripts[name];
|
|
1166
|
+
if (!allowedValues.has(actualValue) && !(allowEmpty === true && actualValue === void 0)) {
|
|
1167
|
+
let fixer;
|
|
1168
|
+
if (fixValue !== false && (fixValue !== void 0 || fixToEmpty === true)) {
|
|
1169
|
+
const q = fixValue;
|
|
1170
|
+
fixer = () => {
|
|
1171
|
+
mutateJson4(context.getPackageJsonPath(), context.host, (input) => {
|
|
1172
|
+
if (fixToEmpty && q === void 0) {
|
|
1173
|
+
delete input.scripts[name];
|
|
1174
|
+
} else {
|
|
1175
|
+
input.scripts[name] = q;
|
|
1176
|
+
}
|
|
1177
|
+
return input;
|
|
1178
|
+
});
|
|
1179
|
+
};
|
|
1180
|
+
}
|
|
1181
|
+
const validOptionsString = Array.from(allowedValues.values()).map((a) => a === void 0 ? "(empty)" : `'${a}'`).join(", ");
|
|
1182
|
+
context.addError({
|
|
1183
|
+
file: context.getPackageJsonPath(),
|
|
1184
|
+
message: `Expected standardized script entry for '${name}'. Valid options: ${validOptionsString}`,
|
|
1185
|
+
longMessage: diff6(validOptionsString + "\n", (packageJson.scripts[name] || "") + "\n"),
|
|
1186
|
+
fixer
|
|
1187
|
+
});
|
|
1188
|
+
}
|
|
1189
|
+
}
|
|
1190
|
+
},
|
|
1191
|
+
validateOptions: Options8.check
|
|
1192
|
+
});
|
|
1193
|
+
|
|
1194
|
+
// src/standardTsconfig.ts
|
|
1195
|
+
import { matchesAnyGlob as matchesAnyGlob2 } from "@monorepolint/utils";
|
|
1196
|
+
import { diff as diff7 } from "jest-diff";
|
|
1197
|
+
import * as path5 from "path";
|
|
1198
|
+
import * as r9 from "runtypes";
|
|
1199
|
+
var DEFAULT_TSCONFIG_FILENAME = "tsconfig.json";
|
|
1200
|
+
var Options9 = r9.Partial({
|
|
1201
|
+
file: r9.String,
|
|
1202
|
+
generator: r9.Function,
|
|
1203
|
+
tsconfigReferenceFile: r9.String,
|
|
1204
|
+
template: r9.Record({}).Or(r9.String),
|
|
1205
|
+
templateFile: r9.String,
|
|
1206
|
+
excludedReferences: r9.Array(r9.String).Or(r9.Undefined),
|
|
1207
|
+
additionalReferences: r9.Array(r9.String).Or(r9.Undefined)
|
|
1208
|
+
}).withConstraint(({ generator, template, templateFile }) => {
|
|
1209
|
+
let count = 0;
|
|
1210
|
+
if (generator) {
|
|
1211
|
+
count++;
|
|
1212
|
+
}
|
|
1213
|
+
if (template) {
|
|
1214
|
+
count++;
|
|
1215
|
+
}
|
|
1216
|
+
if (templateFile) {
|
|
1217
|
+
count++;
|
|
1218
|
+
}
|
|
1219
|
+
return count === 1 || "Expect one of { generator, template, templateFile }";
|
|
1220
|
+
});
|
|
1221
|
+
var standardTsconfig = createRuleFactory({
|
|
1222
|
+
name: "standardTsconfig",
|
|
1223
|
+
check: async (context, opts) => {
|
|
1224
|
+
const tsconfigFileName = opts.file ?? DEFAULT_TSCONFIG_FILENAME;
|
|
1225
|
+
const fullPath = path5.resolve(context.packageDir, tsconfigFileName);
|
|
1226
|
+
const generator = getGenerator(context, opts);
|
|
1227
|
+
const expectedContent = await generator(context);
|
|
1228
|
+
const actualContent = context.host.exists(fullPath) ? context.host.readFile(fullPath, { encoding: "utf-8" }) : void 0;
|
|
1229
|
+
if (expectedContent === void 0) {
|
|
1230
|
+
context.addWarning({
|
|
1231
|
+
file: fullPath,
|
|
1232
|
+
message: "Excluding from expect-standard-tsconfig"
|
|
1233
|
+
});
|
|
1234
|
+
return;
|
|
1235
|
+
}
|
|
1236
|
+
if (actualContent !== expectedContent) {
|
|
1237
|
+
context.addError({
|
|
1238
|
+
file: fullPath,
|
|
1239
|
+
message: "Expect file contents to match",
|
|
1240
|
+
longMessage: diff7(expectedContent, actualContent, { expand: true }),
|
|
1241
|
+
fixer: () => {
|
|
1242
|
+
context.host.writeFile(fullPath, expectedContent, {
|
|
1243
|
+
encoding: "utf-8"
|
|
1244
|
+
});
|
|
1245
|
+
}
|
|
1246
|
+
});
|
|
1247
|
+
}
|
|
1248
|
+
},
|
|
1249
|
+
validateOptions: Options9.check
|
|
1250
|
+
});
|
|
1251
|
+
function getGenerator(context, opts) {
|
|
1252
|
+
if (opts.generator) {
|
|
1253
|
+
return opts.generator;
|
|
1254
|
+
} else if (opts.templateFile) {
|
|
1255
|
+
const { packageDir: workspacePackageDir } = context.getWorkspaceContext();
|
|
1256
|
+
const fullPath = path5.resolve(workspacePackageDir, opts.templateFile);
|
|
1257
|
+
const template = JSON.parse(context.host.readFile(fullPath, { encoding: "utf-8" }));
|
|
1258
|
+
return makeGenerator(template, opts.excludedReferences, opts.additionalReferences, opts.tsconfigReferenceFile);
|
|
1259
|
+
} else if (opts.template) {
|
|
1260
|
+
return makeGenerator(opts.template, opts.excludedReferences, opts.additionalReferences, opts.tsconfigReferenceFile);
|
|
1261
|
+
} else {
|
|
1262
|
+
throw new Error("Unable to make generator");
|
|
1263
|
+
}
|
|
1264
|
+
}
|
|
1265
|
+
function makeGenerator(template, excludedReferences, additionalReferences, tsconfigReferenceFile) {
|
|
1266
|
+
return async function generator(context) {
|
|
1267
|
+
template = {
|
|
1268
|
+
...template,
|
|
1269
|
+
references: []
|
|
1270
|
+
};
|
|
1271
|
+
const nameToDirectory = await context.getWorkspaceContext().getPackageNameToDir();
|
|
1272
|
+
const packageJson = context.getPackageJson();
|
|
1273
|
+
const deps = [...Object.keys(packageJson.dependencies || {}), ...Object.keys(packageJson.devDependencies || {})];
|
|
1274
|
+
for (const dep of deps) {
|
|
1275
|
+
const packageDir = nameToDirectory.get(dep);
|
|
1276
|
+
if (packageDir !== void 0 && (excludedReferences === void 0 || !matchesAnyGlob2(dep, excludedReferences))) {
|
|
1277
|
+
const absoluteReferencePath = tsconfigReferenceFile !== void 0 ? path5.join(packageDir, tsconfigReferenceFile) : packageDir;
|
|
1278
|
+
template.references.push({
|
|
1279
|
+
path: path5.relative(context.packageDir, absoluteReferencePath)
|
|
1280
|
+
});
|
|
1281
|
+
}
|
|
1282
|
+
}
|
|
1283
|
+
if (additionalReferences) {
|
|
1284
|
+
for (const additionalReference of additionalReferences) {
|
|
1285
|
+
template.references.push({
|
|
1286
|
+
path: additionalReference
|
|
1287
|
+
});
|
|
1288
|
+
}
|
|
1289
|
+
}
|
|
1290
|
+
return JSON.stringify(template, void 0, 2) + "\n";
|
|
1291
|
+
};
|
|
1292
|
+
}
|
|
1293
|
+
|
|
1294
|
+
// src/nestedWorkspaces.ts
|
|
1295
|
+
import * as globby from "globby";
|
|
1296
|
+
import * as path6 from "node:path";
|
|
1297
|
+
import * as r10 from "runtypes";
|
|
1298
|
+
var Options10 = r10.Undefined;
|
|
1299
|
+
var nestedWorkspaces = createRuleFactory({
|
|
1300
|
+
name: "nestedWorkspaces",
|
|
1301
|
+
check: (context) => {
|
|
1302
|
+
const rootPackageJson = context.getWorkspaceContext().getPackageJson();
|
|
1303
|
+
const packageJsonPaths = globby.globbySync(["*/**/package.json", "!**/node_modules/**"]);
|
|
1304
|
+
const workspaces = Array.isArray(rootPackageJson.workspaces) ? rootPackageJson.workspaces : rootPackageJson.workspaces !== void 0 ? rootPackageJson.workspaces.packages : void 0;
|
|
1305
|
+
if (workspaces === void 0 && packageJsonPaths.length > 0) {
|
|
1306
|
+
context.addError({
|
|
1307
|
+
file: context.getPackageJsonPath(),
|
|
1308
|
+
message: 'The "workspace" field is missing, even though there are workspaces in the repository.'
|
|
1309
|
+
});
|
|
1310
|
+
return;
|
|
1311
|
+
}
|
|
1312
|
+
const workspacePackageJsons = (workspaces || []).map((item) => `${item}/package.json`);
|
|
1313
|
+
const expandedWorkspacesGlobs = globby.globbySync([...workspacePackageJsons, "!**/node_modules/**"]);
|
|
1314
|
+
const difference = packageJsonPaths.filter((packageJsonPath) => !expandedWorkspacesGlobs.includes(packageJsonPath));
|
|
1315
|
+
if (difference.length !== 0) {
|
|
1316
|
+
const differencesList = difference.map((packageJsonPath) => path6.dirname(packageJsonPath)).join(", ");
|
|
1317
|
+
context.addError({
|
|
1318
|
+
file: context.getPackageJsonPath(),
|
|
1319
|
+
message: `The "workspace" field is missing one or more values: ${differencesList}. You may be able to use a glob to avoid listing each workspace individually, e.g. "packages/nested-workspace/*".`
|
|
1320
|
+
});
|
|
1321
|
+
}
|
|
1322
|
+
},
|
|
1323
|
+
validateOptions: Options10.check
|
|
1324
|
+
});
|
|
1325
|
+
|
|
1326
|
+
// src/requireDependency.ts
|
|
1327
|
+
import { mutateJson as mutateJson5 } from "@monorepolint/utils";
|
|
1328
|
+
import { diff as diff8 } from "jest-diff";
|
|
1329
|
+
import * as r11 from "runtypes";
|
|
1330
|
+
var Options11 = r11.Partial({
|
|
1331
|
+
dependencies: r11.Dictionary(r11.String),
|
|
1332
|
+
devDependencies: r11.Dictionary(r11.String),
|
|
1333
|
+
peerDependencies: r11.Dictionary(r11.String),
|
|
1334
|
+
optionalDependencies: r11.Dictionary(r11.String)
|
|
1335
|
+
});
|
|
1336
|
+
var requireDependency = createRuleFactory({
|
|
1337
|
+
name: "requireDependency",
|
|
1338
|
+
check: function expectPackageEntry(context, options) {
|
|
1339
|
+
const packageJson = context.getPackageJson();
|
|
1340
|
+
const packageJsonPath = context.getPackageJsonPath();
|
|
1341
|
+
[
|
|
1342
|
+
"dependencies",
|
|
1343
|
+
"devDependencies",
|
|
1344
|
+
"peerDependencies",
|
|
1345
|
+
"optionalDependencies"
|
|
1346
|
+
].forEach((type) => {
|
|
1347
|
+
var _a;
|
|
1348
|
+
if (!options[type]) {
|
|
1349
|
+
return;
|
|
1350
|
+
}
|
|
1351
|
+
if (packageJson[type] === void 0) {
|
|
1352
|
+
context.addError({
|
|
1353
|
+
file: packageJsonPath,
|
|
1354
|
+
message: `No ${type} block, cannot add required ${type}.`,
|
|
1355
|
+
fixer: () => {
|
|
1356
|
+
mutateJson5(packageJsonPath, context.host, (input) => {
|
|
1357
|
+
input[type] = options[type];
|
|
1358
|
+
return input;
|
|
1359
|
+
});
|
|
1360
|
+
}
|
|
1361
|
+
});
|
|
1362
|
+
return;
|
|
1363
|
+
}
|
|
1364
|
+
for (const [dep, version] of Object.entries(options[type])) {
|
|
1365
|
+
if (((_a = packageJson[type]) == null ? void 0 : _a[dep]) !== version) {
|
|
1366
|
+
context.addError({
|
|
1367
|
+
file: packageJsonPath,
|
|
1368
|
+
message: `Expected dependency ${dep}@${version}`,
|
|
1369
|
+
longMessage: diff8(`${dep}@${version}
|
|
1370
|
+
`, `${dep}@${packageJson[type][dep] || "missing"}
|
|
1371
|
+
`),
|
|
1372
|
+
fixer: () => {
|
|
1373
|
+
mutateJson5(packageJsonPath, context.host, (input) => {
|
|
1374
|
+
input[type] = { ...input[type], [dep]: version };
|
|
1375
|
+
return input;
|
|
1376
|
+
});
|
|
1377
|
+
}
|
|
1378
|
+
});
|
|
1379
|
+
}
|
|
1380
|
+
}
|
|
1381
|
+
});
|
|
1382
|
+
},
|
|
1383
|
+
validateOptions: Options11.check
|
|
1384
|
+
});
|
|
1385
|
+
export {
|
|
1386
|
+
alphabeticalDependencies,
|
|
1387
|
+
alphabeticalScripts,
|
|
1388
|
+
bannedDependencies,
|
|
1389
|
+
consistentDependencies,
|
|
1390
|
+
consistentVersions,
|
|
1391
|
+
createRuleFactory,
|
|
1392
|
+
fileContents,
|
|
1393
|
+
mustSatisfyPeerDependencies,
|
|
1394
|
+
nestedWorkspaces,
|
|
1395
|
+
packageEntry,
|
|
1396
|
+
packageOrder,
|
|
1397
|
+
packageScript,
|
|
1398
|
+
requireDependency,
|
|
1399
|
+
standardTsconfig
|
|
1400
|
+
};
|
|
1401
|
+
/*!
|
|
1402
|
+
* Copyright 2019 Palantir Technologies, Inc.
|
|
1403
|
+
*
|
|
1404
|
+
* Licensed under the MIT license. See LICENSE file in the project root for details.
|
|
1405
|
+
*
|
|
1406
|
+
*/
|
|
1407
|
+
/**
|
|
1408
|
+
* @license Copyright 2019 Palantir Technologies, Inc. All rights reserved.
|
|
1409
|
+
*/
|
|
1410
|
+
/*!
|
|
1411
|
+
* Copyright 2020 Palantir Technologies, Inc.
|
|
1412
|
+
*
|
|
1413
|
+
* Licensed under the MIT license. See LICENSE file in the project root for details.
|
|
1414
|
+
*
|
|
1415
|
+
*/
|
|
1416
|
+
/*!
|
|
1417
|
+
* Copyright 2023 Palantir Technologies, Inc.
|
|
1418
|
+
*
|
|
1419
|
+
* Licensed under the MIT license. See LICENSE file in the project root for details.
|
|
1420
|
+
*
|
|
1421
|
+
*/
|
|
1422
|
+
//# sourceMappingURL=index.js.map
|