feat: allow explicit disable (#34)

README.md

@@ -492,6 +492,18 @@ or set it to `false` in the `cypress.json` file
 }
 ```
 
+If you have an object with coverage settings, you can still disable it
+
+```json
+{
+  "env": {
+    "coverage": {
+      "disable": true
+    }
+  }
+}
+```
+
 See [Cypress environment variables](https://on.cypress.io/environment-variables) and [support.js](support.js). You can try running without code coverage in this project yourself
 
 ```shell

common-utils.js

@@ -61,9 +61,26 @@ const removePlaceholders = (coverage) => {
   })
 }
 
+/**
+ * Returns true if the user disabled the plugin using the env object.
+ */
+function isPluginDisabled(cyEnv) {
+  if (cyEnv.coverage === false) {
+    return true
+  }
+  if (typeof cyEnv.coverage === 'object') {
+    // the user explicitly disabled
+    return cyEnv.coverage.disabled === true
+  }
+
+  // by default the plugin is enabled
+  return false
+}
+
 module.exports = {
   combineNycOptions,
   defaultNycOptions,
   fileCoveragePlaceholder,
   removePlaceholders,
+  isPluginDisabled,
 }

plugin.js

@@ -5,6 +5,7 @@ const { existsSync } = require('fs')
 const NYC = require('nyc')
 const debug = require('debug')('code-coverage')
 const { reportCodeCoverageGHACallback } = require('./src/utils')
+const { isPluginDisabled } = require('./common-utils')
 
 const nycFilename = getNycReportFilename(process.cwd())
 
@@ -17,7 +18,7 @@ function registerCodeCoveragePlugin(on, config) {
   // reportAfterEachSpec: 'text' = enabled "text" code coverage reporter
   // typical values: 'text-summary', 'text'
   let reportAfterEachSpec = 'text-summary'
-  let shouldReport = true
+  let shouldReport = !isPluginDisabled(config.env)
   if (
     config.env &&
     typeof config.env.coverage === 'object' &&

support.js

@@ -7,6 +7,7 @@ const {
   excludeByUser,
   filterSupportFilesFromCoverage,
 } = require('./support-utils')
+const { isPluginDisabled } = require('./common-utils')
 
 dayjs.extend(duration)
 
@@ -300,7 +301,9 @@ const cyEnvs = Cypress._.mapKeys(Cypress.env(), (value, key) =>
   key.toLowerCase(),
 )
 
-if (cyEnvs.coverage === false) {
+const pluginDisabled = isPluginDisabled(cyEnvs)
+
+if (pluginDisabled) {
   console.log('Skipping code coverage hooks')
 } else if (Cypress.env('codeCoverageTasksRegistered') !== true) {
   // register a hook just to log a message