add example where a file should not be covered

bahmutov · bahmutov · commit 65cb0c86a269 · 2020-04-21T11:14:16.000-04:00
diff --git a/examples/all-files/.babelrc b/examples/all-files/.babelrc
@@ -0,0 +1,3 @@
+{
+  "plugins": ["istanbul"]
+}
diff --git a/examples/all-files/README.md b/examples/all-files/README.md
@@ -0,0 +1 @@
+# example: all files
diff --git a/examples/all-files/cypress.json b/examples/all-files/cypress.json
@@ -0,0 +1,4 @@
+{
+  "fixturesFolder": false,
+  "baseUrl": "http://localhost:1234"
+}
diff --git a/examples/all-files/cypress/integration/spec.js b/examples/all-files/cypress/integration/spec.js
@@ -0,0 +1,12 @@
+/// <reference types="cypress" />
+it('works', () => {
+  cy.visit('/')
+  cy.contains('Page body')
+
+  cy.window()
+    .invoke('reverse', 'super')
+    .should('equal', 'repus')
+
+  // application's code should be instrumented
+  cy.window().should('have.property', '__coverage__')
+})
diff --git a/examples/all-files/cypress/plugins/index.js b/examples/all-files/cypress/plugins/index.js
@@ -0,0 +1,5 @@
+module.exports = (on, config) => {
+  require('../../../../task')(on, config)
+  on('file:preprocessor', require('../../../../use-babelrc'))
+  return config
+}
diff --git a/examples/all-files/cypress/support/commands.js b/examples/all-files/cypress/support/commands.js
@@ -0,0 +1,2 @@
+import '../../../../support'
+console.log('this is commands file')
diff --git a/examples/all-files/cypress/support/index.js b/examples/all-files/cypress/support/index.js
@@ -0,0 +1 @@
+require('./commands')
diff --git a/examples/all-files/index.html b/examples/all-files/index.html
@@ -0,0 +1,17 @@
+<body>
+  Page body
+  <script src="main.js"></script>
+  <script src="second.js"></script>
+  <script>
+    // use functions creates in "main.js"
+    if (add(2, 3) !== 5) {
+      throw new Error('wrong addition')
+    }
+    if (sub(2, 3) !== -1) {
+      throw new Error('wrong subtraction')
+    }
+    if (reverse('foo') !== 'oof') {
+      throw new Error('wrong string reverse')
+    }
+  </script>
+</body>
diff --git a/examples/all-files/main.js b/examples/all-files/main.js
@@ -0,0 +1,3 @@
+window.add = (a, b) => a + b
+
+window.sub = (a, b) => a - b
diff --git a/examples/all-files/not-covered.js b/examples/all-files/not-covered.js
@@ -0,0 +1,7 @@
+// this file is NOT included from "index.html"
+// thus it is not instrumented and not included
+// in the final code coverage numbers
+function throwsError() {
+  throw new Error('NO')
+}
+throwsError()
diff --git a/examples/all-files/package.json b/examples/all-files/package.json
@@ -0,0 +1,16 @@
+{
+  "name": "example-all-files",
+  "description": "Report all files",
+  "scripts": {
+    "start": "../../node_modules/.bin/parcel serve index.html",
+    "cy:open": "../../node_modules/.bin/cypress open",
+    "dev": "../../node_modules/.bin/start-test 1234 cy:open"
+  },
+  "nyc": {
+    "all": true,
+    "include": ["*.js"]
+  },
+  "devDependencies": {
+    "@babel/core": "7.9.0"
+  }
+}
diff --git a/examples/all-files/second.js b/examples/all-files/second.js
@@ -0,0 +1,7 @@
+// this file should be excluded from the final coverage numbers
+// using "nyc.exclude" list in package.json
+window.reverse = s =>
+  s
+    .split('')
+    .reverse()
+    .join('')
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -50,8 +50,9 @@
     "@cypress/browserify-preprocessor": "2.2.1",
     "debug": "4.1.1",
     "execa": "4.0.0",
-    "nyc": "15.0.1",
-    "istanbul-lib-coverage": "3.0.0"
+    "globby": "11.0.0",
+    "istanbul-lib-coverage": "3.0.0",
+    "nyc": "15.0.1"
   },
   "devDependencies": {
     "@babel/core": "7.9.0",

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 @@ @@
 +{
 +  "fixturesFolder": false,
 +  "baseUrl": "http://localhost:1234"
 +}
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+import '../../../../support'`
	`2`	`+console.log('this is commands file')`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+window.add = (a, b) => a + b`
	`2`	`+`
	`3`	`+window.sub = (a, b) => a - b`