cypress-io · brian-mann · May 29, 2018 · Mar 14, 2018 · Mar 14, 2018 · Mar 14, 2018
diff --git a/.gitignore b/.gitignore
@@ -2,6 +2,7 @@ node_modules/
 db.json
 public/
 *.log
+.history
 .DS_Store
 .history
 .deploy*/

diff --git a/circle.yml b/circle.yml
@@ -69,6 +69,8 @@ jobs:
           key: cypress-documentation-{{ .Branch }}-{{ .Revision }}
           paths:
             - /root/cypress-documentation
+      - store_artifacts:
+          path: ~/.npm/_logs
 
   "docs-tests":
     <<: *defaults
@@ -99,6 +101,8 @@ jobs:
           path: cypress/videos
       - store_artifacts:
           path: cypress/screenshots
+      - store_artifacts:
+          path: npm-debug.log
 
   "deploy-docs-staging":
     <<: *defaults
@@ -126,6 +130,8 @@ jobs:
           path: cypress/videos
       - store_artifacts:
           path: cypress/screenshots
+      - store_artifacts:
+          path: npm-debug.log
 
   "deploy-docs-production":
     <<: *defaults

diff --git a/cypress/integration/main_spec.coffee b/cypress/integration/main_spec.coffee
@@ -6,7 +6,7 @@ API_PATH = "/api/introduction/api"
 EXAMPLES_PATH = "/examples/examples/recipes"
 FAQ_PATH = "/faq/questions/using-cypress-faq"
 
-describe "Documentation", ->
+describe "Main", ->
   beforeEach ->
     cy.server()
 

diff --git a/lib/tags/requirements.js b/lib/tags/requirements.js
@@ -105,6 +105,12 @@ module.exports = function yields (hexo, args) {
     </ul>`
   }
 
+  const dualExistenceSingleDom = () => {
+    return `<ul>
+      <li><p>${cmd} can be chained off of <code>cy</code> or off a command that yields a single DOM element.</p></li>
+    </ul>`
+  }
+
   const spread = () => {
     return `<ul>
       <li><p>${childCmd}.</p></li>
@@ -120,6 +126,13 @@ module.exports = function yields (hexo, args) {
     </ul>`
   }
 
+  const task = () => {
+    return `<ul>
+      <li><p>${parentCmd}.</p></li>
+      <li><p>${cmd} requires the task to eventually end.</p></li>
+    </ul>`
+  }
+
   const writeFile = () => {
     return `<ul>
       <li><p>${parentCmd}.</p></li>
@@ -172,6 +185,8 @@ module.exports = function yields (hexo, args) {
       return dual()
     case 'dual_existence':
       return dualExistence()
+    case 'dual_existence_single_dom':
+      return dualExistenceSingleDom()
     case 'clearability':
       return clearability()
     case 'blurability':
@@ -190,6 +205,8 @@ module.exports = function yields (hexo, args) {
       return spread()
     case 'exec':
       return exec()
+    case 'task':
+      return task()
     case 'read_file':
       return readFile()
     case 'write_file':

diff --git a/lib/tags/timeouts.js b/lib/tags/timeouts.js
@@ -47,7 +47,7 @@ module.exports = function yields (hexo, args) {
       <li><p>${cmd} should never time out.</p></li>
       </ul>
       {% note warning %}
-      Because ${cmd} is asynchronous it is technically possible for there to be a time out while talking to the internal Cypress automation API's. But for practical purposes it should never happen.
+      Because ${cmd} is asynchronous it is technically possible for there to be a timeout while talking to the internal Cypress automation API's. But for practical purposes it should never happen.
       {% endnote %}`)
   }
 
@@ -64,6 +64,12 @@ module.exports = function yields (hexo, args) {
     </ul>`
   }
 
+  const task = () => {
+    return `<ul>
+      <li><p>${cmd} can time out waiting for the task to end.</p></li>
+    </ul>`
+  }
+
   const none = () => {
     return `<ul>
       <li><p>${cmd} can not time out.</p></li>
@@ -115,6 +121,8 @@ module.exports = function yields (hexo, args) {
       return its()
     case 'exec':
       return exec()
+    case 'task':
+      return task()
     case 'none':
       return none()
     case 'page':

diff --git a/package-lock.json b/package-lock.json
diff --git a/source/_data/sidebar.yml b/source/_data/sidebar.yml
@@ -123,6 +123,7 @@ api:
     spy: spy.html
     stub: stub.html
     submit: submit.html
+    task: task.html
     then: then.html
     tick: tick.html
     title: title.html
@@ -147,6 +148,7 @@ api:
   cypress-api:
     custom-commands: custom-commands.html
     cookies: cookies.html
+    screenshot-api: screenshot-api.html
     selector-playground-api: selector-playground-api.html
     cypress-server: cypress-server.html
     arch: arch.html

diff --git a/source/api/commands/_scrollintoview.md b/source/api/commands/_scrollintoview.md
@@ -1,6 +1,6 @@
 ---
 title: scrollIntoView
-comments: false
+
 ---
 
 Scroll an element into view.

diff --git a/source/api/commands/_scrollto.md b/source/api/commands/_scrollto.md
@@ -1,6 +1,6 @@
 ---
 title: scrollTo
-comments: false
+
 ---
 
 Scroll to a specific position.

diff --git a/source/api/commands/_trigger.md b/source/api/commands/_trigger.md
@@ -1,6 +1,6 @@
 ---
 title: trigger
-comments: false
+
 ---
 
 Trigger an event on a DOM element.  

diff --git a/source/api/commands/and.md b/source/api/commands/and.md
@@ -1,6 +1,6 @@
 ---
 title: and
-comments: false
+
 ---
 
 Create an assertion. Assertions are automatically retried until they pass or time out.

diff --git a/source/api/commands/as.md b/source/api/commands/as.md
@@ -1,6 +1,6 @@
 ---
 title: as
-comments: false
+
 ---
 
 Assign an alias for later use. Reference the alias later within a {% url `cy.get()` get %} or {% url `cy.wait()` wait %} command with a `@` prefix.

diff --git a/source/api/commands/blur.md b/source/api/commands/blur.md
@@ -1,6 +1,6 @@
 ---
 title: blur
-comments: false
+
 ---
 
 Blur a focused element.

diff --git a/source/api/commands/check.md b/source/api/commands/check.md
@@ -1,6 +1,6 @@
 ---
 title: check
-comments: false
+
 ---
 
 Check checkbox(es) or radio(s).

diff --git a/source/api/commands/children.md b/source/api/commands/children.md
@@ -1,6 +1,6 @@
 ---
 title: children
-comments: false
+
 ---
 
 Get the children of each DOM element within a set of DOM elements.

diff --git a/source/api/commands/clear.md b/source/api/commands/clear.md
@@ -1,6 +1,6 @@
 ---
 title: clear
-comments: false
+
 ---
 
 Clear the value of an `input` or `textarea`.

diff --git a/source/api/commands/clearcookie.md b/source/api/commands/clearcookie.md
@@ -1,6 +1,6 @@
 ---
 title: clearCookie
-comments: false
+
 ---
 
 Clear a specific browser cookie.

diff --git a/source/api/commands/clearcookies.md b/source/api/commands/clearcookies.md
@@ -1,6 +1,6 @@
 ---
 title: clearCookies
-comments: false
+
 ---
 
 Clear all browser cookies.

diff --git a/source/api/commands/clearlocalstorage.md b/source/api/commands/clearlocalstorage.md
@@ -1,6 +1,6 @@
 ---
 title: clearLocalStorage
-comments: false
+
 ---
 
 Clear data in local storage.

diff --git a/source/api/commands/click.md b/source/api/commands/click.md
@@ -1,6 +1,6 @@
 ---
 title: click
-comments: false
+
 ---
 
 Click a DOM element.

diff --git a/source/api/commands/clock.md b/source/api/commands/clock.md
@@ -1,6 +1,6 @@
 ---
 title: clock
-comments: false
+
 ---
 
 `cy.clock()` overrides native global functions related to time allowing them to be controlled synchronously via {% url `cy.tick()` tick %} or the yielded `clock` object. This includes controlling:

diff --git a/source/api/commands/closest.md b/source/api/commands/closest.md
@@ -1,6 +1,6 @@
 ---
 title: closest
-comments: false
+
 ---
 
 Get the first DOM element that matches the selector (whether it be itself or one of its ancestors).

diff --git a/source/api/commands/contains.md b/source/api/commands/contains.md
@@ -1,6 +1,6 @@
 ---
 title: contains
-comments: false
+
 ---
 
 Get the DOM element containing the text. DOM elements can contain *more* than the desired text and still match. Additionally, Cypress {% urlHash 'prefers some DOM elements' Notes %} over the deepest element found.

diff --git a/source/api/commands/dblclick.md b/source/api/commands/dblclick.md
@@ -1,6 +1,6 @@
 ---
 title: dblclick
-comments: false
+
 ---
 
 Double-click a DOM element.

diff --git a/source/api/commands/debug.md b/source/api/commands/debug.md
@@ -1,6 +1,6 @@
 ---
 title: debug
-comments: false
+
 ---
 
 Set a `debugger` and log what the previous command yields.
@@ -89,4 +89,4 @@ When clicking on the `debug` command within the command log, the console outputs
 - {% url 'Dashboard' https://on.cypress.io/dashboard %}
 - {% url `.pause()` pause %}
 - {% url `cy.log()` log %}
-- {% url `cy.screenshot()` screenshot %}
+- {% url `.screenshot()` screenshot %}
diff --git a/source/api/commands/document.md b/source/api/commands/document.md
@@ -1,6 +1,6 @@
 ---
 title: document
-comments: false
+
 ---
 
 Get the `window.document` of the page that is currently active.

diff --git a/source/api/commands/each.md b/source/api/commands/each.md
@@ -1,6 +1,6 @@
 ---
 title: each
-comments: false
+
 ---
 
 Iterate through an array like structure (arrays or objects with a `length` property).

diff --git a/source/api/commands/end.md b/source/api/commands/end.md
@@ -1,6 +1,6 @@
 ---
 title: end
-comments: false
+
 ---
 
 End a chain of commands.

diff --git a/source/api/commands/eq.md b/source/api/commands/eq.md
@@ -1,6 +1,6 @@
 ---
 title: eq
-comments: false
+
 ---
 
 Get A DOM element at a specific index in an array of elements.

diff --git a/source/api/commands/exec.md b/source/api/commands/exec.md
@@ -1,6 +1,6 @@
 ---
 title: exec
-comments: false
+
 ---
 
 Execute a system command.

diff --git a/source/api/commands/filter.md b/source/api/commands/filter.md
@@ -1,6 +1,6 @@
 ---
 title: filter
-comments: false
+
 ---
 
 Get the DOM elements that match a specific selector.