Emitter usage

Usage

Via the command line

tsp compile . --emit=@typespec/http-client-csharp

Via the config

emit:
  - "@typespec/http-client-csharp"

The config can be extended with options as follows:

emit:
  - "@typespec/http-client-csharp"
options:
  "@typespec/http-client-csharp":
    option: value

Emitter options

`api-version`

Type: string

For TypeSpec files using the @versioned decorator, set this option to the version that should be used to generate against.

`generate-protocol-methods`

Type: boolean

`generate-convenience-methods`

Type: boolean

`unreferenced-types-handling`

Type: "removeOrInternalize" | "internalize" | "keepAll"

Defines the strategy on how to handle unreferenced types. The default value is removeOrInternalize.

`new-project`

Type: boolean

Set to true to overwrite the csproj if it already exists. The default value is false.

`clear-output-folder`

Type: boolean

Indicates if you want to clear the output folder before generating. The default value is true.

`save-inputs`

Type: boolean

Set to true to save the tspCodeModel.json and Configuration.json files that are emitted and used as inputs to the generator. The default value is false.

`package-name`

Type: string

Define the package name. If not specified, the first namespace defined in the TypeSpec is used as the package name.

`debug`

Type: boolean

Set to true to automatically attempt to attach to a debugger when executing the C# generator. The default value is false.

`logLevel`

Type: "info" | "debug" | "verbose"

Set the log level. The default value is info.

`disable-xml-docs`

Type: boolean

Set to true to disable XML documentation generation. The default value is false.

`generator-name`

Type: string

The name of the generator. By default this is set to ScmCodeModelGenerator. Generator authors can set this to the name of a generator that inherits from ScmCodeModelGenerator.

`emitter-extension-path`

Type: string

Allows emitter authors to specify the path to a custom emitter package, allowing you to extend the emitter behavior. This should be set to import.meta.url if you are using a custom emitter.

`update-code-model`

Type: object

Allows emitter authors to specify a custom function to modify the generated code model before emitting. This is useful for modifying the code model before it is passed to the generator.

`license`

Type: object

License information for the generated client code.

`sdk-context-options`

Type: object

The SDK context options that implement the CreateSdkContextOptions interface from the @azure-tools/typespec-client-generator-core package to be used by the CSharp emitter.