@adamaho/nopeus-tsconfig 0.3.0 → 0.3.2
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/README.md +11 -7
- package/effect.json +2 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -18,7 +18,7 @@ belong to the consuming project.
|
|
|
18
18
|
|
|
19
19
|
## Install
|
|
20
20
|
|
|
21
|
-
Install
|
|
21
|
+
Install the package and TypeScript:
|
|
22
22
|
|
|
23
23
|
```bash
|
|
24
24
|
pnpm add -D -E @adamaho/nopeus-tsconfig typescript@7.0.2
|
|
@@ -34,6 +34,9 @@ and combine `/base` with `/vite`:
|
|
|
34
34
|
}
|
|
35
35
|
```
|
|
36
36
|
|
|
37
|
+
After adding the config, run `pnpm exec tsc --showConfig` to inspect the
|
|
38
|
+
resolved options and `pnpm exec tsc --noEmit` to typecheck the project.
|
|
39
|
+
|
|
37
40
|
The base policy enables strict checking, exact optional properties, checked index
|
|
38
41
|
access, unused-local checks, explicit overrides, isolated modules, verbatim
|
|
39
42
|
module syntax, and TypeScript import extensions. It targets ES2022, checks
|
|
@@ -54,7 +57,7 @@ diagnostics. For a Node project, combine it with `/node`:
|
|
|
54
57
|
Install the compiler integration in the workspace that owns TypeScript:
|
|
55
58
|
|
|
56
59
|
```bash
|
|
57
|
-
pnpm add -D -E @effect/tsgo@0.
|
|
60
|
+
pnpm add -D -E @effect/tsgo@0.47.2
|
|
58
61
|
```
|
|
59
62
|
|
|
60
63
|
Retain the project's existing preparation commands and add the compiler patch:
|
|
@@ -72,7 +75,7 @@ Run `pnpm install` after adding the preparation step. CI must run installation
|
|
|
72
75
|
scripts before typechecking. The JSON config supplies policy; the patched
|
|
73
76
|
compiler executes Effect diagnostics. An unpatched compiler does not enforce
|
|
74
77
|
them. Keep TypeScript and `@effect/tsgo` on compatible versions; the tested pair
|
|
75
|
-
is TypeScript 7.0.2 with `@effect/tsgo` 0.
|
|
78
|
+
is TypeScript 7.0.2 with `@effect/tsgo` 0.47.2 and Effect 4.0.0.
|
|
76
79
|
Install `@types/node` when using `/node`. Vite projects using Effect combine
|
|
77
80
|
`/effect` with `/vite` and install `vite`. Neither environment preset installs
|
|
78
81
|
these dependencies automatically. `/node` excludes browser globals; `/vite`
|
|
@@ -93,10 +96,11 @@ option and install the React types they need.
|
|
|
93
96
|
| `preferSucceedSomeOrNone` | Use the dedicated constructors for optional success values. |
|
|
94
97
|
| `unnecessaryTypeofType` | Use named types instead of redundant schema type queries. |
|
|
95
98
|
|
|
96
|
-
These diagnostics are errors and cause a failing `tsc` exit code.
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
99
|
+
These diagnostics are errors and cause a failing `tsc` exit code. The
|
|
100
|
+
`unstableApiUsage` diagnostic is disabled so projects can intentionally use
|
|
101
|
+
unstable Effect APIs. Other upstream diagnostics retain their defaults. A child
|
|
102
|
+
config's `compilerOptions.plugins` replaces the inherited array, so preserve
|
|
103
|
+
the Effect entry if adding another compiler plugin.
|
|
100
104
|
|
|
101
105
|
For editor support, run `pnpm exec effect-tsgo setup` and follow the
|
|
102
106
|
[official editor instructions](https://github.com/Effect-TS/tsgo#installation).
|
package/effect.json
CHANGED