feat: export functions, close #5

Author: bahmutov

README.md

@@ -17,14 +17,14 @@ it('skips this test when running on Mac', () => {
 npm install -D @cypress/skip-test
 ```
 
-Then add this module to your support file `cypress/support/index.js`
+## Example
+
+You can use this module as custom Cypress commands `cy.skipOn` and `cy.onlyOn` or by importing its functions. To use custom commands, add this module to your support file `cypress/support/index.js`
 
 ```js
 require('@cypress/skip-test')
 ```
 
-## Example
-
 ### `cy.skipOn`
 
 Skip this test if running in Electron browser
@@ -65,6 +65,22 @@ it('only tests localhost', () => {
 })
 ```
 
+### imports
+
+```js
+import { onlyOn, skipOn } from '../..'
+
+it('runs only on Mac', () => {
+  // using the exported function instead of
+  // the custom command cy.onlyOn(...)
+  onlyOn('mac')
+})
+
+it('skips on Mac', () => {
+  skipOn('darwin')
+})
+```
+
 ### Notes
 
 You can chain conditions together

cypress/integration/import-spec.js

@@ -0,0 +1,12 @@
+/// <reference types="cypress" />
+import { onlyOn, skipOn } from '../..'
+
+it('runs only on Mac', () => {
+  // using the exported function instead of
+  // the custom command cy.onlyOn(...)
+  onlyOn('mac')
+})
+
+it('skips on Mac', () => {
+  skipOn('darwin')
+})

index.js

@@ -30,7 +30,10 @@ const matchesUrlPart = normalizedName => {
   return url && url.includes(normalizedName)
 }
 
-Cypress.Commands.add('skipOn', name => {
+/**
+ * Skips the current test based on the browser, platform or url.
+ */
+export const skipOn = name => {
   if (!_.isString(name) || '') {
     throw new Error(
       'Invalid syntax: cy.skipOn(<name>), for example cy.skipOn("linux")'
@@ -62,9 +65,12 @@ Cypress.Commands.add('skipOn', name => {
   if (matchesUrlPart(normalizedName)) {
     return skip()
   }
-})
+}
 
-Cypress.Commands.add('onlyOn', name => {
+/**
+ * Runs the current test only in the specified browser, platform or against url.
+ */
+export const onlyOn = name => {
   if (!_.isString(name) || '') {
     throw new Error(
       'Invalid syntax: cy.onlyOn(<name>), for example cy.onlyOn("linux")'
@@ -92,4 +98,8 @@ Cypress.Commands.add('onlyOn', name => {
   if (!matchesUrlPart(normalizedName)) {
     return skip()
   }
-})
+}
+
+Cypress.Commands.add('skipOn', skipOn)
+
+Cypress.Commands.add('onlyOn', onlyOn)