add typescript example

bahmutov · bahmutov · commit a665691414ef · 2020-03-27T14:50:36.000-04:00
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -29,10 +29,10 @@ jobs:
       # we don't need Cypress to do the release
       CYPRESS_INSTALL_BINARY: '0'
       # trick semantic-release into thinking this is NOT a pull request
-      # (under the hood env-ci is used)
-      CIRCLE_PR_NUMBER:
-      CIRCLE_PULL_REQUEST:
-      CI_PULL_REQUEST:
+      # (under the hood the module env-ci is used to check if this is a PR)
+      CIRCLE_PR_NUMBER: ''
+      CIRCLE_PULL_REQUEST: ''
+      CI_PULL_REQUEST: ''
     steps:
       - checkout
       - node/with-cache:
diff --git a/README.md b/README.md
@@ -337,6 +337,7 @@ npm run dev:no:coverage
 
 - [examples/before-each-visit](examples/before-each-visit) checks if code coverage correctly keeps track of code when doing `cy.visit` before each test
 - [examples/before-all-visit](examples/before-all-visit) checks if code coverage works when `cy.visit` is made once in the `before` hook
+- [examples/ts-example](examples/ts-example) uses Babel + Parcel to instrument and serve TypeScript file
 
 ### External examples
 
diff --git a/examples/ts-example/.babelrc b/examples/ts-example/.babelrc
@@ -0,0 +1,3 @@
+{
+  "plugins": ["istanbul"]
+}
diff --git a/examples/ts-example/README.md b/examples/ts-example/README.md
@@ -0,0 +1,11 @@
+# example: ts-example
+
+Code coverage for TypeScript code. See [nyc TS support](https://github.com/istanbuljs/nyc#typescript-projects) docs too.
+
+Code is instrumented on the fly using [.babelrc](.babelrc) and Parcel to run it.
+
+## Use
+
+- start the server and Cypress with `npm run dev`
+- run the Cypress tests
+- look at the generated reports in folder `coverage`
diff --git a/examples/ts-example/cypress.json b/examples/ts-example/cypress.json
@@ -0,0 +1,4 @@
+{
+  "baseUrl": "http://localhost:1234",
+  "fixturesFolder": false
+}
diff --git a/examples/ts-example/cypress/integration/spec.js b/examples/ts-example/cypress/integration/spec.js
@@ -0,0 +1,28 @@
+/// <reference types="cypress" />
+describe('ts-example', () => {
+  beforeEach(() => {
+    cy.visit('/')
+  })
+
+  it('calls add', () => {
+    cy.window()
+      .invoke('add', 2, 3)
+      .should('equal', 5)
+  })
+
+  it('calls sub', () => {
+    cy.window()
+      .invoke('sub', 2, 3)
+      .should('equal', -1)
+  })
+
+  it('calls abs twice', () => {
+    cy.window()
+      .invoke('abs', 2)
+      .should('equal', 2)
+
+    cy.window()
+      .invoke('abs', -5)
+      .should('equal', 5)
+  })
+})
diff --git a/examples/ts-example/cypress/plugins/index.js b/examples/ts-example/cypress/plugins/index.js
@@ -0,0 +1,3 @@
+module.exports = (on, config) => {
+  on('task', require('../../../../task'))
+}
diff --git a/examples/ts-example/cypress/support/index.js b/examples/ts-example/cypress/support/index.js
@@ -0,0 +1 @@
+import '../../../../support'
diff --git a/examples/ts-example/index.html b/examples/ts-example/index.html
@@ -0,0 +1,4 @@
+<body>
+  Page body
+  <script src="main.ts"></script>
+</body>
diff --git a/examples/ts-example/main.ts b/examples/ts-example/main.ts
@@ -0,0 +1,22 @@
+const add = (a: number, b: number) => {
+  return a + b
+}
+
+const sub = (a: number, b: number) => {
+  return a - b
+}
+
+function abs(x: number) {
+  if (x >= 0) {
+    return x
+  } else {
+    return -x
+  }
+}
+
+// @ts-ignore
+window.add = add
+// @ts-ignore
+window.sub = sub
+// @ts-ignore
+window.abs = abs
diff --git a/examples/ts-example/package.json b/examples/ts-example/package.json
@@ -0,0 +1,18 @@
+{
+  "name": "example-before-each-visit",
+  "description": "Getting code coverage when cy.visit is used in beforeEach hook",
+  "devDependencies": {},
+  "nyc": {
+    "extends": "@istanbuljs/nyc-config-typescript",
+    "all": true
+  },
+  "scripts": {
+    "start": "../../node_modules/.bin/parcel serve index.html",
+    "build": "../../node_modules/.bin/parcel build index.html",
+    "serve": "../../node_modules/.bin/serve dist",
+    "cy:open": "../../node_modules/.bin/cypress open",
+    "coverage": "../../node_modules/.bin/nyc report --report-dir ./coverage --temp-dir .nyc_output --reporter=lcov",
+    "dev": "../../node_modules/.bin/start-test 1234 cy:open",
+    "dev:dist": "CYPRESS_baseUrl=http://localhost:5000 ../../node_modules/.bin/start-test serve 5000 cy:open"
+  }
+}
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "plugins": ["istanbul"]`
	`3`	`+}`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "baseUrl": "http://localhost:1234",
 +  "fixturesFolder": false
 +}
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+module.exports = (on, config) => {`
	`2`	`+ on('task', require('../../../../task'))`
	`3`	`+}`