Spell incantation for Go toolchain "build" command #28
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
To run the `go build` command of the Go toolchain, the new
`spell.Incantation` [1] has been implemented in the new build [2]
package that can be used through a Go toolchain caster [3].
The spell incantation can be configured through the following functions:
- `WithBinaryArtifactName(name string) build.Option` - sets the name for
the binary build artifact.
- `WithCrossCompileTargetPlatforms(platforms ...string) build.Option` -
sets the names of cross-compile platform targets.
- `WithFlags(flags ...string) build.Option` - sets additional flags to
pass to the Go `build` command along with the base Go flags.
- `WithGoOptions(goOpts ...spellGo.Option) build.Option` - sets shared
Go toolchain commands options.
- `WithOutputDir(dir string) build.Option` - sets the output directory,
relative to the project root, for compilation artifacts.
To unify further implementations for the Go toolchain, a new `Options`
struct type has also been implemented in the golang [4] package that
stores global/shared Go toolchain options that are shared between
multiple Go toolchain commands:
- `WithAsmFlags(asmFlags ...string) golang.Option` - sets flags to pass
on each `go tool asm` invocation.
- `WithRaceDetector(enableRaceDetector bool) golang.Option` - indicates
if the race detector should be enabled.
- `WithTrimmedPath(enableTrimPath bool) golang.Option` - indicates if
all file system paths should be removed from the resulting executable.
- `WithEnv(env map[string]string) golang.Option` - adds or overrides Go
toolchain command specific environment variables.
- `WithFlags(flags ...string) golang.Option` - sets additional Go
toolchain command flags.
- `WithFlagsPrefixAll(flagsPrefixAll bool) golang.Option` - indicates if
the values of `-asmflags` and `-gcflags` should be prefixed with the
`all=` pattern in order to apply to all packages.
- `WithGcFlags(gcFlags ...string) golang.Option` - sets flags to pass on
each `go tool compile` invocation.
- `WithLdFlags(ldFlags ...string) golang.Option` - sets flags to pass on
each `go tool link` invocation.
- `WithMixins(mixins ...spell.Mixin) golang.Option` - sets
`spell.Mixin`s that can be applied by option consumers.
- `WithTags(tags ...string) golang.Option` - sets Go toolchain tags.
The new `CompileFormula(opts ...Option) []string` function [5] can be
used to compile the formula for these options.
[1]: https://pkg.go.dev/github.com/svengreb/wand/pkg/spell#Incantation
[2]: https://pkg.go.dev/github.com/svengreb/wand/pkg/spell/golang/build
[3]: https://pkg.go.dev/github.com/svengreb/wand/pkg/cast/golang#Caster
[4]: https://pkg.go.dev/github.com/svengreb/wand/pkg/spell/golang
[5]: https://pkg.go.dev/github.com/svengreb/wand/pkg/spell/golang#CompileFormula
GH-27
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #27