maxine.puppykitty.racing
forked from
danabra.mov/typelex
An experimental TypeSpec syntax for Lexicon
document @external
danabra.mov
+25
-5
DOCS.md
+25
-5
DOCS.md
···
236
237
This works across files too—just remember to `import` the file with the definition.
238
239
-
### External Stubs
240
241
-
If you don't have TypeSpec definitions for external Lexicons, you can stub them out:
242
243
```typescript
244
import "@typelex/emitter";
···
249
}
250
}
251
252
-
// Empty stub (like .d.ts in TypeScript)
253
namespace com.atproto.label.defs {
254
model SelfLabels { }
255
}
256
```
257
258
-
You could collect stubs in one file and import them:
259
260
```typescript
261
import "@typelex/emitter";
···
268
}
269
```
270
271
-
You'll want to replace the stubbed lexicons in the output folder with their real JSON before running codegen.
272
273
### Inline Models
274
···
236
237
This works across files too—just remember to `import` the file with the definition.
238
239
+
### External References
240
241
+
If you don't have TypeSpec definitions for external Lexicons, you can stub them out using the `@external` decorator:
242
243
```typescript
244
import "@typelex/emitter";
···
249
}
250
}
251
252
+
// External stub (like .d.ts in TypeScript)
253
+
@external
254
namespace com.atproto.label.defs {
255
model SelfLabels { }
256
}
257
```
258
259
+
The `@external` decorator tells the emitter to skip JSON output for that namespace. This is useful when referencing definitions from other Lexicons that you don't want to re-emit.
260
+
261
+
You could collect external stubs in one file and import them:
262
263
```typescript
264
import "@typelex/emitter";
···
271
}
272
```
273
274
+
Then in `atproto-stubs.tsp`:
275
+
276
+
```typescript
277
+
import "@typelex/emitter";
278
+
279
+
@external
280
+
namespace com.atproto.label.defs {
281
+
model SelfLabels { }
282
+
}
283
+
284
+
@external
285
+
namespace com.atproto.repo.defs {
286
+
model StrongRef { }
287
+
}
288
+
// ... more stubs
289
+
```
290
+
291
+
You'll want to ensure the real JSON for external Lexicons is available before running codegen.
292
293
### Inline Models
294