haskell_binary

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

Function Signature

def haskell_binary(
    *,
    name: str,
    default_target_platform: None | str = None,
    target_compatible_with: list[str] = [],
    compatible_with: list[str] = [],
    exec_compatible_with: list[str] = [],
    visibility: list[str] = [],
    within_view: list[str] = ["PUBLIC"],
    metadata: OpaqueMetadata = {},
    tests: list[str] = [],
    modifiers: OpaqueMetadata = [],
    _apple_platforms: dict[str, str] = {},
    _cxx_toolchain: str = "gh_facebook_buck2_shims_meta//:cxx",
    _haskell_toolchain: str = "gh_facebook_buck2_shims_meta//:haskell",
    auto_link_groups: bool = False,
    compiler_flags: list[str] = [],
    contacts: list[str] = [],
    default_host_platform: None | str = None,
    deps: list[str] = [],
    deps_query: None | str = None,
    enable_profiling: bool = False,
    ghci_platform_preload_deps: list[(str, list[str])] = [],
    ghci_preload_deps: list[str] = [],
    labels: list[str] = [],
    licenses: list[str] = [],
    link_deps_query_whole: bool = False,
    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])] = None,
    link_group_public_deps_label: None | str = None,
    link_style: None | str = None,
    linker_flags: list[str] = [],
    main: None | str = None,
    platform: None | str = None,
    platform_deps: list[(str, list[str])] = [],
    platform_linker_flags: list[(str, list[str])] = [],
    srcs: list[str] | dict[str, str] = [],
    template_deps: list[str] = [],
) -> None

Parameters

• name: (required)

  name of the target

• default_target_platform: (defaults to: None)

  specifies the default target platform, used when no platforms are specified on the command line

• target_compatible_with: (defaults to: [])

  a list of constraints that are required to be satisfied for this target to be compatible with a configuration

• compatible_with: (defaults to: [])

  a list of constraints that are required to be satisfied for this target to be compatible with a configuration

• exec_compatible_with: (defaults to: [])

  a list of constraints that are required to be satisfied for this target to be compatible with an execution platform

• visibility: (defaults to: [])

  a list of visibility patterns restricting what targets can depend on this one

• within_view: (defaults to: ["PUBLIC"])

  a list of visibility patterns restricting what this target can depend on

• metadata: (defaults to: {})

  a key-value map of metadata associated with this target

• tests: (defaults to: [])

  a list of targets that provide tests for this one

• modifiers: (defaults to: [])

  an array of modifiers associated with this target

• compiler_flags: (defaults to: [])

  Flags to pass to the Haskell compiler when compiling this rule's sources.

• deps: (defaults to: [])

  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: (defaults to: [])

  Additional targets to traverse when building link groups, but which should not be direct dependencies of the main executable.

• link_group_public_deps_label: (defaults to: None)

  Surface nodes with this label as "public" nodes in the main executable when linking with with link groups.

• link_style: (defaults to: None)

  Determines whether to build and link this rule's dependencies statically or dynamically. Can be either static, static_pic or shared.

• main: (defaults to: None)

  The main module serving as the entry point into the binary. If not specified, the compiler default is used.

• platform_deps: (defaults to: [])

  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: (defaults to: [])

  A list of Haskell sources to be built by this rule. The dictionary option is deprecated.

Examples

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