Skip to main content

haskell_binary

name​

def name(
    *,
    name: str,
    default_target_platform: None | str = ...,
    target_compatible_with: list[str] = ...,
    compatible_with: list[str] = ...,
    exec_compatible_with: list[str] = ...,
    visibility: list[str] = ...,
    within_view: list[str] = ...,
    metadata: OpaqueMetadata = ...,
    tests: list[str] = ...,
    modifiers: OpaqueMetadata = ...,
    _apple_platforms: dict[str, str] = ...,
    _cxx_toolchain: str = ...,
    _haskell_toolchain: str = ...,
    auto_link_groups: bool = ...,
    compiler_flags: list[str] = ...,
    contacts: list[str] = ...,
    default_host_platform: None | str = ...,
    deps: list[str] = ...,
    deps_query: None | str = ...,
    enable_profiling: bool = ...,
    ghci_platform_preload_deps: list[(str, list[str])] = ...,
    ghci_preload_deps: list[str] = ...,
    labels: list[str] = ...,
    licenses: list[str] = ...,
    link_deps_query_whole: bool = ...,
    link_group_deps: list[str] = ...,
    link_group_map: None | str | list[(str, list[(None | str | list[None | str], str, None | str | list[str], None | str)], None | dict[str, typing.Any])] = ...,
    link_group_public_deps_label: None | str = ...,
    link_style: None | str = ...,
    linker_flags: list[str] = ...,
    main: None | str = ...,
    platform: None | str = ...,
    platform_deps: list[(str, list[str])] = ...,
    platform_linker_flags: list[(str, list[str])] = ...,
    srcs: list[str] | dict[str, str] = ...,
    template_deps: list[str] = ...,
) -> None

A haskell_binary() rule represents a groups of Haskell sources and deps which build an executable.

Parameters​

  • name: name of the target
  • default_target_platform: specifies the default target platform, used when no platforms are specified on the command line
  • target_compatible_with: a list of constraints that are required to be satisfied for this target to be compatible with a configuration
  • compatible_with: a list of constraints that are required to be satisfied for this target to be compatible with a configuration
  • exec_compatible_with: a list of constraints that are required to be satisfied for this target to be compatible with an execution platform
  • visibility: a list of visibility patterns restricting what targets can depend on this one
  • within_view: a list of visibility patterns restricting what this target can depend on
  • metadata: a key-value map of metadata associated with this target
  • tests: a list of targets that provide tests for this one
  • modifiers: an array of modifiers associated with this target
  • compiler_flags: Flags to pass to the Haskell compiler when compiling this rule's sources.
  • deps: Either haskell_library() or prebuilt_haskell_library() rules from which this rules sources import modules or native linkable rules exporting symbols this rules sources call into.
  • link_group_deps: Additional targets to traverse when building link groups, but which should not be direct dependencies of the main executable.
  • link_group_public_deps_label: Surface nodes with this label as "public" nodes in the main executable when linking with with link groups.
  • link_style: Determines whether to build and link this rule's dependencies statically or dynamically. Can be either static, static_pic or shared.
  • main: The main module serving as the entry point into the binary. If not specified, the compiler default is used.
  • platform_deps: Platform specific dependencies. These should be specified as a list of pairs where the first element is an un-anchored regex (in java.util.regex.Pattern syntax) against which the platform name is matched, and the second element is a list of dependencies (same format as deps) that are exported if the platform matches the regex. See deps for more information.
  • srcs: A list of Haskell sources to be built by this rule. The dictionary option is deprecated.

Details​

Examples:


haskell_binary(
  name = 'foo',
  srcs = [
    'Foo.hs',
  ],
)