Docs: cy script conventions

[jennifer-shehane]

@brian-mann commented on Mon Jun 12 2017

WIP

side + below

cy.visit('/')

cy
.contains('Guides')
.click()
.contains('h1', 'Why Cypress')
.find('.bar')
.should('have.class', 'baz')

cy
.url()
.should('eq', 'foo')
.then(() => {
  cy
  .get('form')
  .submit()
})

always below

cy
.visit('/')

cy
.contains('Guides')
.click()
.contains('h1', 'Why Cypress')
.find('.bar')
.should('have.class', 'baz')

cy
.url()
.should('eq', 'foo')
.then(() => {
  cy
  .get('form')
  .submit()
})

multi line indented

cy.visit('/')

cy
  .contains('Guides')
  .click()
  .contains('h1', 'Why Cypress')
  .find('.bar')
  .should('have.class', 'baz')

cy
  .url()
  .should('eq', 'foo')
  .then(() => {
    cy
      .get('form')
      .submit()
  })

always indented

cy
  .visit('/')

cy
  .contains('Guides')
  .click()
  .contains('h1', 'Why Cypress')
  .find('.bar')
  .should('have.class', 'baz')

cy
  .url()
  .should('eq', 'foo')
  .then(() => {
    cy
      .get('form')
      .submit()
  })

multi line - to the side

cy.visit('/')

cy.contains('Guides')
  .click()
  .contains('h1', 'Why Cypress')
  .find('.bar')
  .should('have.class', 'baz')

cy.url()
  .should('eq', 'foo')
  .then(() => {
    cy.get('form')
      .submit()
  })

---

@jennifer-shehane commented on Wed Jun 14 2017

There are actually other cases where some code examples are chained on one line. This is how I would write this example:

cy.visit('/')
cy.contains('Guides').click()
  .contains('h1', 'Why Cypress').find('.bar').should('have.class', 'baz')
cy.url().should('eq', 'foo').then(() => {
  cy.get('form').submit()
})