docs: rename 'defaults' to 'requirements'

‘

docs/lib/tags/requirements.js

@@ -1,12 +1,12 @@
 const rawRender = require('../raw_render')
 
 module.exports = function yields (hexo, args) {
-  // {% defaults none cy.clearCookies %}
-  // {% defaults blurability .blur %}
-  // {% defaults focusability .blur %}
-  // {% defaults checkability .click %}
-  // {% defaults actionability .click %}
-  // {% defaults existence .children %}
+  // {% requirements none cy.clearCookies %}
+  // {% requirements blurability .blur %}
+  // {% requirements focusability .blur %}
+  // {% requirements checkability .click %}
+  // {% requirements actionability .click %}
+  // {% requirements existence .children %}
 
   const type = args[0]
   const cmd = `<code>${args[1]}()</code>`
@@ -92,6 +92,6 @@ module.exports = function yields (hexo, args) {
       return execCode()
     default:
       // error when an invalid usage option was provided
-      throw new Error(`{% defaults %} tag helper was provided an invalid option: ${type}`)
+      throw new Error(`{% requirements %} tag helper was provided an invalid option: ${type}`)
   }
 }

docs/lib/tags/usage.js

@@ -17,7 +17,7 @@ module.exports = function usageOptions (hexo, args) {
 
   const force = () => {
     /* eslint-disable quotes */
-    const url = `{% urlHash 'waiting for actionability' Defaults %}`
+    const url = `{% urlHash 'waiting for actionability' Requirements %}`
 
     return render(`Forces the action, disables ${url}`)
   }

docs/scripts/tags.js

@@ -7,7 +7,7 @@ const beepAndLog = require('../lib/beep')
 const partial = require('../lib/tags/partial')
 const note = require('../lib/tags/note')
 const yields = require('../lib/tags/yields')
-const defaults = require('../lib/tags/defaults')
+const requirements = require('../lib/tags/requirements')
 const timeouts = require('../lib/tags/timeouts')
 const usageOptions = require('../lib/tags/usage')
 const { issue, openAnIssue } = require('../lib/tags/issues')
@@ -37,7 +37,7 @@ const tags = {
   yields: yields,
 
   // default assertions
-  defaults: defaults,
+  requirements: requirements,
 
   // timeouts
   timeouts: timeouts,

docs/source/api/commands/and.md

@@ -80,7 +80,7 @@ cy
   .and('match', /serif/)            // yields 'sans-serif'
 ```
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
 `.and()` has no default assertions other than what you specify.
 

docs/source/api/commands/as.md

@@ -44,7 +44,7 @@ The name of the alias to be referenced later within a {% url `cy.get()` get %} o
 
 {% yields same_subject .as %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
 `.as()` has no default assertions.
 

docs/source/api/commands/blur.md

@@ -48,9 +48,9 @@ Option | Default | Description
 
 {% yields same_subject .blur %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults blurability .blur %}
+{% requirements blurability .blur %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/check.md

@@ -60,9 +60,9 @@ Option | Default | Description
 
 {% yields same_subject .check %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults checkability .check %}
+{% requirements checkability .check %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/children.md

@@ -50,9 +50,9 @@ Option | Default | Description
 
 {% yields changes_dom_subject .children %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults existence .children %}
+{% requirements existence .children %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/clear.md

@@ -52,9 +52,9 @@ Option | Default | Description
 
 {% yields same_subject .clear %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults actionability .clear %}
+{% requirements actionability .clear %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/clearcookie.md

@@ -46,9 +46,9 @@ Option | Default | Description
 
 {% yields null cy.clearCookie %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults none cy.clearCookie %}
+{% requirements none cy.clearCookie %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/clearcookies.md

@@ -41,9 +41,9 @@ Option | Default | Description
 
 {% yields null cy.clearCookies %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults none cy.clearCookies %}
+{% requirements none cy.clearCookies %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/clearlocalstorage.md

@@ -46,9 +46,9 @@ Option | Default | Description
 
 {% yields null cy.clearLocalStorage %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults none cy.clearLocalStorage %}
+{% requirements none cy.clearLocalStorage %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/click.md

@@ -66,9 +66,9 @@ Option | Default | Description
 
 {% yields same_subject .click %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults actionability .click %}
+{% requirements actionability .click %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/clock.md

@@ -66,9 +66,9 @@ Option | Default | Description
 
 You can also access the `clock` object via `this.clock` in a {% url `.then()` then %} callback.
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults none cy.clock %}
+{% requirements none cy.clock %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/closest.md

@@ -48,9 +48,9 @@ Option | Default | Description
 
 {% yields changes_dom_subject .closest %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults existence .closest %}
+{% requirements existence .closest %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/contains.md

@@ -54,9 +54,9 @@ Option | Default | Description
 
 {% yields changes_dom_subject .contains %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults existence .contains %}
+{% requirements existence .contains %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/dblclick.md

@@ -46,9 +46,9 @@ Option | Default | Description
 
 {% yields same_subject .dblclick %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults actionability .dblclick %}
+{% requirements actionability .dblclick %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/debug.md

@@ -41,9 +41,9 @@ Option | Default | Description
 
 {% yields same_subject .debug %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults none .debug %}
+{% requirements none .debug %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/document.md

@@ -37,9 +37,9 @@ Option | Default | Description
 
 {% yields new_subject cy.document 'yields the `window.document` object' %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults none cy.document %}
+{% requirements none cy.document %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/each.md

@@ -44,9 +44,9 @@ Pass a function that is invoked with the following arguments:
 
 {% yields same_subject .each %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults none .each %}
+{% requirements none .each %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/end.md

@@ -32,9 +32,9 @@ cy.end()                  // Does not make sense to chain off 'cy'
 
 {% yields null .end %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults none .end %}
+{% requirements none .end %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/eq.md

@@ -55,9 +55,9 @@ Option | Default | Description
 
 {% yields changes_dom_subject .eq %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults existence .eq %}
+{% requirements existence .eq %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/exec.md

@@ -71,13 +71,13 @@ Option | Default | Description
 - `stdout`
 - `stderr`
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults exec cy.exec %}
+{% requirements exec cy.exec %}
 
 **When `failOnNonZeroExit` is `true`**
 
-{% defaults exec_code cy.exec %}
+{% requirements exec_code cy.exec %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/filter.md

@@ -52,9 +52,9 @@ Option | Default | Description
 
 {% yields changes_dom_subject .filter %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults existence .filter %}
+{% requirements existence .filter %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/find.md

@@ -48,9 +48,9 @@ Option | Default | Description
 
 {% yields changes_dom_subject .find %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults existence .find %}
+{% requirements existence .find %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/first.md

@@ -44,9 +44,9 @@ Option | Default | Description
 
 {% yields changes_dom_subject .first %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults existence .first %}
+{% requirements existence .first %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/fixture.md

@@ -67,9 +67,9 @@ Option | Default | Description
 
 `cy.fixture()` yields the contents of the file. Formatting is determined by it's file extension.
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults none cy.fixture %}
+{% requirements none cy.fixture %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/focus.md

@@ -44,9 +44,9 @@ Option | Default | Description
 
 {% yields same_subject .focus %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults focusability .focus %}
+{% requirements focusability .focus %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/focused.md

@@ -37,9 +37,9 @@ Option | Default | Description
 
 {% yields new_dom_subject cy.focused %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults existence cy.focused %}
+{% requirements existence cy.focused %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/get.md

@@ -53,9 +53,9 @@ Option | Default | Description
 
 {% yields new_dom_subject cy.get %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults existence cy.get %}
+{% requirements existence cy.get %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/getcookie.md

@@ -53,9 +53,9 @@ Option | Default | Description
 
 `cy.getCookie()` yields `null`.
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults none cy.getCookie %}
+{% requirements none cy.getCookie %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/getcookies.md

@@ -45,9 +45,9 @@ Option | Default | Description
 - `secure`
 - `expiry`
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults none cy.getCookies %}
+{% requirements none cy.getCookies %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/last.md

@@ -44,9 +44,9 @@ Option | Default | Description
 
 {% yields changes_dom_subject .last %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults existence .last %}
+{% requirements existence .last %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/next.md

@@ -50,9 +50,9 @@ Option | Default | Description
 
 {% yields changes_dom_subject .next %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults existence .next %}
+{% requirements existence .next %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/nextall.md

@@ -50,9 +50,9 @@ Option | Default | Description
 
 {% yields changes_dom_subject .nextAll %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults existence .nextAll %}
+{% requirements existence .nextAll %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/nextuntil.md

@@ -61,9 +61,9 @@ Option | Default | Description
 
 {% yields changes_dom_subject .nextUntil %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults existence .nextUntil %}
+{% requirements existence .nextUntil %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/not.md

@@ -52,9 +52,9 @@ Option | Default | Description
 
 {% yields changes_dom_subject .not %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults existence .not %}
+{% requirements existence .not %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/parent.md

@@ -50,9 +50,9 @@ Option | Default | Description
 
 {% yields changes_dom_subject .parent %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults existence .parent %}
+{% requirements existence .parent %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/parents.md

@@ -50,9 +50,9 @@ Option | Default | Description
 
 {% yields changes_dom_subject .parents %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults existence .parents %}
+{% requirements existence .parents %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/parentsuntil.md

@@ -60,9 +60,9 @@ Option | Default | Description
 
 {% yields changes_dom_subject .parentsUntil %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults existence .parentsUntil %}
+{% requirements existence .parentsUntil %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/prev.md

@@ -50,9 +50,9 @@ Option | Default | Description
 
 {% yields changes_dom_subject .prev %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults existence .prev %}
+{% requirements existence .prev %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/prevall.md

@@ -50,9 +50,9 @@ Option | Default | Description
 
 {% yields changes_dom_subject .prevAll %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults existence .prevAll %}
+{% requirements existence .prevAll %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/prevuntil.md

@@ -60,9 +60,9 @@ Option | Default | Description
 
 {% yields changes_dom_subject .prevUntil %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults existence .prevUntil %}
+{% requirements existence .prevUntil %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/select.md

@@ -55,9 +55,9 @@ Option | Default | Description
 
 {% yields same_subject .select %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults actionability .select %}
+{% requirements actionability .select %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/siblings.md

@@ -51,9 +51,9 @@ Option | Default | Description
 
 {% yields changes_dom_subject .siblings %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults existence .siblings %}
+{% requirements existence .siblings %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/type.md

@@ -75,9 +75,9 @@ Option | Default | Description
 
 {% yields same_subject .type %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults actionability .type %}
+{% requirements actionability .type %}
 
 ## Timeouts {% helper_icon timeout %}
 

docs/source/api/commands/uncheck.md

@@ -57,9 +57,9 @@ Option | Default | Description
 
 {% yields same_subject .uncheck %}
 
-## Defaults {% helper_icon defaultAssertion %}
+## Requirements {% helper_icon defaultAssertion %}
 
-{% defaults checkability .uncheck %}
+{% requirements checkability .uncheck %}
 
 ## Timeouts {% helper_icon timeout %}