Function label

  • label(
        testname: string,
        ids: readonly SupportedFlowrCapabilityId[],
        context: readonly (
            | "slice"
            | "other"
            | "parse"
            | "dataflow"
            | "search"
            | "lineage"
            | "query"
            | "output"
            | "desugar-shell"
            | "desugar-tree-sitter"
        )[],
    ): string

    Wraps a test name with a unique identifier and label it with the given ids. Test labels are used for identifying which of flowR's capabilities are being tested for. For more information about test labels and capabilities, see the wiki page: https://github.com/flowr-analysis/flowr/wiki/Linting-and-Testing#test-labels

    Parameters

    • testname: string

      the name of the test (it) to be labeled

    • ids: readonly SupportedFlowrCapabilityId[]

      the capability ids to attach to the test

    • context: readonly (
          | "slice"
          | "other"
          | "parse"
          | "dataflow"
          | "search"
          | "lineage"
          | "query"
          | "output"
          | "desugar-shell"
          | "desugar-tree-sitter"
      )[]

      the context in which the test is run, if not given this returns the label information for a test-helper to attach it

    Returns string

  • label(
        testname: string,
        ids?: readonly SupportedFlowrCapabilityId[],
        context?: readonly (
            | "slice"
            | "other"
            | "parse"
            | "dataflow"
            | "search"
            | "lineage"
            | "query"
            | "output"
            | "desugar-shell"
            | "desugar-tree-sitter"
        )[],
    ): TestLabel

    Wraps a test name with a unique identifier and label it with the given ids. Test labels are used for identifying which of flowR's capabilities are being tested for. For more information about test labels and capabilities, see the wiki page: https://github.com/flowr-analysis/flowr/wiki/Linting-and-Testing#test-labels

    Parameters

    • testname: string

      the name of the test (it) to be labeled

    • Optionalids: readonly SupportedFlowrCapabilityId[]

      the capability ids to attach to the test

    • Optionalcontext: readonly (
          | "slice"
          | "other"
          | "parse"
          | "dataflow"
          | "search"
          | "lineage"
          | "query"
          | "output"
          | "desugar-shell"
          | "desugar-tree-sitter"
      )[]

      the context in which the test is run, if not given this returns the label information for a test-helper to attach it

    Returns TestLabel

Settings

Member Visibility