/
Workspaces.scan.js
76 lines (63 loc) · 3.1 KB
/
Workspaces.scan.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
// @flow
import fs from 'fs';
import path from 'path';
import { Workspaces } from '@adeira/monorepo-utils';
Workspaces.iterateWorkspaces(packageJSONLocation => {
test(`${packageJSONLocation}`, () => {
// $FlowAllowDynamicImport
const packageJson = require(packageJSONLocation);
expect(packageJson.private).not.toBeUndefined();
// Packages 'eslint-plugin-*' are the only exception since it wasn't
// possible to have scoped packages in Eslint. Dunno if it's possible now.
expect(/^eslint-plugin-.+|^@adeira\/.+/.test(packageJson.name) === true).toGiveHelp(
`All packages in our monorepo must start with '@adeira/' prefix. This name is not valid: ${packageJson.name}`,
);
if (packageJson.main !== undefined) {
// We could in theory limit this case only for cases when MJS files are actually going to be
// generated. This seems to be easier and it's not wrong.
expect(packageJson.main.endsWith('.js') === false).toGiveHelp(
"Field 'main' cannot have extension because it prevents MJS files from working correctly when used together.",
);
}
if (packageJson.private === false) {
expect(packageJson.description).not.toBeUndefined();
// We currently have only MIT packages.
// https://docs.npmjs.com/files/package.json#license
expect(packageJson.license).toBe('MIT');
expect(packageJson.homepage).toMatch(
new RegExp(
`^https://github\\.com/adeira/universe/tree/master/src/${path.basename(
path.dirname(packageJSONLocation),
)}$`,
),
);
// each public package must specify `main` or `bin` field to be useful
expect(packageJson.main !== undefined || packageJson.bin !== undefined).toBe(true);
const packagePath = path.dirname(packageJSONLocation);
['README.md', 'LICENSE', '.npmignore'].forEach(requiredFilename => {
if (!fs.existsSync(path.join(packagePath, requiredFilename))) {
throw new Error(`Package ${packageJson.name} is missing ${requiredFilename} file!`);
}
});
}
expect(packageJson.version).not.toBeUndefined();
// there must be empty dependencies or devDependencies key ({} is enough)
expect(
packageJson.dependencies !== undefined || packageJson.devDependencies !== undefined,
).toBe(true);
const dependencies = Object.entries(packageJson.dependencies ?? {}).concat(
Object.entries(packageJson.devDependencies ?? {}),
);
dependencies.forEach(([dependency, value]) => {
const version = typeof value === 'string' ? value : '^';
if (!/^(?:[~^]?[0-9]+(?:\.[0-9]+){2}|http.+|\.\/[a-zA-Z0-9-_/.]+\.tgz)/.test(version)) {
// this is necessary because we repeatedly released package without
// bumped dependency version which made the released package broken
// (we should probably use tilde ranges for our workspace deps though)
throw new Error(
`Please be more explicit about the required versions inside monorepo. Package ${packageJson.name} required dependency ${dependency} with version: ${version}`,
);
}
});
});
});