Recipe: Flow with Browserify (#355)

* Recipe: Flow with Browserify

* Update examples/preprocessors__flow-browserify/README.md

Co-Authored-By: Jennifer Shehane <[email protected]>

* Update examples/preprocessors__flow-browserify/cypress.json

Co-Authored-By: Jennifer Shehane <[email protected]>

* Move devDependencies to root package.json

* Add new recipe to circle.yml to run tests in CI


Co-authored-by: Jennifer Shehane <[email protected]>

Author: petrkrejcik

README.md

@@ -47,6 +47,7 @@ Recipe | Description
 [grep](./examples/preprocessors__grep) | Filter tests by name using Mocha-like `grep` syntax
 [Typescript with Browserify](./examples/preprocessors__typescript-browserify) | Add typescript support with browserify
 [Typescript with Webpack](./examples/preprocessors__typescript-webpack) | Add typescript support with webpack
+[Flow with Browserify](./examples/preprocessors__flow-browserify) | Add flow support with browserify
 
 ## Blogs
 

circle.yml

@@ -147,6 +147,8 @@ jobs:
     # and run only tests with name having "@admin"
     environment:
       CYPRESS_grep: '@admin'
+  preprocessors__flow-browserify:
+    <<: *defaults
   preprocessors__typescript-browserify:
     <<: *defaults
   preprocessors__typescript-webpack:
@@ -275,6 +277,9 @@ all_jobs: &all_jobs
   - preprocessors__grep:
       requires:
         - build
+  - preprocessors__flow-browserify:
+      requires:
+        - build
   - preprocessors__typescript-browserify:
       requires:
         - build
@@ -368,6 +373,7 @@ all_jobs: &all_jobs
         - logging-in__jwt
         - logging-in__using-app-code
         - preprocessors__grep
+        - preprocessors__flow-browserify
         - preprocessors__typescript-browserify
         - preprocessors__typescript-webpack
         - server-communication__bootstrapping-your-app

examples/preprocessors__flow-browserify/.flowconfig

@@ -0,0 +1,13 @@
+[ignore]
+.*/node_modules
+
+[include]
+
+[libs]
+src/flow-types.js
+
+[lints]
+
+[options]
+
+[strict]

examples/preprocessors__flow-browserify/README.md

@@ -0,0 +1,17 @@
+# Flow with Browserify
+
+This is an example showing how to add Flow support for Cypress using Browserify.
+
+Whether you use Flow in your test files or just in the source files you need to preprocess them before running the tests so Cypress runs plain JavaScript.
+
+It uses [browserify](http://browserify.org/) to preprocess Flow files
+via [@cypress/browserify-preprocessor](https://github.com/cypress-io/cypress-browserify-preprocessor)
+and [@babel/preset-flow](https://github.com/babel/babel/tree/master/packages/babel-preset-flow) to transpile those files.
+
+## Install
+`npm install --save-dev @cypress/browserify-preprocessor @babel/preset-flow`
+
+See:
+- [cypress/plugins/index.js](cypress/plugins/index.js)
+- [example test](cypress/integration/spec.js)
+- [support/add.js](cypress/support/add.js)

examples/preprocessors__flow-browserify/cypress.json

@@ -0,0 +1,3 @@
+{
+  "fixturesFolder": false
+}

examples/preprocessors__flow-browserify/cypress/fixtures/example.json

@@ -0,0 +1,5 @@
+{
+  "name": "Using fixtures to represent data",
+  "email": "[email protected]",
+  "body": "Fixtures are a great way to mock data for responses to routes"
+}

examples/preprocessors__flow-browserify/cypress/integration/spec.js

@@ -0,0 +1,15 @@
+// @flow
+import { add } from '../support/add' // Flow typed file
+
+declare function describe(any, Function): any
+declare function it(any, Function): any
+declare function expect(any): any
+
+describe('Flow', () => {
+  it('works', () => {
+    // note: Flow definition
+    const x: number = 42
+
+    add(1, 'a') // Flow error
+  })
+})

examples/preprocessors__flow-browserify/cypress/plugins/index.js

@@ -0,0 +1,7 @@
+const browserify = require('@cypress/browserify-preprocessor')
+
+module.exports = (on, config) => {
+	const options = browserify.defaultOptions
+	options.browserifyOptions.transform[1][1].presets.push('@babel/preset-flow')
+	on('file:preprocessor', browserify(options))
+}

examples/preprocessors__flow-browserify/cypress/support/add.js

@@ -0,0 +1,2 @@
+// @flow
+export const add = (a: number, b: number) => a + b

examples/preprocessors__flow-browserify/cypress/support/commands.js

@@ -0,0 +1,25 @@
+// ***********************************************
+// This example commands.js shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+//
+//
+// -- This is a parent command --
+// Cypress.Commands.add("login", (email, password) => { ... })
+//
+//
+// -- This is a child command --
+// Cypress.Commands.add("drag", { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add("dismiss", { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This is will overwrite an existing command --
+// Cypress.Commands.overwrite("visit", (originalFn, url, options) => { ... })

examples/preprocessors__flow-browserify/cypress/support/index.js

@@ -0,0 +1,20 @@
+// ***********************************************************
+// This example support/index.js is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+import './commands'
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')

examples/preprocessors__flow-browserify/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "cypress-example-flow-browserify",
+  "version": "1.0.0",
+  "description": "",
+  "scripts": {
+    "start": "echo",
+    "cypress:run": "../../node_modules/.bin/cypress run",
+    "cypress:open": "../../node_modules/.bin/cypress open"
+  }
+}

package-lock.json

@@ -65,6 +65,7 @@
     "vuex": "3.1.1"
   },
   "devDependencies": {
+    "@babel/preset-flow": "7.0.0",
     "@cypress/browserify-preprocessor": "2.1.1",
     "@cypress/snapshot": "2.1.3",
     "@cypress/webpack-preprocessor": "4.1.1",