src/public-code-schema.ts

Functions

None: it only declares types or values.

Imports

It imports src/limits.ts. Imported by src/public-code.ts.

Source

1import { z } from "zod";
2import { bounded } from "./limits";
3
4// The public code maps' shape (src/public-code.ts; docs/public-data.md, "The code maps"),
5// apart from the code that reads them so the explorer's build can check the document
6// without loading the GitHub client.
7
8const REPO = /^[A-Za-z0-9_.-]+\/[A-Za-z0-9_.-]+$/;
9const DATE = /^\d{4}-\d{2}-\d{2}$/;
10// A repo-relative module path: no leading slash, no "." or ".." segment. $ and brackets are
11// in React Router's route file names (blog.$slug[.md].ts); the explorer escapes them in links.
12const ModulePath = bounded(300).regex(/^(?!\/)(?!.*(?:^|\/)\.\.?(?:\/|$))[A-Za-z0-9._@/+$[\]-]+$/, "a module path is repo-relative");
13const Line = z.number().int().min(1);
14const Share = z.number().min(0).max(1);
15
16const FunctionSchema = z.object({
17  name: bounded(200).min(1),
18  line: Line,
19  end: Line,
20  cc: z.number().int().min(1),
21  coverage: Share.nullable(),
22  crap: z.number().min(0).nullable(),
23  mutants: z.number().int().min(0).nullable(),
24  score: z.number().min(0).max(100).nullable(),
25  // Changed since the mutation run, so its old numbers were dropped (mutants and score null).
26  stale: z.literal(true).optional(),
27});
28
29const ModuleSchema = z.object({
30  path: ModulePath,
31  loc: z.number().int().min(0),
32  imports: z.array(ModulePath).max(1000),
33  cycle: z.literal(true).optional(),
34  functions: z.array(FunctionSchema).max(5000),
35});
36
37/** code-map.json v1 as devkit writes it. Parsing strips any key not named here, so a
38 *  field nobody listed cannot reach the public document. */
39export const CodeMapSchema = z.object({
40  version: z.literal(1),
41  repo: bounded(200).regex(REPO),
42  sha: bounded(40).regex(/^[0-9a-f]{40}$/),
43  date: bounded(10).regex(DATE),
44  tools: z.object({
45    typescript: bounded(40).nullable(),
46    coverage: z.literal("istanbul").nullable(),
47    mutation: z.literal("stryker").nullable(),
48  }),
49  // The commit and day the mutation report was measured at, when it is older than the map.
50  mutated: z.object({ sha: bounded(40).regex(/^[0-9a-f]{40}$/), date: bounded(10).regex(DATE) }).optional(),
51  modules: z.array(ModuleSchema).max(5000),
52  cycles: z.array(z.array(ModulePath).min(1).max(1000)).max(1000),
53});
54
55export const PublicCodeSchema = z.strictObject({
56  version: z.literal(1),
57  as_of: bounded(10).regex(DATE),
58  maps: z.array(CodeMapSchema.extend({ system: bounded(64) }).strict()),
59});
60
61export type PublicCode = z.infer<typeof PublicCodeSchema>;