1
import { describe, expect, it } from "vite-plus/test"
2

3
// =============================================================================
4
// 28 - TypeScript Config: The Flags the Effect Team Enables
5
// =============================================================================
6
//
7
// The strict base mirrors repos/effect/tsconfig.base.json.
8
// Two overlays adapt it to bundled apps and to publishable Node libraries.
9

10
const strictBase = {
11
  strict: true,
12
  exactOptionalPropertyTypes: true,
13
  noUnusedLocals: true,
14
  noFallthroughCasesInSwitch: true,
15
  forceConsistentCasingInFileNames: true,
16
  isolatedModules: true,
17
  moduleDetection: "force",
18
  skipLibCheck: true,
19
  incremental: true,
20
} as const
21

22
const bundledAppTsconfig = {
23
  compilerOptions: {
24
    ...strictBase,
25
    target: "ES2022",
26
    module: "preserve",
27
    moduleResolution: "bundler",
28
    noEmit: true,
29
  },
30
} as const
31

32
const nodeLibraryTsconfig = {
33
  compilerOptions: {
34
    ...strictBase,
35
    target: "ES2022",
36
    module: "NodeNext",
37
    moduleResolution: "NodeNext",
38
    declaration: true,
39
    declarationMap: true,
40
    composite: true,
41
  },
42
} as const
43

44
const findWeakSettings = (config: Record<string, unknown>) =>
45
  [
46
    config.strict === true ? null : "strict should be enabled",
47
    config.exactOptionalPropertyTypes === true
48
      ? null
49
      : "exactOptionalPropertyTypes should be enabled",
50
    typeof config.module === "string" ? null : "module should be chosen explicitly",
51
  ].filter((value): value is string => value !== null)
52

53
describe("28 - TypeScript Config", () => {
54
  // @beat
55
  //   id: bundled-app
56
  //   shape: multi-todo
57
  //   title: Bundled-app overlay
58
  //   teaches: An app consumed by Vite or Next layers moduleResolution=bundler and noEmit on top of the strict base.
59
  //   hint: the overlay keeps strict=true and adds moduleResolution: "bundler", noEmit: true
60
  it("keeps the strict baseline for bundled apps", () => {
61
    // Predict each value the bundled-app overlay is expected to hold.
62
    expect(bundledAppTsconfig.compilerOptions.strict).toBe(/* @stub */ true /* @end */)
63
    expect(bundledAppTsconfig.compilerOptions.moduleResolution).toBe(/* @stub */ "bundler" /* @end */)
64
    expect(bundledAppTsconfig.compilerOptions.noEmit).toBe(/* @stub */ true /* @end */)
65
  })
66
  // @end-beat
67

68
  // @beat
69
  //   id: node-library
70
  //   shape: multi-todo
71
  //   title: Node-library overlay
72
  //   teaches: A library shipped to npm layers NodeNext modules, declarations, and composite for project references.
73
  //   hint: module uses the NodeNext resolver string; declaration, declarationMap, and composite are all turned on
74
  it("uses NodeNext + declarations for publishable libraries", () => {
75
    // Predict the four overlay values that make a library publishable.
76
    expect(nodeLibraryTsconfig.compilerOptions.module).toBe(/* @stub */ "NodeNext" /* @end */)
77
    expect(nodeLibraryTsconfig.compilerOptions.declaration).toBe(/* @stub */ true /* @end */)
78
    expect(nodeLibraryTsconfig.compilerOptions.declarationMap).toBe(/* @stub */ true /* @end */)
79
    expect(nodeLibraryTsconfig.compilerOptions.composite).toBe(/* @stub */ true /* @end */)
80
  })
81
  // @end-beat
82

83
  // @beat
84
  //   id: weak-config
85
  //   shape: one-todo
86
  //   title: Detect weak configs
87
  //   teaches: A validator turns the strict-flag checklist into a concrete diff against any tsconfig snapshot.
88
  //   hint: module is provided so it's fine; the two missing flags appear in declaration order
89
  it("flags weak configs concretely", () => {
90
    // Predict the gap report when only `module` is set.
91
    expect(findWeakSettings({ module: "preserve" })).toEqual(/* @stub */ [
92
      "strict should be enabled",
93
      "exactOptionalPropertyTypes should be enabled",
94
    ] /* @end */)
95
  })
96
  // @end-beat
97

98
  // @beat
99
  //   id: write-validator
100
  //   shape: one-todo
101
  //   title: Write the weak-config validator
102
  //   teaches: Encode the required flags as a filter-null pattern — each check either returns null (ok) or a named gap (needs fix).
103
  //   hint: check config.strict === true, config.exactOptionalPropertyTypes === true, typeof config.module === "string"; filter nulls
104
  it("your turn: implement findWeakSettings", () => {
105
    const myFindWeakSettings = (config: Record<string, unknown>): string[] =>
106
      /* @stub */ [
107
        config.strict === true ? null : "strict should be enabled",
108
        config.exactOptionalPropertyTypes === true
109
          ? null
110
          : "exactOptionalPropertyTypes should be enabled",
111
        typeof config.module === "string" ? null : "module should be chosen explicitly",
112
      ].filter((value): value is string => value !== null) /* @end */
113

114
    // all flags present — no gaps
115
    expect(
116
      myFindWeakSettings({ strict: true, exactOptionalPropertyTypes: true, module: "bundler" }),
117
    ).toEqual([])
118

119
    // missing strict and module — two gaps
120
    expect(myFindWeakSettings({ exactOptionalPropertyTypes: true })).toEqual([
121
      "strict should be enabled",
122
      "module should be chosen explicitly",
123
    ])
124
  })
125
  // @end-beat
126
})