Skip to content

Emitter usage

Emitter usage

Section titled “Emitter usage”
  1. Via the command line
Terminal window
tsp compile . --emit=@azure-tools/typespec-go
  1. Via the config
emit:
  - "@azure-tools/typespec-go"

The config can be extended with options as follows:

emit:
  - "@azure-tools/typespec-go"
options:
  "@azure-tools/typespec-go":
    option: value

Emitter options

Section titled “Emitter options”

emitter-output-dir

Section titled “emitter-output-dir”

Type: absolutePath

Defines the emitter output directory. Defaults to {output-dir}/@azure-tools/typespec-go See Configuring output directory for more info

azcore-version

Section titled “azcore-version”

Type: string

Semantic version of azcore without the leading ‘v’ to use if different from the default version (e.g. 1.2.3).

containing-module

Section titled “containing-module”

Type: string

The module into which the package is being emitted. Mutually exclusive with module.

disallow-unknown-fields

Section titled “disallow-unknown-fields”

Type: boolean

When true, unmarshalers will return an error when an unknown field is encountered in the payload. The default is false.

file-prefix

Section titled “file-prefix”

Type: string

Optional prefix to file names. For example, if you set your file prefix to “zzz_”, all generated code files will begin with “zzz_”.

generate-fakes

Section titled “generate-fakes”

Type: boolean

When true, enables generation of fake servers. The default is false.

go-generate

Section titled “go-generate”

Type: string

Path to a post-generation ‘go generate’ script. The path is relative to the emitter-output-dir.

head-as-boolean

Section titled “head-as-boolean”

Type: boolean

When true, HEAD requests will return a boolean value based on the HTTP status code. The default is false.

inject-spans

Section titled “inject-spans”

Type: boolean

Enables generation of spans for distributed tracing. The default is false.

module

Section titled “module”

Type: string

The module identity to use in go.mod. Mutually exclusive with containing-module.

omit-constructors

Section titled “omit-constructors”

Type: boolean

When true, client constructors are not emitted. The default is false.

rawjson-as-bytes

Section titled “rawjson-as-bytes”

Type: boolean

When true, properties that are untyped (i.e. raw JSON) are exposed as []byte instead of any or map[string]any. The default is false.

slice-elements-byval

Section titled “slice-elements-byval”

Type: boolean

When true, slice elements will not be pointer-to-type. The default is false.

single-client

Section titled “single-client”

Type: boolean

Indicates package has a single client. This will omit the Client prefix from options and response types. If multiple clients are detected, an error is returned. The default is false.

stutter

Section titled “stutter”

Type: string

Uses the specified value to remove stuttering from types and funcs instead of the built-in algorithm.

fix-const-stuttering

Section titled “fix-const-stuttering”

Type: boolean

When true, fix stuttering for const types and values. The default is false.

generate-examples

Section titled “generate-examples”

Type: boolean

Deprecated. Use generate-samples instead.

generate-samples

Section titled “generate-samples”

Type: boolean

When true, generate example tests. The default is false.

factory-gather-all-params

Section titled “factory-gather-all-params”

Type: boolean

Default: true

When true, the NewClientFactory constructor gathers all parameters. When false, it only gathers common parameters of clients. The default is true.