Emitter usage

Usage

Via the command line

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

Via the config

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

The config can be extended with options as follows:

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

Emitter options

`emitter-output-dir`

Type: absolutePath

Defines the emitter output directory. Defaults to {output-dir}/@typespec/http-server-csharp See Configuring output directory for more info

`skip-format`

Type: boolean

Skips formatting of generated C# Types. By default, C# files are formatted using ‘dotnet format’.

`output-type`

Type: "models" | "all"

Chooses which service artifacts to emit. choices include ‘models’ or ‘all’ artifacts.

`emit-mocks`

Type: "mocks-and-project-files" | "mocks-only" | "none"

Emits mock implementations of business logic, setup code, and project files, enabling the service to respond to requests before a real implementation is provided

`use-swaggerui`

Type: boolean

Configure a Swagger UI endpoint in the development configuration

`openapi-path`

Type: string

Use openapi at the given path for generating SwaggerUI endpoints. By default, this will be ‘openapi/openapi.yaml’ if the ‘use-swaggerui’ option is enabled.

`overwrite`

Type: boolean

When generating mock and project files, overwrite any existing files with the same name.

`project-name`

Type: string

The name of the generated project.

`http-port`

Type: number

The service http port when hosting the project locally.

`https-port`

Type: number

The service https port when hosting the project locally.