haskell_library

A haskell_library() rule is used to identity a group of Haskell sources.

Function Signature

def haskell_library(
    *,
    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",
    compiler_flags: list[str] = [],
    contacts: list[str] = [],
    default_host_platform: None | str = None,
    deps: list[str] = [],
    enable_profiling: bool = False,
    ghci_platform_preload_deps: list[(str, list[str])] = [],
    ghci_preload_deps: list[str] = [],
    haddock_flags: list[str] = [],
    labels: list[str] = [],
    licenses: list[str] = [],
    link_whole: bool = False,
    linker_flags: list[str] = [],
    platform: None | str = None,
    platform_deps: list[(str, list[str])] = [],
    platform_linker_flags: list[(str, list[str])] = [],
    preferred_linkage: str = "any",
    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.

• contacts: (defaults to: [])

  A list of organizational contacts for this rule. These could be individuals who you would contact in the event of a failure or other issue with the rule.

  contacts = [ 'Joe Sixpack', 'Erika Mustermann' ]

• 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.

• labels: (defaults to: [])

  Set of arbitrary strings which allow you to annotate a build rule with tags that can be searched for over an entire dependency tree using buck query().

• licenses: (defaults to: [])

  Set of license files for this library. To get the list of license files for a given build rule and all of its dependencies, you can use buck query

• 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_library(
  name = 'fileutil',
  srcs = [
    'FileUtil.hs',
  ],
)