Allow cropping or suppressing printed docstrings on steps

[JakeDawkins]

I have a .feature file which uses docstrings in steps pretty extensively. When tests run, the entire docstring is printed out alongside the step names. I'd rather not see that, since that immediately adds ~1600 lies to my test output, making it quite noisy. Is there any way to silence that?

For example:

Scenario: should not confuse union types with overlapping field names
  Given query
    """
    query {
      body {
        ...on Image {
          attributes {
            url
          }
        }
        ...on Text {
          attributes {
            bold
            text
          }
        }
      }
    }
    """
  Then query plan
    """
    {
      "kind": "QueryPlan",
      "node": {
        "kind": "Fetch",
        "serviceName": "documents",
        "variableUsages": [],
        "operation": "{body{__typename ...on Image{attributes{url}}...on Text{attributes{bold text}}}}"
      }
    }
    """

prints this when the test is run:

 Scenario: should not confuse union types with overlapping field names                                                                                tests/build-query-plan.feature:3:11
  ✔ Given query                                                                                                                                        tests/build-query-plan.feature:4:3
      """
      query {
        body {
          ...on Image {
            attributes {
              url
            }
          }
          ...on Text {
            attributes {
              bold
              text
            }
          }
        }
      }
      """
  ✘ Then query plan                                                                                                                                   tests/build-query-plan.feature:22:3
      """
      {
        "kind": "QueryPlan",
        "node": {
          "kind": "Fetch",
          "serviceName": "documents",
          "variableUsages": [],
          "operation": "{body{__typename ...on Image{attributes{url}}...on Text{attributes{bold text}}}}"
        }
      }
      """
———— ! Step failed: ——————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————— query-planner/tests/cucumber.rs:69:29
  assertion failed: `(left == right)`
    left: `QueryPlan { node: None }`,
   right: `QueryPlan { node: Some(Fetch(FetchNode { service_name: "documents", variable_usages: [], requires: None, operation: "{body{__typename ...on Image{attributes{url}}...on
  Text{attributes{bold text}}}}" })) }`
——————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————

[bbqsrc]

Right now, no. I'll keep this open as a reminder to implement the ability to withhold printing docstrings or limit their length. 😄

[JakeDawkins]

Thanks for the quick response @bbqsrc :)

[bbqsrc]

If anybody wants to take on this issue, I'd be happy to mentor!

[tyranron]

@ilslv could you clarify here how this works now?

[ilslv]

@tyranron writer::Basic now outputs only step name itself and table, if present. No docstrings.

[tyranron]

@ilslv should we support docstrings outputting as opt-in? Maybe some kind of --verbose CLI opt?

[ilslv]

@tyranron I would argue that docstrings are useful as diagnostics (as shown in this issue) or for more verbose explanation, which I'm not sure is useful as part of output. And most importantly, we'll need a way to show 1 set of cli options, if writer::Basic is present and the other one if some other OutputWriter used.

[tyranron]

@ilslv let's move this question to a separate dedicated issue then.