back interdiff of round #1 and #0

[New feature] Externals #2

closed
opened by danabra.mov targeting main from external

A step towards https://tangled.org/@danabra.mov/typelex/issues/5.

This adds support for Externals, which are namespaces with @external decorator.

@external
namespace com.atproto.label.defs {
  model Label { }
}

@external
namespace app.bsky.graph.defs {
  model StarterPackViewBasic { }
  model ListViewBasic { }
}

They do NOT get emitted as JSON. They only exist to represent external Lexicons for which you have only JSON.

Models inside @external namespaces must be empty. However, they're allowed to be @tokens which we need to know to disambiguate unions and knownValues. (In the future, it's possible we won't rely on knowing that, but for now we do.)

I've converted the playground to use externals properly. I will convert tests in a follow-up.

options
unified split
files
packages
emitter
lib
decorators.tsp
src
emitter.ts
tsp-index.ts
test
spec
basic
output
com
example
other.json
external
input
test
normal.tsp
output
test
normal.json
spec.test.ts
playground
samples
build.js
index.js
REVERTED
packages/emitter/lib/decorators.tsp
 
···

       
1

       
1

       
 

       
import "../dist/tsp-index.js";


     

       
2

       
2

       
 

       



     

       
3

       

       
-

       
using TypeSpec.Reflection;


     

       
4

       

       
-

       



     

       
5

       
3

       
 

       
/**


     

       
6

       
4

       
 

       
 * Specifies the maximum number of graphemes (user-perceived characters) allowed.


     

       
7

       
5

       
 

       
 * Used alongside maxLength for proper Unicode text handling.


     
···

       
161

       
159

       
 

       
 * ```


     

       
162

       
160

       
 

       
 */


     

       
163

       
161

       
 

       
extern dec errors(target: unknown, ...errors: unknown[]);


     

       
164

       

       
-

       



     

       
165

       

       
-

       
/**


     

       
166

       

       
-

       
 * Marks a namespace as external, preventing it from emitting JSON output.


     

       
167

       

       
-

       
 * This decorator can only be applied to namespaces.


     

       
168

       

       
-

       
 * Useful for importing definitions from other lexicons without re-emitting them.


     

       
169

       

       
-

       
 *


     

       
170

       

       
-

       
 * @example


     

       
171

       

       
-

       
 * ```typespec


     

       
172

       

       
-

       
 * @external


     

       
173

       

       
-

       
 * namespace com.atproto.repo.defs;


     

       
174

       

       
-

       
 * ```


     

       
175

       

       
-

       
 */


     

       
176

       

       
-

       
extern dec external(target: Namespace);
ERROR
packages/emitter/src/tsp-index.ts

Failed to calculate interdiff for this file.

ERROR
packages/emitter/test/spec.test.ts

Failed to calculate interdiff for this file.

ERROR
packages/emitter/test/spec/basic/output/com/example/other.json

Failed to calculate interdiff for this file.

ERROR
packages/emitter/test/spec/external/input/test/normal.tsp

Failed to calculate interdiff for this file.

ERROR
packages/emitter/test/spec/external/output/test/normal.json

Failed to calculate interdiff for this file.

ERROR
packages/playground/samples/build.js

Failed to calculate interdiff for this file.

ERROR
packages/playground/samples/index.js

Failed to calculate interdiff for this file.

ERROR
packages/emitter/src/emitter.ts

Failed to calculate interdiff for this file.