Collect Headings

Imagine we want to collect all sections, and for each section extract important information into a list. At the end we need to write the entire extracted object into a file.

<section>
  <h2>Install</h2>
  <ol>
    <li>Step 1</li>
    <li>Step 2</li>
    <li>Step 3</li>
  </ol>
</section>
<section>
  <h2>Use</h2>
  <h3>Case 1</h3>
  <p>...</p>
  <h3>Case 2</h3>
  <p>...</p>
</section>

const sections = {}
cy.get('section')
  .should('have.length.gt', 0)
  .each(($section) => {
    cy.wrap($section)
      .find('h2')
      .invoke('text')
      .then((heading) => {
        sections[heading] = []
        cy.wrap($section)
          .find('li,h3')
          .each(($item) => {
            sections[heading].push($item.text())
          })
      })
  })
  .then(() => {
    // confirm the collected data
    expect(sections).to.deep.equal({
      Install: ['Step 1', 'Step 2', 'Step 3'],
      Use: ['Case 1', 'Case 2'],
    })
    // save into a file
    cy.writeFile('out.json', sections)
  })

Tip: check out cy-spok that lets you write complex object assertions with ease.

See also cy.each recipe.