Packages > pkg.pkl-lang.org/pkl-go/pkl.golang

pkl.golang.GeneratorSettings0.8.0

Properties
Methods

module pkl.golang.GeneratorSettings

Settings to configure Go code generation for Pkl files.

Module URI:: package://pkg.pkl-lang.org/pkl-go/pkl.golang@0.8.0#/GeneratorSettings.pkl
Source code:: GeneratorSettings.pkl
Known subtypes:
Known usages:
All versions:

Properties(show inherited)

link

hidden

output: ModuleOutput (pkl.base)Source

The output of this module.

Defaults to all module properties rendered as either Pcf or the format specified on the command line.
link
packageMappings: Mapping<String, String>Source

Mapping of Pkl module names to their respective Go package name.
Example:
```
packageMappings {
  ["name.of.my.Module"] = "github.com/myteam/myorg/foo"
}
```
link

basePath: String Source

The base path for module output.

This determines the relative path that generated Go source code will be written to. For example, a base path of "github.com/foo/bar" means that the Go files for package github.com/foo/bar/baz will be written into a baz directory, relative to the current working directory where codegen is executed.

Any Go packages that are not prefixed with basePath are skipped from code generation.

This is typically a Go module's name, i.e. the module clause within a go.mod file.

If empty, writes the full package path to the current directory.
link
structTags: StructTags Source

Additional struct tags to place on all properties.
In addition to these tags, every property implicitly receives a pkl: struct tag.

The placeholder %{name} gets substituted with the name of the Pkl property.

Struct tags can also be configured on a per-property basis using the go.Field annotation.

Example:
```
structTags {
  ["json"] = "%{name},omitempty"
}
```
link

generatorScriptPath: String Source

The path to the Pkl code generator script.

This is an internal setting that is used for testing purposes when developing the code generator.
link

allowedModules: Listing<String>Source

URI patterns that determine which modules can be loaded and evaluated.

This corresponds to the --allowed-modules flag in the Pkl CLI.
link

allowedResources: Listing<String>Source

URI patterns that determine which external resources can be read.

This corresponds to the --allowed-resources flag in the Pkl CLI.
link

projectDir: String?Source

The project directory to control dependency and evaluator settings during codegen.

This corresponds to the --project-dir flag in the Pkl CLI. Relative paths are resolved against the enclosing file.

Paths must use / as the path separator.
link

cacheDir: String?Source

The cache directory for storing packages.

This corresponds to the --cache-dir flag in the Pkl CLI. Relative paths are resolved against the enclosing file.

Paths must use / as the path separator.
link

dryRun: Boolean Source

Print out the names of the files that will be generated, but skip writing anything to disk.
link

uri: String Source

The URI of this module, used to resolve projectDir.

Methods(show inherited)

link

function

getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.
link

function
relativePathTo(other: Module): List<String> (pkl.base)Source

Returns the relative, descendent directory path between this module and other.
Throws if no such path exists.

For example, if module mod1 has path /dir1/mod1.pkl, and module mod2 has path /dir1/dir2/dir3/mod2.pkl, then mod1.relativePathTo(mod2) will return List("dir2", "dir3").

A common use case is to compute the directory path between a template located at the root of a hierarchy (say rootModule.pkl) and the currently evaluated module (accessible via the module keyword):
```
import "rootModule.pkl" // self-import
path = rootModule.relativePathTo(module)
```