Change Log - @typespec/compiler

September 9, 2026 · View on GitHub

1.16.0

Features

#11777 Add sanitizePathSegment helper to make a value coming from a TypeSpec spec safe to use as a single path segment. Path separators, drive letter separators and values only made of . are replaced with _.
```
sanitizePathSegment("2021-10-01-preview"); // "2021-10-01-preview"
sanitizePathSegment("../../etc/passwd"); // ".._.._etc_passwd"
```

#11851 Add support for defining a linter ruleset in a standalone yaml file and referencing it with the file: prefix in linter.extends. This lets a repository share and version a set of linter rules without depending on a library release.

# tspconfig.yaml
linter:
  extends:
    - "file:../common-rules.yaml"

# common-rules.yaml
extends:
  - "@typespec/best-practices/recommended"
enable:
  "@typespec/best-practices/new-rule": true
disable:
  "@typespec/best-practices/foo": "This rule is too strict for this repository"

#11489 Add a new experimental $provideTypeInfo library provider and program.getTypeInfo(type) API allowing libraries to contribute extra, domain-specific information about types. Unlike the $onValidate lifecycle hook, a provider never runs during compilation and must not mutate the type graph — it is invoked lazily and on demand (e.g. by the language server for hover documentation, or by tooling querying the type).

Providers are gated by the type-info-provider compiler feature, scoped to the package that declares it: a library opts in via its own tspconfig.yaml and consumers do not need to enable anything.
```
// A library exports a provider (use `defineTypeInfoProvider` for typing):
export const $provideTypeInfo = defineTypeInfoProvider(({ program, target }) => {
  if (target.kind !== "Operation") return undefined;
  return { content: "extra info about this operation" };
});

// Tooling / language server queries it (merges every library's contribution):
const info = program.getTypeInfo(type);
```
#11771 Add experimental support for an extends clause on union statements to constrain every variant to a common data type.

Enable the union-extends compiler feature in tspconfig.yaml to use the clause.
```
model PetBase {
  name: string;
}
model Cat extends PetBase {
  toy: string;
}
model Dog extends PetBase {
  food: string;
}

union Pet extends PetBase {
  cat: Cat,
  dog: Dog,
}
```
The base type is exposed on the type graph as Union.baseType, giving emitters an easy way to know that all the variants of a union share a common base type. A diagnostic is reported on any variant that isn't assignable to the base type.

extends on a union is purely a constraint: it doesn't imply any subtyping relationship, it doesn't make the union extensible and it has no interaction with @discriminator.

Bug Fixes

#11731 Fix duration example values being serialized verbatim as an ISO 8601 string instead of a numeric value when encoded with @encode("milliseconds", ...)
#11744 Fix object values passed to decorators dropping members with special names like __proto__. All members are now defined as plain own properties.
#11779 Fix a stack overflow when checking assignability of mutually recursive types

Checking whether a type was assignable to another one could recurse forever and crash the compiler with RangeError: Maximum call stack size exceeded. Two cases were affected:
- mutually recursive models, such as model A { b: B } / model B { a: A }
- any union reaching itself, such as union Foo { self: Foo }
The relation cache is now shared for the whole check instead of being recreated at every level, and unions seed it before walking their variants, so a cycle coming back to the same pair of types resolves instead of recursing.

#11838 [formatter] Split the template parameter list instead of splitting a parameter constraint or default when the declaration is too long

// Before
op deleteJobPreview<AreaPreviewLabel extends
  | FoundryFeaturesOptInKeys
  | AgentDefinitionOptInKeys> is FoundryDataPlanePreviewOperation<AreaPreviewLabel>;

// After
op deleteJobPreview<
  AreaPreviewLabel extends FoundryFeaturesOptInKeys | AgentDefinitionOptInKeys
> is FoundryDataPlanePreviewOperation<AreaPreviewLabel>;

#11776 Allow tsp install to download package managers from npm-compatible registry mirrors by resolving versions from package metadata instead of version-specific manifest endpoints.
#11551 Improve the name reported for an operation's parameters model expression. Diagnostics now refer to MyService.test::parameters.param instead of MyService.{ param: MyService.Foo }.param.

1.15.0

Breaking Changes

#11552 using statements declared before a file-level(blockless) namespace are now resolved from the global namespace instead of the file namespace, matching C#.
```
using TypeSpec.Http; // Now resolves the global `TypeSpec` namespace instead of `_Specs_.TypeSpec`
namespace _Specs_.TypeSpec.Foo;
```
A using declared after the file namespace, or inside a namespace block, is unchanged and still resolves relative to that namespace. Code relying on a relative name in a using written above the file namespace must now use the fully qualified name.
```
namespace MyOrg.Service;
using Models; // Still resolves to `MyOrg.Models`
```

Features

#11476 Add back empty project template to tsp init options

# Result of selecting "Empty project" in tsp init
# main.tsp - minimal empty file to start from

#11000 Add setAutoDecorator API to programmatically apply an auto decorator to a target, mirroring what the synthesized auto dec implementation does when the decorator is written in source. This lets emitters and mutators mark synthetic types without reaching into the program state map directly.
```
import { setAutoDecorator } from "@typespec/compiler";

setAutoDecorator(program, "MyLib.myFlag", target);
```
#11468 Add Fix all: X code action for codefixes that can be applied to multiple instances in a file at once. When a codefix applies to more than one diagnostic of the same kind in a file, a Fix all: <fix label> quick fix action is now suggested alongside the individual fix.
#11209 Add support for short diagnostic and linter rule names. Diagnostic/rule codes can now be referenced by their scope-stripped short name (e.g. http/no-foo instead of @typespec/http/no-foo) or by a library-declared alias, both in #suppress directives and in the linter section of tspconfig.yaml. The full name is always accepted.
```
model Post {
  #suppress "http/no-service-found" "standard library route"
  author: LegacyUser;
}
```
Libraries can declare a custom alias:
```
export const $lib = createTypeSpecLibrary({
  name: "@azure-tools/typespec-client-generator-core",
  alias: "tcgc",
  diagnostics: {
    /* ... */
  },
} as const);
```
An alias must be kebab-case (lowercase letters, digits, and hyphens). When two loaded libraries would resolve to the same short name, that short name is ambiguous: referencing it (in a #suppress directive or the linter config) reports a warning and the full name must be used.
#11366 Language server folding ranges now report a kind: comments fold as comment and consecutive import statements fold together as an imports region. This enables editor commands such as "Fold All Block Comments" and "Fold All Imports" to work with TypeSpec files.
#11318 Add currentStage property and useCache method to Program for stage-aware caching. currentStage tracks the compilation pipeline stage (parsing → checking → validating → linting → emitting), and useCache provides a generic caching mechanism that libraries can use to avoid redundant computation during later stages.
#11221 Add a docs field to linter rule and diagnostic definitions to provide extended reference documentation. The value can be an inline markdown string or a FileRef created with fileRef.fromPackageRoot("src/rules/my-rule.md"), which is read lazily by tooling so it stays safe to bundle for the browser.
```
export const myRule = createRule({
  name: "my-rule",
  severity: "warning",
  description: "Short description.",
  docs: fileRef.fromPackageRoot("src/rules/my-rule.md"),
  messages: {
    /* ... */
  },
});
```
#11000 createTester now mounts each discovered library's tspconfig.yaml into the virtual file system, so experimental features a library opts into (e.g. auto-decorators) are honored when compiling against the tester.

Bug Fixes

#11477 Fix decorators running with unresolved template parameters when a decorated template is used as a template parameter default of an operation (e.g. op foo<Resource, Properties = Decorated<Resource>>(...), the ARM TagsUpdateModel<Resource> pattern). Operations now enter the template declaration scope before resolving template parameter defaults, so decorators on those defaults are no longer executed with the still-unresolved template parameter. This matches the existing behavior for models and interfaces.
#11423 tsp compile . now resolves the entrypoint from exports["."]["typespec"] in package.json, taking precedence over the legacy tspMain field
#11485 Report better error message when specifying an emitter that is not installed with --emit flag
#11426 IDE completion no longer adds unnecessary backticks when completing keyword identifiers in positions where they are allowed (model properties, object literal properties, member expressions).
#11467 tsp init template compilerVersion field now supports semver ranges (e.g., ^0.50.0). Plain versions like 1.2.3 continue to work as >=1.2.3 for backward compatibility.

1.14.0

Deprecations

#11169 tsp code install and tsp vs install now install the editor extensions from the marketplace instead of downloading the typespec-vscode/typespec-vs npm packages. tsp code install delegates to code --install-extension microsoft.typespec-vscode, and tsp vs install downloads the latest vsix from the Visual Studio Marketplace.

The tsp code and tsp vs commands (install/uninstall) are now deprecated. They keep working but emit a deprecation warning; install and manage the extensions directly from the marketplace instead.
#10964 Deprecate old testing framework (createTestHost, createTestRunner, createTestWrapper, createTestLibrary, BasicTestRunner, TypeSpecTestLibrary, etc.). Use createTester from @typespec/compiler/testing instead.

Features

#11247 Add setAutoDecorator API to programmatically apply an auto decorator to a target, mirroring what the synthesized auto dec implementation does when the decorator is written in source. This lets emitters and mutators mark synthetic types without reaching into the program state map directly.
```
import { setAutoDecorator } from "@typespec/compiler";

setAutoDecorator(program, "MyLib.myFlag", target);
```
#10875 Allow @encode(string) on boolean targets, define case-insensitive true/false string semantics, and add shared case-insensitive string matcher support with encode/boolean Spector coverage.
```
model FeatureFlags {
  @encode(string)
  enabled: boolean;
}
```
#10956 Support importing .ts decorator modules from TypeSpec source files.
#10197 Added auto decorator modifier for declaring decorators that auto-store their arguments as metadata without requiring a JavaScript implementation.
```
auto dec label(target: Model, value: valueof string);

@label("my-model")
model Foo {}
```
Added compiler API hasAutoDecorator, getAutoDecoratorValue, and getAutoDecoratorTargets for reading auto decorator values by FQN.
#11247 createTester now mounts each discovered library's tspconfig.yaml into the virtual file system, so experimental features a library opts into (e.g. auto-decorators) are honored when compiling against the tester.
#10805 Dim unused #suppress directives for available compiler and library diagnostics in editor scenarios.
```
#suppress "deprecated" "old suppression"
model Widget {}
```

Bug Fixes

#11113 Warn on duplicate #suppress directives on the same node.
#10921 Fix diagnostic target node mapping for value entities.
#11235 Fix directory entrypoint resolution ignoring package.json tspMain when a tspconfig.yaml with kind: project is present but does not specify an entrypoint. The resolution order is now: explicit config entrypoint, then package.json tspMain, then main.tsp.
#11011 Keep the is/extends keyword on the declaration line when the base is a template reference with multiple arguments. The template argument list now controls the line breaking instead of the keyword being pushed onto its own indented line.
#11010 Fix formatter inserting a blank line and over-indenting a union expression used directly as one of multiple template arguments (e.g. PickProperties<Source, "a" | "b">)
#11235 Fix compiler feature flags (e.g. auto-decorators) not being enabled for library code. A library can now opt into a feature via its own tspconfig.yaml features, enabling it only for that library's source files without requiring the consuming project to enable it.
#11121 Fix memory leak in the experimental mutator engine where a module-level seen cache pinned the type graph of every mutated program in memory for the lifetime of the process. The cache is now scoped per Program (via a WeakMap), so it is released once the program is garbage collected while still being shared across the nested mutations required for recursive type graphs to terminate.
#11056 Fix Expected type. internal compiler error when a string template interpolates a function call that references a template parameter on a template declaration (e.g. @doc("${myFn(T)}") model Crud<T extends Reflection.Model> {}). The deferred function call now defers the whole template, which is evaluated at instantiation.

1.13.0

Deprecations

#10876 Deprecated deepClone utility in favor of structuredClone. All internal usages have been replaced with the native structuredClone API.

Features

#10897 ApplyCodeFixExpect.toEqual now accepts Record<string, string> to assert on multiple files after a code fix is applied. This enables testing code fixes that write to a different file (e.g., adding augment decorators to a client.tsp).

await ruleTester
  .expect({
    "main.tsp": `import "./client.tsp";\nmodel Foo { name: string; }`,
    "client.tsp": ``,
  })
  .applyCodeFix("add-client-override")
  .toEqual({
    "client.tsp": `@@override(Foo.name, "clientName");\n`,
  });

#10548 Add kind: project and entrypoint support to tspconfig.yaml for defining project boundaries and entrypoint resolution. See Project Configuration for more details.
```
kind: project
entrypoint: src/service.tsp
emit:
  - "@typespec/openapi3"
```
#10694 Added support for accessing late-bound members on models that use template spreads or is bases.

Previously, accessing a member that was introduced via a template instantiation would fail with an invalid-ref error:
```
model Template<T> {
  ...T;
}
model User is Template<{name: string}>;

alias UserName = User.name; // ❌ previously: "Model doesn't have member name"
```
Now, the compiler will force-evaluate the container type when a member lookup fails on a model with unknown members (from template spreads or is), making late-bound members accessible:
```
model Template<T> {
  ...T;
}
model User is Template<{name: string}>;

alias UserName = User.name; // ✅ now resolves correctly
```
This also works with:
- Forward references to the template definition
- Spread-based patterns (model A { ...Template<{x: int32}> })
- Members added by augment decorators
- Circular references between models with late-bound members
#10855 The internal modifier is no longer experimental. Using internal will no longer emit an experimental-feature warning, and #suppress "experimental-feature" directives are no longer needed.
#10826 Add project-scoped compiler feature flags to tspconfig.yaml. Compiler feature definitions are tracked internally with descriptions and can be listed with tsp info features.
```
kind: project
features:
  - function-declarations
```
#9868 Enabled resolution of member properties and metaproperties through template parameters based on constraints.
```
model Resource {
  id: string;
}

model Read<R extends Resource> {
  id: R.id;
}
```

Bug Fixes

#10692 Fix spurious circular-base-type diagnostics after invalid 'model is' declarations.
#10684 Fixed the compiler to correctly detect circular model spread chains while preserving support for recursive model-expression aliases.
#10687 Fix wrongly detected circular reference with alias and model properties
#10643 Completion in the middle of an identifier now replaces the full token instead of inserting and leaving trailing characters
#10827 Language server fatal errors now write pending logs and the fatal stack trace directly to stderr so crash details remain visible.
#10773 Report an error when a function is declared in the $functions map in a JS file but has no corresponding extern fn declaration in TypeSpec. Previously this would silently have no effect.
#10847 [Language Server] Wrapped LSP server handlers with wrapUnhandledError to preserve server-side stack traces in error messages forwarded to the client. Previously, the JSON-RPC layer discarded the original stack trace, making unhandled errors in telemetry opaque.
#10880 Validate function rest arguments and report function call argument count diagnostics at call sites.

1.12.0

Features

#10558 Improve formatting of union expressions

#10352 Add support for configurable options on linter rules

Linter rules can now define typed options with defaults using defaultOptions, and users can pass options when enabling rules in tspconfig.yaml or rulesets.

Defining a rule with options:

const myRule = createRule({
  name: "no-model-with-name",
  severity: "warning",
  description: "Bans models with a specific name",
  messages: { default: "This model name is not allowed" },
  defaultOptions: { bannedName: "Foo" },
  create(context) {
    return {
      model: (target) => {
        if (target.name === context.options.bannedName) {
          context.reportDiagnostic({ target });
        }
      },
    };
  },
});

Configuring options in tspconfig.yaml:

linter:
  enable:
    # Enable with default options
    "@typespec/my-lib/no-model-with-name": true
    # Enable with custom options
    "@typespec/my-lib/no-model-with-name":
      bannedName: "Bar"

#10431 [init] Package dependencies are now populated with the actual latest version at the time (e.g. ^1.11.0)
#10581 Added warnings for duplicate imports and self-imports in the same file

The compiler now warns when a file imports itself or contains duplicate import statements. These are likely mistakes and while they don't cause errors, they add unnecessary noise.
```
import "./main.tsp"; // Warning: A file cannot import itself.

import "./other.tsp";
import "./other.tsp"; // Warning: Duplicate import of "./other.tsp"
```

Bug Fixes

#10618 [LSP] Fix code fixes often not running when selected
#10567 Fix server crashes caused by undefined symbol declarations: add null checks for getSymNode() in hover, completion, type-details, and type-signature handlers, and use fallback name for empty DocumentSymbol names
#10351 Fix formatter crash when an operation's parameter list contains only a block comment (e.g. op find(/* conditions */): unknown;). Dangling comments in empty parameter lists are now preserved instead of being dropped.
#10556 Fix formatting of decorators on operations and augment decorators. Decorators on operations now break to separate lines when the total line exceeds the print width. Augment decorator arguments are now consistently indented when the line breaks, matching TypeScript/prettier function call formatting.
#10580 Hide cursor during spinner animation to prevent flicker on Windows

1.11.0

Features

#9893 Added a new template FilterVisibility to support more accurate visibility transforms. This replaces the @withVisibilityFilter decorator, which is now deprecated and slated for removal in a future version of TypeSpec.

Bug Fixes

#10196 Include model name in duplicate-property error message
#10199 [invalid-discriminated-union-variant] duplicateDefaultVariant diagnostic now includes the union type name
#10183 Do not interpolate non primitive values in config automatically
```
    file-type: ["json", "yaml"]
    output-file: "openapi.{file-type}"
```
Will not be interpolated as openapi.json,yaml but keep the placeholder {file-type} intact for the emitter to handle.
#9893 Fixed a bug that would prevent template parameters from assigning to values in some cases.

1.10.0

Features

#9819 Export resolveCodeFix function to allow resolving a CodeFix into CodeFixEdit[] without the LSP layer.
#9829 tsp info now accepts an optional <libName> argument to display detailed information about a specific library or emitter, including all available options.
#9060 Added support for Functions, a new type graph entity and language feature. Functions enable library authors to provide input-output style transforms that operate on types and values. See the Functions Documentation for more information about the use and implementation of functions.
#9762 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.

Bump dependencies

#9838 Upgrade dependencies

Bug Fixes

#9939 Fix @overload interface validation failing when the enclosing namespace is versioned
#9641 Don't report non-literal-string-template diagnostic when interpolating an invalid reference
#9803 Support TYPESPEC_NPM_REGISTRY environment variable to configure the npm registry used by tsp init and tsp install when fetching package manifests and downloading packages.
#9804 Fix crash when using custom scalar initializer in examples or default values [API] Fix crash in serializeValueAsJson when a custom scalar initializer has no recognized constructor (e.g. S.i() with no args). Now returns undefined instead of crashing.
#9670 Fixed an issue where referencing a member of a templated alias with defaultable parameters would fail to instantiate the alias, leaking template parameters.

1.9.0

Deprecations

#9336 Deprecate program parameter in isArrayModelType and isRecordModelType functions. Use the new single-argument overload instead: isArrayModelType(type) and isRecordModelType(type).

Features

#9078 Remove type constraints from @continuationToken decorator
#9512 [API] Add performance reporting utilities for emitters See docs for more info
#9475 [API] serializeValueAsJson throws a UnsupportedScalarConstructorError for unsupported scalar constructor instead of crashing

Bump dependencies

#9446 Upgrade dependencies

Bug Fixes

#9320 Fix --list-files not working when multiple instance of compiler are loaded
#9607 Fix stack overflow for specs with large number of circular references
#9342 Ensuring ignore-deprecated gets resolved.
#9588 Fixed several checking errors around template instantiations that could cause TemplateParameter instances to leak into decorator calls.

1.8.0

Features

#9295 Add now() initializer to date/time scalars (plainDate, plainTime, utcDateTime, offsetDateTime) for indicating current date/time at runtime. Emitters should interpret this as the appropriate runtime value (e.g., database CURRENT_TIMESTAMP, JavaScript Date.now(), etc.).
#9104 [API] Introduction of decorator validator callbacks. A decorator can define some callbacks to achieve some deferred validation (After the type is finished or the whole graph is)
#9288 [api] Expose createSuppressCodeFixes method to generate multiple code fixes from diagnostics
#9262 Add support for OpenAPI 3.2.0 defaultMapping in discriminated unions. When a discriminated union has a default variant (unnamed variant), it is now properly emitted:
- For OpenAPI 3.2.0: The default variant is included in oneOf array and referenced via discriminator.defaultMapping property
- For OpenAPI 3.0 and 3.1: The default variant is included in oneOf array and its discriminator value is added to the discriminator.mapping object
#9300 Add typekit to tester instances and test compile result"

Bump dependencies

#9223 Upgrade dependencies

Bug Fixes

#9280 suppress - a extends/is inner statement suppress should be generated on the parent model node
#9293 compiler - suppression node selection for operation response bodies
#9308 Fixed mutation of decorator's argument values

1.7.1

Bug Fixes

#9210 Fix crash in tsp init introduced in 1.7.0

1.7.0

Features

#9002 Add commaDelimited and newlineDelimited values to ArrayEncoding enum for serializing arrays with comma and newline delimiters
#8942 - Add 'exit' final event for linter rules
- Support 'async' in linter definition and async function as callback for 'exit' event.
#9024 [API] Add node to SourceModel type
#8619 Add support for escaping param like tags(@param, @prop, etc.) identifier with backtick in doc comments to allow special characters

Bump dependencies

#9046 Upgrade dependencies

Bug Fixes

#8917 Add security warning to tsp init CLI documentation for external templates (#8916)
#8997 UnusedUsing Diagnostics are reported as warning instead of hint when there are linters defined in tspconfig.yaml

1.6.0

Features

#8868 [API] Add new createAddDecoratorCodeFix function to help generating a codefix to add a decorator to a target node.
#8580 Add support for @minValue, @maxValue and their exclusive variant for datetime and duration types. Expose as well the following APIs
- getMinValueForScalar
- getMaxValueForScalar
- getMinValueExclusiveForScalar
- getMaxValueExclusiveForScalar
#8938 [API] Add repository field to PackageJson type

Bump dependencies

#8823 Upgrade dependencies

Bug Fixes

#8792 Compiler internal decorators shouldn't be listed in autocomplete
#8733 Fix issue where namespace with same name but different parent would get merged together when under a file namespace scope.
#8698 [TM Grammar] Fix issue with directive used after decorators
#8751 Correctly report error when trying to reference member of template without using the arguments
#8780 Fix missing examples in OpenAPI when response uses union of unions
#8676 Addressed an issue where applying the Update visibility transform would not correctly rename nested models.
#8687 Fix go to definition for directory imports
#8681 Addressed a bug that could cause duplicate @encodedName applications to be detected when none actually exist.

1.5.0

Features

#8549 [Testing API] Expose marker position in Tester
#8491 Add milliseconds to DurationKnownEncoding
#7929 [LSP] Allow configuring which file names to use as entrypoints
#8525 [API] Expose applyCodeFix and createSuppressCodeFix
#8652 [API] Export getNodeForTarget in @typespec/compiler/ast exports
#8542 [API] Expose applyCodeFixEdits, resolveCodeFix
#8544 [api] adds the ability to pass the suppression message
#8632 [API] Allow using union in emitter schemas
#8586 Widen target types for the @secret decorator to include Model, Union, and Enum types, in addition to existing Scalar and ModelProperty targets. This allows marking any data type as secret for comprehensive data sensitivity handling.
#8055 Show template parameters default in hover signature
#8234 Support codefix on different file and creating file when needed
#8670 [Tester] Support sub exports without having them being defined as separate libraries

Bug Fixes

#8506 Fix issue when the 'entrypoint' setting is default to null
#8462 Fix grammar error in TypeSpec unused-using warning message by removing incorrect word "be" from "never be used"
#8548 Linter rule tester not passing parseDocs option to new tester instance
#8578 Add suppression codefix looks up for the first valid parent
#8452 [Tester] Fix issue that could cause some timeout
#8573 LSP connection failure after dynamically loading a certain library in the package
#8670 Allow importing of self (e.g. @typespec/openapi/some/path when in @typespec/openapi) respecting ESM spec.

1.4.0

Features

#4383 Expose createSourceLoader via @typespec/compiler/ast

Bump dependencies

#8317 Upgrade dependencies

Bug Fixes

#8386 fixed a bug where max/min Items could not be used in combination with a nullable type
#8152 Remove incorrect example of service option model from documents

1.3.0

Features

#7830 [API] resolveCompilerOptions now only takes a SystemHost instead of CompilerHost
#7912 Updates the tsp init command to support passing in more options via CLI flags. The -y option can also be used to auto accept prompts.

Bump dependencies

#7978 Upgrade dependencies

Bug Fixes

#7721 Make the console.* methods usable in the compiler and display them in the vscode output.
#8012 Fix tsp format --check incorrectly validating needs format
#7957 Fix incorrectly reported incompatible-compiler-version in some cases when using symlinks
#7947 [API] [Testing] Ignore test files in legacy library definition
#7899 Ensure model that are spread, intersected or used as the base are fully checked before trying to copy the properties
#8002 Union expression are correctly attached to the namespace they were declared in

1.2.0

Features

#7576 Allow LSP to configure which emitters to include for live checks
#7151 [API] Addition of a new testing framework. See https://typespec.io/docs/extending-typespec/testing

Bump dependencies

#7674 Upgrade dependencies

Bug Fixes

#7586 Improved the error message for the @pattern decorator when applied to a union type. The new message is more descriptive and helps users understand how to correctly define string-compatible union types.
#7740 Config interpolation is more flexible in interpolating variables in any order as long as no circular reference occur. For example using {output-dir} in parameters.
#7731 Fix literal typekits $.literal.create, $.literal.createString, etc. use right checker api that include caching
#7906 Corrected some logic around the detection of array types in visibility calculation.

1.1.0

Features

#7377 Add a --stats flag to tsp compile to log some performance and complexity statistics
#7530 Show the full definition of model and interface when it has 'extends' and 'is' relationship in the hover text
#6923 Init templates can define a project kind which decide if dependencies are added to peer or regular dependencies
#6783 Install packages for unrecognized import via npm command
#7239 [LSP] Expose new compile project command
#7137 Allow passing template parameters as property defaults
#7256 Expose VisibilityFilter.toCacheKey to allow caching results based on visibility filters.

Bump dependencies

#7323 Upgrade dependencies

Bug Fixes

#7421 Fix hanging when using ::returnType meta accessor on operation defined with op is
#7507 Fix empty string emitting error when used in string interpolation in a template
#7524 Fixes an error where reported diagnostics had invalid relative paths on Windows
#7508 Allow extends of array expression for not just template (model MyStrings extends string[])
#7473 Mutator were not mutating tuple values
#7485 Fix paging operations to correctly detect the @pageItems decorator on base models.
#7461 Remove non documented templateArguments property on types
#7480 Fix infinite recursion when navigating paging properties by detecting and handling circular model references.
#7137 Allow passing tempalate parameter values in object and array values used inside the template
#7295 Corrected visibility filtering logic to even more aggressively deduplicate the models it visits when the applied visibility transform does not actually remove any properties from a model.

1.0.0

Features

#7199 Add "capitalize" string helper to compiler
#7180 Add support for formatting tspconfig.yaml with tsp format
#7180 tsp format only formats files it knows about and ignores other. Allowing a more generic glob pattern tsp format . or tsp format "**/*"
#5674 [LSP] Update imports when renaming typespec files
#7125 Adds typekits for getting intrinsic types via $.intrinsic.<type>
#7204 Update typekits is* methods to accept Entity instead of just Type or Value
#7108 Adds support for nesting typekits
#7202 Replaces $.model.getSpreadType with $.model.getIndexType to better reflect what it actually being returned. getSpreadType did not actually return a list of spread types, but the model's indexer type instead.
#7090 Adds TypeKit support for type.inNamespace to check namespace membership
#7167 Adds $.value.resolve and $.type.resolve typekits, and updated $.resolve to return values or types, instead of just types
#7106 Adds $.type.isAssignableTo, $.value.isAssignableTo and $.entity.isAssignableTo typekits. Also registers $.resolve typekit
#7193 Typekits have been moved out of experimental and can now be accessed via the @typespec/compiler/typekit submodule. This also removed the $.type.getDiscriminator typekit in favor of the $.model.getDiscriminatedUnion and $.union.getDiscriminatedUnion typkits.
```
-import { $ } from "@typespec/compiler/experimental/typekit";
+import { $ } from "@typespec/compiler/typekit";
```
#7105 Add typekit support for creating a union from an array of children
#7207 Exposed experimental function isMutableType as unsafe_isMutableType.
#7200 Added an optional nameTemplate argument to @withVisibilityFilter, allowing the visibility filters to rename models as they are transformed. This template is applied by default in the Create, Read, Update, Delete, and Query visibility transform templates. This allows for more flexible renaming than simply using the @friendlyName decorator, as it will change the primary name of the transformed type, reducing the incidence of naming conflicts.

Cached the result of applying visibility filters to types. If the same visibility filter is applied to the same type with the same configuration, the model instance produced by the visibility filter will be object-identical. This should reduce the incidence of multiple models that are structurally equivalent in visibility filters and conflicts over the name of models.

Bug Fixes

#7183 Fix decorators on model properties getting wrongly called when checking the template declaration in the following cases
- inside a union expression
- under an non templated operation under a templated interface
#6938 Fixes template argument resolution when a default template parameter value is resolved by a parent container (e.g. interface) For example:
```
interface Resource<T> {
  read<U = T>(): U;
}

model Foo {
  type: "foo";
}

alias FooResource = Resource<Foo>;

op readFoo is FooResource.read;
```
The returnType for readFoo would be model Foo. Previously the returnType resolved to a TemplateParameter.
#7153 Fixes handling of nested templates in getPlausibleName
#6883 Realm handle multiple instance of compiler loaded at once
#7222 Remove version property on ServiceOptions passed to @service decorator. That handling of that option was removed in 1.0.0-rc.0 where it was previously deprecated. If wanting to specify version in an OpenAPI document use the @OpenAPI.info decorator from the @typespec/openapi library
#7155 Mark TemplateParameter type as an experimental type
#7106 Removes program.checker.isTypeAssignableTo. Use one of the following typekits instead:
- $(program).type.isAssignableTo
- $(program).value.isAssignableTo
- $(program).entity.isAssignableTo
#7207 Weakened rules around @mediaTypeHint decorator, allowing media type hints with suffixes like "application/merge-patch+json".
#7200 Fixed an error in Model visibility filtering where the indexer of a model was ignored. This prevented the value of Array/Record instances from being transformed correctly, as they now should be.

1.0.0-rc.1

Features

#7067 Adding support for nested paging properties.
#6862 --trace cli option applies to all commands now
#7065 Adds a TypeKit for Tuple types
#7049 Adds a new createDiagnosable typekit helper for APIs that return diagnostics
#7018 Removes the default typekit in favor of always instantiating typekits with either a program or realm.
#7047 Adds typekit support for creating unions from enums

Bug Fixes

#6897 Improve errors when loading libraries with invalid exports/main fields
#7069 Mark node property on all typespec types as optional
#7063 Fixes an issue where isError was checking for error types instead of error models.
#7047 Preserve API documentation when calling $.enum.createFromUnion

1.0.0-rc.0

Breaking Changes

#6678 Moved TypeSpecPrettierPlugin type to internal. If wanting to use the prettier pluging programmatically, use it from the @typespec/prettier-plugin-typespec package

#6544 Remove deprecated @typespec/compiler/emitter-framework export in favor of a new package @typespec/asset-emitter

"dependencies": {
+   "@typespec/asset-emitter": "^0.68.0"
}

-import { TypeEmitter, ... } from "@typespec/compiler/emitter-framework";
+import { TypeEmitter, ... } from "@typespec/asset-emitter";

#6754 Reserve additional keywords:
- context
- sym
- prop
- property
- scenario

Bump dependencies

#6595 Upgrade dependencies

Bug Fixes

#6197 Show emitter internal error message in tspconfig
#6710 Updates to scaffolding script and scaffold commands for consistency
#6826 Fix new reserved keywords were not allowed in augment decorator expression
#6697 Fix crash that would happen when a type was mutated while using null in a decorator(e.g. when using versioning library with @example(null))
#6711 Fix extra properties not validated in nested entries of the config
#6711 Fix passing nested emitter options with --option

0.67.2

Bug Fixes

#6648 Fix tsp install broken in standalone CLI

0.67.0

Breaking Changes

#6231 Remove deprecated items:
- @deprecated decorator, use #deprecated directive instead
```
- @deprecated("Message")
+ #deprecated "Message"
```
- @service versions support. Either migrate to @OpenAPI.info or the versioning library
```
- @service({version: "1.0"})
+ @service
+ @OpenAPI.info(#{version: "1.0"})
```
- Removed @knownValues. Use a union with a string variant instead
```
- enum MyKnownValues {a, b}
- @knownValues(MyKnownValues)
- scalar Custom extends string;
+ union Custom {
+   "a", "b", string
+ };
```
- Removed @projectedName Migrate to @encodedName instead.
```
- @projectedName("json", "nbf")
+ @encodedName("application/json", "nbf")
notBefore: int32;
```
- CLI configuration value output-path, use output-dir instead.
- Support for cadlMain in package.json. Migrate to exports["."].tsp instead.
```
- "cadlMain": "lib/main.tsp",
+ "exports": {
+   ".": {
+     "tsp": "lib/main.tsp"
+   }
+ }
```
- Compiling .cadl files, use .tsp instead.
- decoratorArgMarshalling flag in $flags was removed and support for the legacy decorator arg marshalling.
- Using @format on bytes. @format can only be used on string where it defines a known pattern for the string.
- Javascript functions and typescript types:
  - stringTemplateToString
  - CadlLanguageConfiguration
  - CadlPrettierPlugin
  - NodePackage -> PackageJson
  - CadlValue -> TypeSpecValue
  - createCadlLibrary -> createTypeSpecLibrary
  - setCadlNamespace -> setTypeSpecNamespace
  - CadlLibrary -> TypeSpecLibrary
  - SyntaxKind.CadlScript -> SyntaxKind.TypeSpecScript
  - isCadlValueTypeOf -> isTypeSpecValueTypeOf
  - cadlTypeToJson -> typespecTypeToJson
  - checkFormatCadl -> checkFormatTypeSpec
  - cadlVersion -> typespecVersion
  - CadlManifest -> TypeSpecManifest
  - validateDecoratorTargetIntrinsic -> Use extern dec to define the signature of decorators instead
  - validateDecoratorParamType -> Use extern dec to define the signature of decorators instead
  - createDecoratorDefinition -> Use extern dec to define the signature of decorators instead
  - CompilerOptions#emitters -> Use emit and options field instead.
  - Type#templateArguments -> Use templateMapper instead.
  - ModelProperty#default -> Use defaultValue instead.
  - Union#options -> Use variants instead.
  - linter in createTypeSpecLibrary -> Use export const $linter = defineLinter({ ... }) instead.
  - Accessor for removed @knownValues decorator
    - getKnownValues
  - Accessor for removed @projectedName decorator
    - getProjectedNames
    - getProjectedName
    - hasProjectedName
#6323 Move AST related APIS to @typespec/compiler/ast package. This is to mark a clear separation for the AST types and APIs which are considered for advanced usage and might change at any time.
- All *Node types
- exprIsBareIdentifier
- getFirstAncestor
- getIdentifierContext
- getNodeAtPosition
- getNodeAtPositionDetail
- hasParseError
- isImportStatement
- parse
- parseStandaloneTypeReference
- positionInRange
- visitChildren
#6323 Stop exposing APIs that were not meant for external users. Please file issue if you had legitmate use of some of those APIs.
Checker: The check itself should be used very carefully and its wouldn't be covered under the compatibility guarantees. There is some apis that were explicitly marked as internal while other remained until we provide a better way to do the same thing:
- getGlobalNamespaceType(); -> program.getGlobalNamespaceType();
- resolveTypeReference(); -> program.resolveTypeReference();
- checkProgram(); This isn't meant to be used by external users.
- getLiteralType() This isn't meant to be used by external users.
- resolveRelatedSymbols() This isn't meant to be used by external users.
- resolveCompletions() This isn't meant to be used by external users.
Program: Exposed functions on the program are safe to use but a few have been updated to be internal:
- mainFile -> Use projectRoot instead.
- literalTypes This isn't meant to be used by external users.
- checker: This is still exposed but to be used carefully, see above.
- loadTypeSpecScript: This isn't meant to be used by external users.
- onValidate: This isn't meant to be used by external users.
- reportDuplicateSymbols: This isn't meant to be used by external users.
logVerboseTestOutput Internal test util, not meant for external users
validateDecoratorTarget -> migrate to extern dec declaration
validateDecoratorParamCount: Same as above
altDirectorySeparator: Internal path utils
directorySeparator: Internal path utils
isIntrinsicType: Internal check
getFullyQualifiedSymbolName Symbols are an internal aspect of the compiler
Scanner related APIs:
- createScanner
- isComment
- isKeyword
- isModifier
- isPunctuation
- isStatementKeyword
- isTrivia
- skipContinuousIdentifier
- skipTrivia
- skipTriviaBackward
- skipWhiteSpace
- Token
- TokenFlags
- typeDocToken,
- typeScanner,
- typeStringTemplateToken,
Types
- Sym Symbols are an internal aspect of the compiler
- SymbolLinks Symbols are an internal aspect of the compiler
- SymbolTable Symbols are an internal aspect of the compiler
- SymbolFlags Symbols are an internal aspect of the compiler
- MutableSymbolTable Symbols are an internal aspect of the compiler
- ResolutionResult Internal type used in non exposed resolver
- NodeLinks Internal type used in non exposed resolver
- ResolutionResultFlags Internal type used in non exposed resolver
- MetaMemberKey Unused type
- MetaMembersTable Unused type
- Dirent Unused type
#5977 Minimum node version is now 20
#6410 Remove a legacy behavior of resolving package names which wasn't inline with node ESM module resolution.

For example if you were running tsp compile within your node_modules folder(on a test package) and referencing your emitter by name you might need to change this
```
-tsp compile . --emit my-emitter
+tsp compile . ../../  # path to your emitter root instead
```

#6286 Removed deprecated use of @discriminator on union. Migrate to @discriminated

-@discriminator("type")
+@discriminated(#{envelope: "none", discriminatorPropertyName: "type"})
union Pet;

#6327 Remove projection. Projection was an experiemental syntax that was too flawed to be included in 1.0 in that current state.
#6388 Remove deprecated type to value conversion. Since the introductions of object values(#{}) and array values(#[]) using model expressions or tuple where values were expected has been deprecated. It is now an error with a codefix.
```
-@service({title: "My service"})
+@service(#{title: "My service"})
```
#6416 Adding new keywords for future use:
- statemachine
- macro
- package
- metadata
- env
- arg
- declare
- array
- struct
- record
- module
- mod
- pub
- sub
- typeref
- trait
- this
- self
- super
- keyof
- with
- implements
- impl
- satisfies
- flag
- auto
- partial
- private
- public
- protected
- internal
- sealed
- local
- async
#6258 Removed deprecated legacy visibility APIs and converted all warnings for using string-based visibility modifiers to errors.

The removed APIs include:

getVisibility: use getVisibilityForClass instead.
getParameterVisibility: use getParameterVisibilityFilter instead.
getReturnTypeVisibility: use getReturnTypeVisibilityFilter instead.

Furthermore, the legacy signature of isVisible that accepts an array of strings has been removed. Please use the new signature that accepts EnumMember instead.

The changed decorators include:

@visibility
@parameterVisibility
@returnTypeVisibility
@withVisibility
@withDefaultKeyVisibility

The TypeSpec.DefaultKeyVisibility template also no longer accepts a string as a visibility modifier argument.

Attempting to pass a string to any of the above decorators or templates will now result in a type-checking error. Please use the Lifecycle visibility modifiers instead.

If you develop a third-party library and you use any custom visibility modifiers, you will need to instead define a visibility class enum. See: Visibility | TypeSpec.

Migration steps:

String-based visibilities can be replaced as follows:

"create", "read", "update", "delete", and "query" can be replaced with Lifecycle.Create, Lifecycle.Read, Lifecycle.Update, Lifecycle.Delete, and Lifecycle.Query respectively.
@visibility("none") can be replaced with @invisible(Lifecycle).

For example:

@visibility("create", "read")
example: string;

can be replaced with:

@visibility(Lifecycle.Create, Lifecycle.Read)
example: string;

@visibility("none")
example: string;

can be replaced with:

@invisible(Lifecycle)
example: string;

Additionally, @parameterVisibility with no arguments has been made an error. Previously, some specifications used it to disable effective PATCH optionality, but that behavior was an unintended side effect. For example:

@parameterVisibility
@patch
op example(@bodyRoot resource: Resource): Resource;

If you wish to disable effective PATCH optionality in @typespec/http, preventing it from treating all properties of the request body as effectively optional, you can now do so explicitly:

@patch(#{ implicitOptionality: false })
op example(@bodyRoot resource: Resource): Resource;

Deprecations

#6310 Deprecate @typespec/compiler/emitter-framework export in favor of a new package @typespec/asset-emitter

"dependencies": {
+   "@typespec/asset-emitter": "0.67.0"
}

-import { TypeEmitter, ... } from "@typespec/compiler/emitter-framework";
+import { TypeEmitter, ... } from "@typespec/asset-emitter";

#6306 Remove the use of deprecated getDiscriminatedUnion

Features

#6178 Introducing the JS Http Client emitter
#6411 Introduce a new dryRun compiler option(--dry-run in the cli) that emitters can opt-in to support by setting capabilities.dryRun in their $lib.
#6411 Update noEmit compiler option (--no-emit cli flag) to prevent emitter to run. A new dryRun option has been added to achieve a safer similar result where emitters run but do not write output.
#6220 tsp install now downloads and uses the configured package manager in devEngines.packageManager or packageManager field of package.json
#6357 Add support for @mediaTypeHint to apply a hint for default Media/MIME type (Content-Type in HTTP) to a TypeSpec type.

Bump dependencies

#6266 Update dependencies

Bug Fixes

#6335 Improvements to the CLI output
#6315 Fix auto complete cannot replace $ prefix
#6309 Fixed an issue where the --emit-files flag on emitters with nested folders was not generating the correct paths to the files.
#6292 Fix tsp init not respecting default selected emitters

0.66.0

Deprecations

#6059 Deprecate use of @discriminator on union. Migrate to @discriminated

-@discriminator("type")
+@discriminated(#{envelope: "none", discriminatorPropertyName: "type"})
union Pet;

#6088 Deprecate use of string-based visibility modifiers using warnings.

String-based visibilities can be replaced as follows:

"create", "read", "update", "delete", and "query" can be replaced with Lifecycle.Create, Lifecycle.Read, Lifecycle.Update, Lifecycle.Delete, and Lifecycle.Query respectively.
@visibility("none") can be replaced with @invisible(Lifecycle).

For example:

@visibility("create", "read")
example: string;

can be replaced with:

@visibility(Lifecycle.Create, Lifecycle.Read)
example: string;

@visibility("none")
example: string;

can be replaced with:

@invisible(Lifecycle)
example: string;

Additionally, @parameterVisibility with no arguments is deprecated.

@parameterVisibility
@patch
op example(@bodyRoot resource: Resource): Resource;

The effect of @parameterVisibility is to disable effective PATCH optionality. If you wish to disable effective PATCH optionality in @typespec/http, preventing it from treating all properties of the request body as effectively optional, you can now do so explicitly:

@patch(#{ implicitOptionality: false })
op example(@bodyRoot resource: Resource): Resource;

#6108 Migrate @service decorator options to take in a value

-@service({title: "My service"})
+@service(#{title: "My service"})

#6047 --version shows if tsp is running from the standalone version
#5453 Report unused using in language server
#6164 Renamed package @typespec/http-server-javascript to @typespec/http-server-js.

Features

#5483 Add autocomplete of model properties for union type
#5458 Add codefix for for various triple quoted string syntax issues
#6082 Introduced list-files flag to log all emitted files.
#6082 Added a progress indicator to show the current stage of tsp compilation process.
#6059 Add new @discriminated decorator to represent discriminated union with implicit envelopes
#5494 Report unused template parameters in language server
#6045 Redesign and simplification of tsp init
#5996 Add Typekits to support EFV2
#5986 Tsp init template with both config and emitters merge in tspconfig.yaml

Bug Fixes

#4926 Augmenting an expression will now report an error instead of silently failing to apply.
#5937 Fix: StringTemplate type not supported in typespecValueToJson
#6204 Fix @example reporting assignability error when using mix metadata(http) models
#6125 Fix tmlanguage syntax highlighting when using decorator before escaped identifier
#6192 Fix tsp info crash
#6203 Fix mutator not mutating sourceModel(s)

0.65.3

Bug Fixes

#6041 Fix validation issue in @opExample when using versioning/mutators

0.65.2

Bug Fixes

#6003 Fix regression where enum values would report not being assignable to their enum when using versioning

0.65.1

Bug Fixes

#5975 Downgrade arborist dependency which added node20+ requirement

0.65.0

Bug Fixes

#5940 Fix: Infinite loop in language server due to not caching indeterminate entities in templates
#5186 Fix issue that extra " will be added when auto completing emitter options inside ""
#5833 Fix tracing in SourceLoader

Bump dependencies

#5690 Upgrade dependencies

Features

#5572 Add support for ESM subpath imports
#5790 Add option for semantic walker to visit model derived types
#5340 Add Experimental Typekit helpers for @typespec/http
#5716 Updated Rest init template to include additional emitters(client, server) and a basic sample.
#5186 Support the auto completion for extends, imports, rule, rule sets and variables in tspconfig.yaml
#5186 Show required/optional information in the details of emitter's options completion item in tspconfig.yaml
#5342 Convert model/tuple expression to value code fix is applied to the entire value.
#5699 Promote unsafe_useStateMap and unsafe_useStateSet experimental APIs to stable version useStateMap and useStateSet. Old ones are deprecated
#5794 Use local version of npm to manage dependencies when running tsp install
#5824 tsp init will not automatically run tsp install if a package.json file is created.
#4931 [Experimental] Update to subgraph mutator to visit all missing relations
#5416 Added APIs for getting parameterVisibility and returnTypeVisibility as VisibilityFilter objects.

Deprecations

#4931 Deprecate experimental projection.

0.64.0

Bug Fixes

#5295 Fix incorrectly returning a positive BigInt for a negative Numeric.
#5353 Meta property are auto-completed, current only supported '::type', '::parameters', '::returnType'
#5180 Fixed serialization of object examples on unions
#5525 Enum-driven visibility decorators and projections now interact correctly.

Projections now project EnumValue values to preserve consistency with projected Enum/EnumMember types using a best-effort strategy.

Features

#5415 Added support for emitter selections for init template.
#5316 Compiler trace will be sent to IDE as trace log through language server
#5594 Support Emitters section in Init Template when creating TypeSpec project in vscode
#5294 Add capacities in TypeSpec Language Server to support "Scaffolding new TypeSpec project" in IDE

0.63.0

Bug Fixes

#5252 Added RegEx validation for @pattern and will throw warning for invalid RegEx string

Features

#4937 Add mutateSubgraphWithNamespace as a separate API
#4837 Allow trailing delimiter in array values, tuple, decorator declaration, scalar initializer, etc.
#5149 Experimental: Improve Realm, Mutator, and Typekit implementations.

This change strongly binds a Realm and Typekit together, and changes mutators so that new types are cloned within the mutator's realm. The default Typekit now creates a default typekit realm for the current program, and a Typekit can be easily created to work in a specific Program or Realm as needed.

#4825 Adds support for enum-driven visibility in the compiler core.

0.62.0

Bug Fixes

#4745 Improve diagnostic when JS files fail to load due to a JS error

Bump dependencies

#4679 Upgrade dependencies - October 2024

Features

#4807 CLI logs diagnostic source path relative to the CWD.
#4871 [experimental] Mutators: Allow mutating namespaces
#4470 Add support for paginated operations
#4849 Overall of the symbol resolution. TypeSpec is able to resolve anything that can be statically linked. Augment decorators in turn are able to target any statically linkable types.
#4806 Diagnostics emitted in template instance include instantiation trace.
#4790 Support completion for tspconfig.yaml file in vscode

0.61.2

Bug Fixes

#4704 Fix order of resolution from node_modules and parent package

0.61.1

Bug Fixes

#4697 Fix module resolution when resolving self from within another package

0.61.0

Bug Fixes

#4626 [API] Add missing exit callback
#4513 Fixes issue with the semantic walker where exitTuple was not being emitted.
#4462 Fix examples with enums inside of unions
#4574 Fix: Passing const of model type to @example
#4551 Json serialization of example respect @encodedName
#4514 Fix issue with decimal numeric and leading 0.0 with multiple digit
#4445 [API] model sourceModels property are now projected correctly
#4467 Changing tspconfig.yaml won't take effect in LSP server because of the cache
#4563 tsp compile --watch reread from tspconfig.yaml file

Bump dependencies

#4424 Bump dependencies

Features

#4442 Library diagnostic can now define a description and url that links to a more detailed doc for this diagnostic
#4290 Adding experimental (unstable) API fro Type Mutators
#4595 Expose more accurate PackageJson type and deprecate NodePackage
#4606 Add support for node exports field. Specific typespec exports can be provided with the typespec field

"exports": {
  ".": {
    "typespec": "./lib/main.tsp",
  },
  "./named": {
    "typespec": "./lib/named.tsp",
  }
}

#4539 Support nested emitter options

Breaking Changes

#4539 Config parameters and emitters options cannot contains .. This conflict with newly added support for nested options.
#4500 API: Update default of decoratorArgMarshalling from legacy to new

To revert to the old behavior export the following. Highly discouraged, this will be removed in a few versions.

export const $flags = definePackageFlags({
  decoratorArgMarshalling: "legacy",
});

0.60.1

Bug Fixes

#4420 Fix: Numeric values defined with e-notation incorrectly resolved

0.60.0

Bug Fixes

#4381 Fix Semantic walker doesn't fire exitOperation or exitModelProperty
#4146 Fix model expression defined in alias will resolve its namespace from the namespace where the alias was declared
#4147 Fix examples with models using extends
#4144 Fix: Model and union expression in template were not considered as template instances
#4135 Fix numeric 0 stringify producing 0.0
#4064 IDE: Formatting command will use prettier config if provided over the editor's configuration.
#4089 Fix tmlanguage for named type argument in type reference.
#4324 API: Extract source resolution logic into its own source loader

Features

#4139 Add new way to define decorator implementation with $decorators export.

export const $decorators = {
  "TypeSpec.OpenAPI": {
    useRef: $useRef,
    oneOf: $oneOf,
  },
};

#4148 Diagnostics logged to the terminal now have a clickable hyperlink to the diagnostic documentation url if applicable.
#4141 Diagnostic code in IDE now link to the linter rule documentation url if applicable
#4357 Improvements to type relation errors: Show stack when it happens in a nested property otherwise show up in the correct location.

0.59.1

Bug Fixes

#4173 Fix: Revert unix-style warning that was preventing windows path via the CLI as well

0.59.0

Bug Fixes

#3881 Fixes a bug where ending a non-terminal line in a multi-line comment with a backslash caused the next star to show up in the parsed doc string.

#4050 Allow using compact namespace form Foo.Bar when inside another namespace

namespace MyOrg.MyProject {
  namespace MyModule.MySubmodule { // <-- this used to emit an error
    // ...
  }
}

#3898 Fix decimal numeric with leading zeros
#4046 Fix type comparison of literal and scalar when in projection context
#4022 tsp compile --watch will not stop when a crash happens during compilation
#3933 Add const template parameter to get the precise lib type

Bump dependencies

#3948 Update dependencies

Features

#3906 Support completion for template parameter extending model or object value

Example

model User<T extends {name: string, age: int16}> {
}
alias user = User< {┆
                    | [age]
                    | [name]

#4020 Add support for encoding numeric types as string
#4023 Warn when using \ in config file field that expect a path.
#3932 Add ArrayEncoding enum to define simple serialization of arrays

Breaking Changes

#4050 Fix issue where naming a namespace with the same name as the blockless namespace would merge with it instead of creating a subnamespace like any other name would.
```
namespace MyOrg.MyProject;

namespace MyOrg.MyProject.MyArea {
  model A {}
}

namespace MyArea2 {
  model B {}
}
```
Previously model A would end-up in namespace MyOrg.MyProject.MyArea and model B in MyOrg.MyProject.MyArea2. With this change model A will now be in MyOrg.MyProject.MyOrg.MyProject.MyArea. To achieve the previous behavior the above code should be written as:
```
namespace MyOrg.MyProject;

namespace MyArea {
  model A {}
}

namespace MyArea2 {
  model B {}
}
```

0.58.1

Bug Fixes

#3875 Fix issues with examples not working with Array, Record, Union and unknown types

0.58.0

Bug Fixes

#3623 Fix crash of language server on firefox
#3516 Deprecate getAssetEmitter and recommend calling createAssetEmitter directly
#3767 Fix semantic highlighting of using of single namespace
#3824 Do not cast model expression to object value if the constraint is allowing the type
#3577 Fix formatting of object and array literal in decorator to hug parenthesis
#3823 Fix formatting of scalar constructor called with no args
#3743 Fix 'typespec vs install' command on windows
#3605 Fix templates initialized on node 22

Bump dependencies

#3718 Dependency updates July 2024

Features

#3699 Moved compiler dependencies to peer and dev for scaffolded projects.

#3572 Add new @example and @opExample decorator to provide examples on types and operations.

@example(#{
  id: "some",
  date: utcDateTime.fromISO("2020-01-01T00:00:00Z"),
  timeout: duration.fromISO("PT1M"),
})
model Foo {
  id: string;
  date: utcDateTime;

  @encode("seconds", int32) timeout: duration;
}

@opExample(
  #{
    parameters: #{
      pet: #{
        id: "some",
        name: "Fluffy",
        dob: plainDate.fromISO("2020-01-01"),
      },
    },
    returnType: #{
      id: "some",
      name: "Fluffy",
      dob: plainDate.fromISO("2020-01-01"),
    },
  },
  #{ title: "First", description: "Show creating a pet" }
)
op createPet(pet: Pet): Pet;

#3751 Adds option to tsp init to generate .gitignore file

Breaking Changes

#3793 Do not carry over @friendlyName with model is or op is

@friendlyName("Abc{T}", T)
model Foo<T> {}

model Bar is Foo<string>;

// This can be changed to
model Abcstring is Foo<string>;

#3659 Disallows overriding a required inherited property with an optional property.

In previous versions of TypeSpec, it was possible to override a required property with an optional property. This is no longer allowed. This change may result in errors in your code if you were relying on this bug, but specifications that used this behavior are likely to have been exposed to errors resulting from incoherent type checking behavior.

The following example demonstrates the behavior that is no longer allowed:

model Base {
  example: string;
}

model Child extends Base {
  example?: string;
}

In this example, the Child model overrides the example property from the Base model with an optional property. This is no longer allowed.

0.57.0

Breaking changes

#3022 Addition of new const keyword means using const as a property name or decorator name will result in an error. This can be fixed by wrapping the property in backtick.

model Test {
  // error
  const: string;

  // correct
  `const`: string;

}

Bug Fixes

#3399 Preserve leading whitespace in fenced blocks in doc comments
#3566 [API] Do not run decorators on cloned type if the original type wasn't finished
#3522 Fix EINVAL error when running tsp code install
#3371 Numeric not handling trailing zeros and causing freeze(e.g. const a = 100.0)
#3451 Emitter framework: fix losing context when referencing circular types
#3517 Fix application of @param doc tag on operation create with op is to override upstream doc
#3488 Add PickProperties type to dynamically select a subset of a model

Bump dependencies

#3401 Update dependencies - May 2024

Features

#3280 Support completion for Model with extended properties

Example

model Device {
  name: string;
  description: string;
}

model Phone extends Device {
  ┆
} | [name]
  | [description]

#3280 Support completion for object values and model expression properties.

Example

model User {
  name: string;
  age: int32;
  address: string;
}

const user: User = #{name: "Bob", ┆}
                                  | [age]
                                  | [address]

#3375 Allow @ to be escaped in doc comment with \
#3022 Add syntax for declaring values. See docs.

Object and array values

@dummy(#{
  name: "John",
  age: 48,
  address: #{ city: "London" }
  aliases: #["Bob", "Frank"]
})

Scalar constructors

scalar utcDateTime {
  init fromISO(value: string);
}

model DateRange {
  minDate: utcDateTime = utcDateTime.fromISO("2024-02-15T18:36:03Z");
}

#3527 Add support for @prop doc comment tag to describe model properties
#3422 Formatter: Indent or dedent multiline strings to the current indentation
#3460 Hide deprecated items from completion list

#3443 Support completion for keyword 'extends' and 'is'

Example

model Dog ┆ {}
          | [extends]
          | [is]

scalar Addresss ┆ 
                | [extends]

op jump ┆ 
        | [is]

interface ResourceA ┆ {}
                    | [extends]

model Cat<T ┆> {}
            | [extends]

#3462 Linter all rulesets is automatically created if not explicitly provided
#3533 More logs and traces are added for diagnostic and troubleshooting in TypeSpec language server

Deprecations

#3022 Using a tuple type as a value is deprecated. Tuple types in contexts where values are expected must be updated to be array values instead. A codefix is provided to automatically convert tuple types into array values.

model Test {
  // Deprecated
  values: string[] = ["a", "b", "c"];
  
  // Correct
  values: string[] = #["a", "b", "c"];

#3022 Using a model type as a value is deprecated. Model types in contexts where values are expected must be updated to be object values instead. A codefix is provided to automatically convert model types into object values.

model Test {
  // Deprecated
  user: {name: string} = {name: "System"};
  
  // Correct
  user: {name: string} = #{name: "System"};

#3022 Decorator API: Legacy marshalling logic

With the introduction of values, the decorator marshalling behavior has changed in some cases. This behavior is opt-in by setting the valueMarshalling package flag to "new", but will be the default behavior in future versions. It is strongly recommended to adopt this new behavior as soon as possible.

Example:

extern dec multipleOf(target: numeric | Reflection.ModelProperty, value: valueof numeric);

Will now emit a deprecated warning because value is of type valueof string which would marshall to Numeric under the new logic but as number previously.

To opt-in you can add the following to your library js/ts files.

export const $flags = definePackageFlags({
  decoratorArgMarshalling: "new",
});

0.56.0

Bug Fixes

#3170 --nostdlib flag will now work by only applying to optional standard library types
#3212 Fix: augmenting template model property could result in sending invalid argument to decorator
#3188 Fix: Do not crash when trying to access member of aliased expressions
#3185 Fix tsp init hanging when done due to unclosed connection
#3151 IDE: Fix completion of statement keywords
#3287 Templated interface extending another templated interface shouldn't run decorator on their operations
#3290 Model with an optional property should not satisfy a constraint with that property required. ({foo?: string} cannot be assigned to a constraint of {foo: string})
#3163 Fix: Model with spread indexer shouldn't validate explicit properties
#3227 Stop running decorators on partially instantiated operations(When interface is instantiated but not the operation)
#3180 Fix issue where directives were not parsed to the leaf node in multi-segment Namespace segments.
#3243 Fix calling tsp install on windows due to recent NodeJS breaking change to fix vulnerability.
#3216 Fix compiler crash when using an invalid is target in an interface operation template
#3246 Internals: Use node built-in fetch API that is now stable since node 18.13.0

Bump dependencies

#3169 Update dependencies

Features

#3035 getEncode returns the fully qualified enum member name if using a custom enum.
#3183 Show template parameters when hovering on an operation template
#3191 [API] Add new sourceModels property to model

0.55.0

Bug Fixes

#3018 Grammar: Fix comments in template params not tokenized
#3052 Fix: Union template declaration were incorrectly being finished in projection
#2983 Warnings converted to error with warn-as-error do not prevent compilation from moving to the next stage like regular warnings
#3041 Improve relability of application of codefixes in IDE, often it would not do anything
#3069 TmLanguage: Fix tokenization of escaped identifiers, enums and unions

Bump dependencies

#3027 Update dependencies

Features

#2992 Enable the use of @encode for model properties that have a union type. This supports cases like @encode("rfc3339") prop: utcDateTime | null
#3053 Experimental projection: Add support for scalars

Deprecations

#3094 Deprecate @knownValues decorator. Use a named union of string literal with a string variant to achieve the same result without a decorator

Example:

-enum FooKV { a, b, c}
-@knownValues(FooKV)
-scalar foo extends string;
+union Foo { "a", "b", "c", string }

#2910 Deprecate @projectedName decorator. @encodedName should be used instead.

Example:

-@projectedName("json", "exp")
+@encodedName("application/json", "exp")

0.54.0

Bug Fixes

#2932 Report error when having a circular template constraint e.g. model Example<T extends T>
#2955 [Formatter] Formatting file with only comments would reorder the first line.
#2934 [IDE] Fix issue when deleting an open file outside the IDE that would crash the language server
#2959 Decorators that have missing arguments will not run. This is inline with passing invalid argument to a decorator that would prevent it from running.
#2976 [IDE] Fix type documentation shown twice when hovering symbols or in completion details.
#2929 [API] Add Scalar to TS TemplatedType type
#2978 [IDE] Go to imports
#2936 [IDE] Autocompleting file or folder with non alpha numeric charachter completes correctly
#2936 [IDE] Fix crashing when trying to autocomplete an invalid folder
#2951 Wrap string in quotes in errors
#2886 Fix: tsp compile --watch was missing coloring and error previews

Bump dependencies

#2900 Update dependencies

Features

#2888 Add support for codefixes
#2920 Add support for ...Record<T> to define the type of remaining properties
#2968 Any subtype of an error(marked with @error) is now an error.

Deprecations

#2919 [API] Create a new export @typespec/compiler/utils exports. Deprecate export from @typespec/compiler of utils like DuplicateTracker, Queue, createTwoKeyMap, etc.
#2902 Deprecate @service version property. If wanting to describe a service versioning you can use the @typespec/versioning library. If wanting to describe the project version you can use the package.json version. For OpenAPI generation. the @OpenAPI.info nows decorator allows providing the document version.

Breaking Changes

#2920 Intersecting Record with incompatible properties will now emit an error

0.53.1

Patch Changes

e6a045b: Allow using default values for union property types

0.53.0

Minor Changes

15f6dbe: Added an optional validation message to the @pattern decorator.
9726b3d: Emitter framework: ObjectBuilder will keep track when built using a Placeholder allowing data to be carried over when chaining ObjectBuilder

Patch Changes

cc2723a: Template instantiated with ErrorType will get the arg changed to unknown
fd4fdfb: Fix: Error out when using properties in array model

0.52.0

Wed, 24 Jan 2024 05:46:53 GMT

Updates

add bytes encode to the general encode type
Added support for named template arguments (#2340)
Feature: Added encoded name decorator
Add a new init template for creating a new emitter
Added new --template option to tsp init command line action which lets user specify which template to choose from in the template list.
IDE: Performance improvements to the language server.
Fix: Compiler couldn't resolve files at a long path(256+) on windows
Stop warning user when tsp init a template without compilerVersion specified
Library declaration: Deprecated linter property on $lib in favor of a new $linter variable that can be exported. This was done to prevent circular reference caused by referencing linter rules in $lib.
Library declaration: State symbols can now be declared in the library declaration(Prefereably internal declaration added above) to have a central place to define state symbols used in your libraries.
Add a new tsp init template for setting up a library
Rename template parameters in preparation for named template argument instantiation.
Add ability to use another template parameter as a constraint. e.g. model Foo<A, B extends A>
Add new helper function to change casing to the init templates
Update dependencies

0.51.0

Wed, 06 Dec 2023 19:40:58 GMT

Updates

[API] Emitter framework: emitTypeReference function takes an optional reference context that can be used to patch the context for the target.
Emitter API: Added absolute-path as a known format for emitter options which will validate the value passed by the user resolve to an absolute path.
Linter rules can provide a url to the full documentation
New language feature BREAKING Added string template literal in typespec. Single and multi-line strings can be interpolated with ${ and }. Example \Doc for url ${url} is here:$ {location}``
Formatter: Fix: valueof expression with parentheses around will preserve them when they are meaningful(For example inside a union or array expression)
Emitter framework: allows scalar and enum declaration to provide a reference context.
Fix: Union variant are now assignable to the parent union
Emitter framework: Allow passing a custom context when calling emitType
Upgrade formatter to prettier 3.1

0.50.0

Wed, 08 Nov 2023 00:07:17 GMT

Updates

Add new unixTimestamp32 scalar to standard library
Fixing @doc and /** */ disappears from multi-segment or nested namespaces. #2642
Fix issue where using @overload could result in incorrect unassignable type errors.
Add new hook for handling circular references
Fix: Issue where referencing a template in an alias might cause augment decorators to not be applied on types referenced in the aliased type.
[Internal] Fix: RekeyableMap kept track of old value if rekeying to an existing item
Fix: Properties filtered with @withVisibility will have their visibility removed. This prevent visibility from being applied twice and rendering invalid models
TypeEmitter now supports Tuples.
Issue error if a model spreads itself within its declaration.
Stop showing empty code frame when diagnostic has no location
TypeScript use types entry under exports of package.json instead of legacy typesVersions to provide the definition files
BREAKING CHANGE Dropped support for node 16, minimum node version is now 18

0.49.0

Wed, 11 Oct 2023 23:31:35 GMT

Updates

Handle hyphen in @param doc comment
The never type is now assignable to all types
Allow nullable types for constraint decorators(min/max value, length, etc)
Add support for @returns and @errors doc comment tags. @returns(or @returnsDoc decorator) can be used to describe the success return types of an operation. @errors(or @errorsDoc decorator) can be used to describe the error return types of an operation.
Fix: Colorization of line comment was bleeding over to the next line(s).
Fix crash when using parenthesis on directives
Fix: Assigning negative and 0 to float64
tsp format now returns a non-zero exit code when it fails to format a file
Fix: Anonymous union variants were formatted with an extra leading :
Formatter: Unions and Enums members are now formatted following the same rules as model properties. An extra line will be added between members if the member is annotated with a decorator, directive or doc comment.
Fix: Correct formatting of comments between a directive or doc and its node
Fix: tsp init was not creating the tspconfig.yaml file for templates that specified it
Fix: tsp init will create a placeholder tspconfig.yaml file for templates that don't specify an explicit one.
Fix tsp init was ignoring the files specified in an init template
Fix: Language Server wasn't loading the tspconfig.yaml correctly resulting in some options being dropped like the linter configuration.
Fix: Allow null to be assigned as a default value
Fix: Using TypeSpec.Xyz namespace shouldn't require the TypeSpec Prefix
Skip emit of deprecated diagnostic for a type reference that is used in a deprecated declaration statement
Update dependencies
Remove decorators export, import decorators individually

0.48.1

Tue, 19 Sep 2023 19:28:32 GMT