Documentation for attachments

[simondean]

Hi @jbpros, here's the documentation for #189

[simondean]

I've realized that I didn't document how to create attachments from a step definition (by adding the scenario object to the world from a before or around hook). I should add that to the README.md

[samccone]

hey @simondean I think it will be best to create a docs folder in the repo and add a new file for attachments.

That way we are not cramming everything into a single readme

[aslakhellesoy]

Good stuff!

How about an alternate way to attach JSON attachments:

scenario.attach({name: "some JSON"});

The attach function could assume the attachment is JSON with the following test:

if(typeof attachment === 'object' && !Buffer.isBuffer(attachment) && !isReadableStream(attachment)) {
  // it's JSON
  json = JSON.stringify(attachment);
}

With:

function isReadableStream(o) {
  return typeof(o.read) === 'function';
}

WDYT?

[simondean]

@samccone any suggestions for the approach for splitting out the documentation? Ruby Cucumber uses GitHub wiki pages. The "documentation" link on https://github.com/cucumber/cucumber/blob/master/README.md points to https://github.com/cucumber/cucumber/wiki

[jbpros]

Merged in as b2d904d and 1350632

[lock]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.