Merge pull request #175 from cypress-io/10.0.0

Author: admah

.circleci/config.yml

@@ -1,6 +1,6 @@
 version: 2.1
 orbs:
-  cypress: cypress-io/cypress@1.29.0
+  cypress: cypress-io/cypress@2
 jobs:
   release:
     executor: cypress/browsers-chrome78-ff70

README.md

@@ -1,6 +1,6 @@
 # cypress-xpath
 
-[![CircleCI](https://circleci.com/gh/cypress-io/cypress-xpath.svg?style=svg&circle-token=c1c1eb7da56fcc8a49b96e7155161728987f9878)](https://circleci.com/gh/cypress-io/cypress-xpath) [![renovate-app badge][renovate-badge]][renovate-app] ![cypress version](https://img.shields.io/badge/cypress-6.8.0-brightgreen)
+[![CircleCI](https://circleci.com/gh/cypress-io/cypress-xpath.svg?style=svg&circle-token=c1c1eb7da56fcc8a49b96e7155161728987f9878)](https://circleci.com/gh/cypress-io/cypress-xpath) [![renovate-app badge][renovate-badge]][renovate-app] ![cypress version](https://img.shields.io/badge/cypress-10.2.0-brightgreen)
 
 > Adds XPath command to [Cypress.io](https://www.cypress.io) test runner
 
@@ -19,60 +19,60 @@ yarn add cypress-xpath --dev
 Then include in your project's [support file](https://on.cypress.io/support-file)
 
 ```js
-require("cypress-xpath");
+require('cypress-xpath');
 ```
 
 ## Use
 
 After installation your `cy` object will have `xpath` command.
 
 ```js
-it("finds list items", () => {
-  cy.xpath('//ul[@class="todo-list"]//li').should("have.length", 3);
+it('finds list items', () => {
+  cy.xpath('//ul[@class="todo-list"]//li').should('have.length', 3);
 });
 ```
 
 You can also chain `xpath` off of another command.
 
 ```js
-it("finds list items", () => {
-  cy.xpath('//ul[@class="todo-list"]').xpath("./li").should("have.length", 3);
+it('finds list items', () => {
+  cy.xpath('//ul[@class="todo-list"]').xpath('./li').should('have.length', 3);
 });
 ```
 
 As with other cy commands, it is scoped by `cy.within()`.
 
 ```js
-it("finds list items", () => {
+it('finds list items', () => {
   cy.xpath('//ul[@class="todo-list"]').within(() => {
-    cy.xpath("./li").should("have.length", 3);
+    cy.xpath('./li').should('have.length', 3);
   });
 });
 ```
 
 **note:** you can test XPath expressions from DevTools console using `$x(...)` function, for example `$x('//div')` to find all divs.
 
-See [cypress/integration/spec.js](cypress/integration/spec.js)
+See [cypress/e2e/spec.cy.js](cypress/e2e/spec.cy.js)
 
 ## Beware the XPath // trap
 
 In XPath the expression // means something very specific, and it might not be what you think. Contrary to common belief, // means "anywhere in the document" not "anywhere in the current context". As an example:
 
 ```js
-cy.xpath("//body").xpath("//script");
+cy.xpath('//body').xpath('//script');
 ```
 
 You might expect this to find all script tags in the body, but actually, it finds all script tags in the entire document, not only those in the body! What you're looking for is the .// expression which means "any descendant of the current node":
 
 ```js
-cy.xpath("//body").xpath(".//script");
+cy.xpath('//body').xpath('.//script');
 ```
 
 The same thing goes for within:
 
 ```js
-cy.xpath("//body").within(() => {
-  cy.xpath(".//script");
+cy.xpath('//body').within(() => {
+  cy.xpath('.//script');
 });
 ```
 

cypress.config.js

@@ -0,0 +1,12 @@
+const { defineConfig } = require('cypress');
+
+module.exports = defineConfig({
+  e2e: {
+    excludeSpecPattern: '*.html',
+    supportFile: 'cypress/support/index.js',
+  },
+  component: {
+    excludeSpecPattern: '*.html',
+    supportFile: 'cypress/support/index.js',
+  },
+});

cypress.json

@@ -3,173 +3,175 @@
 
 describe('cypress-xpath', () => {
   it('adds xpath command', () => {
-    expect(cy)
-      .property('xpath')
-      .to.be.a('function')
-  })
+    expect(cy).property('xpath').to.be.a('function');
+  });
 
   context('elements', () => {
     beforeEach(() => {
-      cy.visit('cypress/integration/index.html')
-    })
+      cy.visit('cypress/e2e/index.html');
+    });
 
     it('finds h1', () => {
-      cy.xpath('//h1').should('have.length', 1)
-    })
+      cy.xpath('//h1').should('have.length', 1);
+    });
 
     it('returns jQuery wrapped elements', () => {
-      cy.xpath('//h1').then(el$ => {
-        expect(el$).to.have.property('jquery')
-      })
-    })
+      cy.xpath('//h1').then((el$) => {
+        expect(el$).to.have.property('jquery');
+      });
+    });
 
     it('returns primitives as is', () => {
-      cy.xpath('string(//h1)').then(el$ => {
-        expect(el$).to.not.have.property('jquery')
-      })
-    })
+      cy.xpath('string(//h1)').then((el$) => {
+        expect(el$).to.not.have.property('jquery');
+      });
+    });
 
     it('provides jQuery wrapped elements to assertions', () => {
-      cy.xpath('//h1').should(el$ => {
-        expect(el$).to.have.property('jquery')
-      })
-    })
+      cy.xpath('//h1').should((el$) => {
+        expect(el$).to.have.property('jquery');
+      });
+    });
 
     it('gets h1 text', () => {
       cy.xpath('//h1/text()')
         .its('0.textContent')
-        .should('equal', 'cypress-xpath')
-    })
+        .should('equal', 'cypress-xpath');
+    });
 
     it('retries until element is inserted', () => {
       // the element will be inserted after 1 second
-      cy.xpath('string(//*[@id="inserted"])').should('equal', 'inserted text')
-    })
+      cy.xpath('string(//*[@id="inserted"])').should('equal', 'inserted text');
+    });
 
     describe('chaining', () => {
       it('finds h1 within main', () => {
         // first assert that h1 doesn't exist as a child of the implicit document subject
-        cy.xpath('./h1').should('not.exist')
+        cy.xpath('./h1').should('not.exist');
 
-        cy.xpath('//main').xpath('./h1').should('exist')
-      })
+        cy.xpath('//main').xpath('./h1').should('exist');
+      });
 
       it('finds body outside of main when succumbing to // trap', () => {
         // first assert that body doesn't actually exist within main
-        cy.xpath('//main').xpath('.//body').should('not.exist')
+        cy.xpath('//main').xpath('.//body').should('not.exist');
 
-        cy.xpath('//main').xpath('//body').should('exist')
-      })
+        cy.xpath('//main').xpath('//body').should('exist');
+      });
 
       it('finds h1 within document', () => {
-        cy.document().xpath('//h1').should('exist')
-      })
+        cy.document().xpath('//h1').should('exist');
+      });
 
       it('throws when subject is more than a single element', (done) => {
         cy.on('fail', (err) => {
-          expect(err.message).to.eq('xpath() can only be called on a single element. Your subject contained 2 elements.')
-          done()
-        })
+          expect(err.message).to.eq(
+            'xpath() can only be called on a single element. Your subject contained 2 elements.'
+          );
+          done();
+        });
 
-        cy.get('main, div').xpath('foo')
-      })
-    })
+        cy.get('main, div').xpath('foo');
+      });
+    });
 
     describe('within()', () => {
       it('finds h1 within within-subject', () => {
         // first assert that h1 doesn't exist as a child of the implicit document subject
-        cy.xpath('./h1').should('not.exist')
+        cy.xpath('./h1').should('not.exist');
 
         cy.xpath('//main').within(() => {
-          cy.xpath('./h1').should('exist')
-        })
-      })
+          cy.xpath('./h1').should('exist');
+        });
+      });
 
       it('finds body outside of within-subject when succumbing to // trap', () => {
         // first assert that body doesn't actually exist within main
         cy.xpath('//main').within(() => {
-          cy.xpath('.//body').should('not.exist')
+          cy.xpath('.//body').should('not.exist');
         });
 
         cy.xpath('//main').within(() => {
-          cy.xpath('//body').should('exist')
+          cy.xpath('//body').should('exist');
         });
-      })
-    })
+      });
+    });
 
     describe('primitives', () => {
       it('counts h1 elements', () => {
-        cy.xpath('count(//h1)').should('equal', 1)
-      })
+        cy.xpath('count(//h1)').should('equal', 1);
+      });
 
       it('returns h1 text content', () => {
-        cy.xpath('string(//h1)').should('equal', 'cypress-xpath')
-      })
+        cy.xpath('string(//h1)').should('equal', 'cypress-xpath');
+      });
 
       it('returns boolean', () => {
-        cy.xpath('boolean(//h1)').should('be.true')
-        cy.xpath('boolean(//h2)').should('be.false')
-      })
-    })
+        cy.xpath('boolean(//h1)').should('be.true');
+        cy.xpath('boolean(//h2)').should('be.false');
+      });
+    });
 
     describe('typing', () => {
       it('works on text input', () => {
-        cy.xpath('//*[@id="name"]').type('World')
-        cy.contains('span#greeting', 'Hello, World')
-      })
-    })
+        cy.xpath('//*[@id="name"]').type('World');
+        cy.contains('span#greeting', 'Hello, World');
+      });
+    });
 
     describe('clicking', () => {
       it('on button', () => {
         // this button invokes window.alert when clicked
-        const alert = cy.stub()
-        cy.on('window:alert', alert)
+        const alert = cy.stub();
+        cy.on('window:alert', alert);
         cy.xpath('//*[@id="first-button"]')
           .click()
           .then(() => {
-            expect(alert).to.have.been.calledOnce
-          })
-      })
-    })
-  })
+            expect(alert).to.have.been.calledOnce;
+          });
+      });
+    });
+  });
 
   context('logging', () => {
     beforeEach(() => {
-      cy.visit('cypress/integration/index.html')
-    })
+      cy.visit('cypress/e2e/index.html');
+    });
 
     it('should log by default', () => {
-      cy.spy(Cypress, 'log').log(false)
+      cy.spy(Cypress, 'log').log(false);
 
       cy.xpath('//h1').then(() => {
-        expect(Cypress.log).to.be.calledWithMatch({ name: 'xpath' })
-      })
-    })
+        expect(Cypress.log).to.be.calledWithMatch({ name: 'xpath' });
+      });
+    });
 
     it('logs the selector when not found', (done) => {
-      cy.xpath('//h1') // does exist
+      cy.xpath('//h1'); // does exist
       cy.on('fail', (e) => {
         const isExpectedErrorMessage = (message) =>
           message.includes('Timed out retrying') &&
-          message.includes('Expected to find element: `//h2`, but never found it.')
+          message.includes(
+            'Expected to find element: `//h2`, but never found it.'
+          );
 
         if (!isExpectedErrorMessage(e.message)) {
-          console.error('Cypress test failed with an unexpected error message')
-          console.error(e)
-          return done(e)
+          console.error('Cypress test failed with an unexpected error message');
+          console.error(e);
+          return done(e);
         }
         // no errors, the error message for not found selector is correct
-        done()
-      })
-      cy.xpath('//h2', { timeout: 100 }) // does not exist
-    })
+        done();
+      });
+      cy.xpath('//h2', { timeout: 100 }); // does not exist
+    });
 
     it('should not log when provided log: false', () => {
-      cy.spy(Cypress, 'log').log(false)
+      cy.spy(Cypress, 'log').log(false);
 
       cy.xpath('//h1', { log: false }).then(() => {
-        expect(Cypress.log).to.not.be.calledWithMatch({ name: 'xpath' })
-      })
-    })
-  })
-})
+        expect(Cypress.log).to.not.be.calledWithMatch({ name: 'xpath' });
+      });
+    });
+  });
+});