Guideline for client emitter

This document will guide you on how to use the TypeSpec Client Generator Core (TCGC) in client emitters. TCGC is a library that introduces a client type graph and provides useful helper functions for client emitters to generate client code. Client emitters do not need to interact with the TypeSpec core API directly; they can use the client type graph to obtain enough information to generate client code.

Basic concepts

TODO

TCGC options

TODO

Client type graph

Package

SdkPackage represents a client package. It contains all clients and types information in either a flattened structure or a namespace hierarchy. It also includes common information useful for client code generation.

License Info

The licenseInfo property of the LicenseInfo type in SdkPackage contains the license information to be used for client code license comments or license file generation.

If licenseInfo is undefined, no license information should be included in the generated client code or separate license file.

Client emitters should use licenseInfo.name (license name), licenseInfo.company (company name), licenseInfo.link (link to the official license document), licenseInfo.header (license sentences for code header comments), and licenseInfo.description (license sentences for separate license file) directly when generating license information in configuration files, code files, or license files. Client emitters do not need to handle how the license information is configured.

For Azure services, client emitters should hard-code the license.name configuration to MIT License and license.company configuration to Microsoft Corporation when calling createSdkContext.

export async function $onEmit(context: EmitContext<SdkEmitterOptions>) {
  context.options.license = {
    name: "MIT License",
    company: "Microsoft Corporation",
  };
  const sdkContext = await createSdkContext(context);
  // ...
}

Client

TODO

Method

TODO

Operation

TODO

Type

TODO