Skip to content

Commit ec593dd

Browse files
committed
docs(readme): npm install needs alias + $typescript override reference (issue #8)
Putting npm:typescript-native-bridge@… directly inside overrides is rejected or mis-resolved by some npm versions; the alias + $typescript reference form is what users report working. Also note the bridge dist-tag as a version shorthand.
1 parent cddbcaa commit ec593dd

1 file changed

Lines changed: 9 additions & 1 deletion

File tree

‎README.md‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,12 +91,20 @@ If packages use `catalog:typescript`, update the **catalog entry** as well (see
9191
```jsonc
9292
// package.json
9393
{
94-
"overrides": {
94+
"devDependencies": {
9595
"typescript": "npm:typescript-native-bridge@<version>"
96+
},
97+
"overrides": {
98+
"typescript": "$typescript"
9699
}
97100
}
98101
```
99102

103+
Install with the alias **and** the `$typescript` override reference, as shown —
104+
putting `npm:typescript-native-bridge@…` directly inside `overrides` is rejected or
105+
mis-resolved by some npm versions (issue #8). `<version>` can be an exact version
106+
(e.g. `^6.0.3-bridge.0.tsgo.7.0.2`) or the `bridge` dist-tag.
107+
100108
### yarn
101109

102110
```jsonc

0 commit comments

Comments
 (0)