Add docs on testing with HTML fixtures #74
Conversation
|
|
||
| For each example, pass `options` into your own macro and check the generated HTML matches `html`. | ||
|
|
||
| Your HTML may not match exactly. For example, your framework may add extra whitespace or attributes to your HTML. |
There was a problem hiding this comment.
@36degrees @vanitabarrett I had a long look at the final paragraph and realised I might be trying to over-explain things. In retrospect, it feels like enough to warn users that the HTML may not match, without going into what to do about it - as this would be fairly self-explanatory? Let me know what you think!
There was a problem hiding this comment.
Hm, to me this implies that we might be doing something our end so that if their HTML doesn't match correctly it's ok and their tests will somehow still pass - but that might just be me! 🤷
There was a problem hiding this comment.
I think the word 'may' makes it sound permissive? ('It's OK if the HTML doesn't match exactly')
Do we just need to be clear that they will have to do something…? What about something like…
If your HTML does not match exactly – for example if your framework adds extra whitespace or attributes to your HTML – you'll need to write your tests to allow for known differences.
There was a problem hiding this comment.
I've had another go in ee2717b - I've mainly used Ollie's suggestion but with slight style tweak. Let me know what you think!
|
Deploy preview for govuk-frontend-docs-preview ready! Built with commit eedad4e https://deploy-preview-74--govuk-frontend-docs-preview.netlify.app |
There was a problem hiding this comment.
Looks good 👍 Just left one comment.
We could also consider adding something the package README to document the HTML fixtures since it already explains what the macro options file is for. I can create another issue for that if it's something we want to do?
|
|
||
| If you [installed GOV.UK Frontend with Node.js package manager (npm)](/installing-with-npm), you can find the `fixtures.json` file for each component in the `node_modules/govuk-frontend/govuk/components/COMPONENT-NAME/` folder, where `COMPONENT-NAME` is the name of the component. | ||
|
|
||
| <%= warning_text('You should not test your HTML using the YAML files in the <code>src/</code> folder.') %> |
There was a problem hiding this comment.
Still not 100% sure that this is terribly important to mention – or at least that it's important enough to warrant being in a callout. If people do it nothing bad's going to happen, it's just that we might change those files without giving them any warning.
There was a problem hiding this comment.
No probs - happy to remove this.
m-green
force-pushed
the
add-html-test-fixtures
branch
from
eaeabe9
to
bb5d375
Compare
Part of alphagov/govuk-frontend#1830
This adds a new docs page about testing your HTML matches GOV.UK Frontend.
Before merging we need to: