[compiler]internal symbols

[witemple-msft]

This PR enables libraries to define internal symbols that cannot be referenced from outside the same project scope.

internal can apply to any declaration except namespace. Internality is a property of symbols, not of types. A Type that is declared internal can be used from a different package, but can't be referred to by name. This allows you to use an alias to publicly expose an internal declaration:

internal model X {}

// Totally fine -- the model itself isn't internal, only the _symbol_ `X` is.
alias Public = X;

Resolution logic for symbols declared with internal is:

• Resolution is allowed if the source location is in the compiler stdlib or is synthetic (programmatic through checker.resolveTypeReference or otherwise synthetic).
• Resolution is allowed if the source location is a library, and the target symbol was declared within that same library.
• Resolution is allowed if the source location is the user project, and the target symbol was declared within the user project.
• Resolution is otherwise disallowed.

Notes:

• To preserve backwards compatibility, internal is allowed as the name of a model property, since it is allowed as one now. The logic for this also allows extern to be a model property name, which isn't currently allowed.

Implementation:

• Refactors parser a bit to handle modifiers on all declarations.
• Adds SymbolFlags.Internal, which binds to a symbol if the corresponding declaration has ModifierFlags.Internal.
• Access control is enforced in resolveTypeReferenceSymInternal when resolving a type reference. Access control must pass for any referenced symbol.

[github-actions]

❌ There is undocummented changes. Run chronus add to add a changeset or click here.

The following packages have changes but are not documented.

• ❌@typespec/tspd

The following packages have already been documented:

• ✅ @typespec/compiler

Show changes

@typespec/compiler - feature ✏️

Added experimental support for internal modifiers on type declarations. Any type except namespace can be declared internal. An internal symbol can only be accessed from within the same package where it was declared.

[pkg-pr-new]

Open in StackBlitz

npm i https://pkg.pr.new/microsoft/typespec/@typespec/compiler@9762

npm i https://pkg.pr.new/microsoft/typespec/@typespec/tspd@9762

commit: 7c6f0a8

[azure-sdk]

You can try these changes here

🛝 Playground	🌐 Website	🛝 VSCode Extension

[timotheeguerin]

can we also add test for printing the internal modifier for various types

[timotheeguerin]

I see those modifiers keywords are tagged as storage.modifier.<ext> for ts, java, js, csharp

• https://github.com/microsoft/TypeScript-TmLanguage/blob/b25c379478aac85be855252ac06bd71c88cac1b7/TypeScript.YAML-tmLanguage#L2523
• https://github.com/microsoft/vscode/blob/13873216891ce5ac2aa2dd5e2c4b96c57b8b3dae/extensions/javascript/syntaxes/JavaScript.tmLanguage.json#L1384C17-L1384C33
• https://github.com/dotnet/csharp-tmLanguage/blob/b1545c82fc3d30ff3e7eb4203792fcf2b48baf4d/src/csharp.tmLanguage.yml#L257

feel like we probably should align?

[timotheeguerin]

commented?

[timotheeguerin]

Seems to be reported on the wrong place

[timotheeguerin]

should this also be replaced