FilesExpand file tree

main

/

check-workspace-contracts.mjs

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

62 lines (52 loc) · 2.05 KB

main

/

check-workspace-contracts.mjs

Copy path

Top

File metadata and controls

• Code
• Blame

62 lines (52 loc) · 2.05 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

#!/usr/bin/env node

import { existsSync, readFileSync, readdirSync } from "node:fs";

import { join } from "node:path";

import { fileURLToPath } from "node:url";

const ROOT = join(import.meta.dirname, "..");

export const REQUIRED_WORKSPACE_SCRIPTS = ["build", "typecheck", "test"];

function hasExecutableScript(pkg, script) {

return typeof pkg.scripts?.[script] === "string" && pkg.scripts[script].trim().length > 0;

}

function hasSpecificReason(reason) {

return typeof reason === "string" ? reason.trim().length >= 20 : false;

}

function hasDocumentedOptOut(pkg, script) {

const optOut = pkg.hyperframesWorkspaceContract?.[script];

return optOut?.optOut === true && hasSpecificReason(optOut.reason);

}

export function listWorkspaceContractIssues(workspace, pkg) {

return REQUIRED_WORKSPACE_SCRIPTS.flatMap((script) => {

if (hasExecutableScript(pkg, script) || hasDocumentedOptOut(pkg, script)) return [];

return [

`${workspace}: missing executable \`${script}\` script or ` +

`hyperframesWorkspaceContract.${script} opt-out with a specific reason`,

];

});

}

export function listWorkspacePackages(root = ROOT) {

const packagesDir = join(root, "packages");

return readdirSync(packagesDir)

.sort()

.filter((name) => existsSync(join(packagesDir, name, "package.json")))

.map((name) => {

const workspace = `packages/${name}`;

const pkg = JSON.parse(readFileSync(join(root, workspace, "package.json"), "utf8"));

return { workspace, pkg };

});

}

export function checkWorkspaceContracts(root = ROOT) {

return listWorkspacePackages(root).flatMap(({ workspace, pkg }) =>

listWorkspaceContractIssues(workspace, pkg),

);

}

function main() {

const issues = checkWorkspaceContracts();

if (issues.length > 0) {

console.error("Workspace contract violations:");

issues.forEach((issue) => console.error(`- ${issue}`));

process.exitCode = 1;

return;

}

console.log("Workspace contracts verified: build, typecheck, and test are explicit.");

}

if (process.argv[1] === fileURLToPath(import.meta.url)) main();