feat: callback form, close #6

Author: bahmutov

.gitignore

@@ -1 +1,3 @@
 node_modules/
+cypress/videos
+cypress/screenshots

README.md

@@ -81,6 +81,24 @@ it('skips on Mac', () => {
 })
 ```
 
+### imports with callback
+
+Instead of dynamically skipping a test at run-time, you can hide entire blocks of tests using the callback format.
+
+```js
+onlyOn('mac', () => {
+  // this callback will only evaluate on Mac
+  // thus the tests will be completely hidden from other platforms
+  describe('Mac tests', () => {
+    it('works', () => {})
+  })
+})
+skipOn('mac', () => {
+  // this test will run on every platform but Mac
+  it('hides this test on Mac', () => {})
+})
+```
+
 ### Notes
 
 You can chain conditions together

cypress/integration/callback-spec.js

@@ -0,0 +1,14 @@
+/// <reference types="cypress" />
+import { onlyOn, skipOn } from '../..'
+
+onlyOn('mac', () => {
+  // this callback will only evaluate on Mac
+  // thus the tests will be completely hidden from other platforms
+  describe('Mac tests', () => {
+    it('works', () => {})
+  })
+})
+
+skipOn('mac', () => {
+  it('hides this test on Mac', () => {})
+})

index.js

@@ -33,7 +33,7 @@ const matchesUrlPart = normalizedName => {
 /**
  * Skips the current test based on the browser, platform or url.
  */
-export const skipOn = name => {
+export const skipOn = (name, cb) => {
   if (!_.isString(name) || '') {
     throw new Error(
       'Invalid syntax: cy.skipOn(<name>), for example cy.skipOn("linux")'
@@ -46,31 +46,52 @@ export const skipOn = name => {
   }
 
   const normalizedName = normalizeName(name)
-  cy.log(`skipOn **${normalizedName}**`)
 
-  if (isPlatform(normalizedName)) {
-    if (Cypress.platform === normalizedName) {
-      skip()
+  if (cb) {
+    if (isPlatform(normalizedName)) {
+      if (Cypress.platform !== normalizedName) {
+        return cb()
+      }
+      return
     }
-    return
-  }
 
-  if (isBrowser(normalizedName)) {
-    if (Cypress.browser.name === normalizedName) {
-      skip()
+    if (isBrowser(normalizedName)) {
+      if (Cypress.browser.name !== normalizedName) {
+        return cb()
+      }
+      return
+    }
+
+    if (!matchesUrlPart(normalizedName)) {
+      return cb()
+    }
+  } else {
+    cy.log(`skipOn **${normalizedName}**`)
+
+    if (isPlatform(normalizedName)) {
+      if (Cypress.platform === normalizedName) {
+        skip()
+      }
+      return
+    }
+
+    if (isBrowser(normalizedName)) {
+      if (Cypress.browser.name === normalizedName) {
+        skip()
+      }
+      return
     }
-    return
-  }
 
-  if (matchesUrlPart(normalizedName)) {
-    return skip()
+    if (matchesUrlPart(normalizedName)) {
+      return skip()
+    }
   }
 }
 
 /**
  * Runs the current test only in the specified browser, platform or against url.
  */
-export const onlyOn = name => {
+export const onlyOn = (name, cb) => {
   if (!_.isString(name) || '') {
     throw new Error(
       'Invalid syntax: cy.onlyOn(<name>), for example cy.onlyOn("linux")'
@@ -79,24 +100,38 @@ export const onlyOn = name => {
 
   const normalizedName = normalizeName(name)
 
-  cy.log(`onlyOn **${normalizedName}**`)
+  if (cb) {
+    if (isPlatform(normalizedName) && Cypress.platform === normalizedName) {
+      return cb()
+    }
 
-  if (isPlatform(normalizedName)) {
-    if (Cypress.platform !== normalizedName) {
-      skip()
+    if (isBrowser(normalizedName) && Cypress.browser.name === normalizedName) {
+      return cb()
     }
-    return
-  }
 
-  if (isBrowser(normalizedName)) {
-    if (Cypress.browser.name !== normalizedName) {
-      skip()
+    if (matchesUrlPart(normalizedName)) {
+      return cb()
+    }
+  } else {
+    cy.log(`onlyOn **${normalizedName}**`)
+
+    if (isPlatform(normalizedName)) {
+      if (Cypress.platform !== normalizedName) {
+        skip()
+      }
+      return
     }
-    return
-  }
 
-  if (!matchesUrlPart(normalizedName)) {
-    return skip()
+    if (isBrowser(normalizedName)) {
+      if (Cypress.browser.name !== normalizedName) {
+        skip()
+      }
+      return
+    }
+
+    if (!matchesUrlPart(normalizedName)) {
+      return skip()
+    }
   }
 }