fix: include the plugin version in the debug logs

Author: bahmutov

README.md

@@ -407,7 +407,23 @@ Cypress.grep('hello', '@smoke', 10)
 
 ## Debugging
 
-When debugging a problem, first make sure you are passing the values to the plugin correctly by inspecting the "Settings" tab in the Cypress Desktop GUI screen. You should see the values you have passed in the "Config" object under the `env` property. For example, if I start the Test Runner with
+When debugging a problem, first make sure you are using the expected version of this plugin, as some features might be only available in the [later releases](https://github.com/cypress-io/cypress-grep/releases).
+
+```
+# get the cypress-grep version using NPM
+$ npm ls cypress-grep
+...
+└── cypress-grep@2.10.1
+# get the cypress-grep version using Yarn
+$ yarn why cypress-grep
+...
+=> Found "cypress-grep@2.10.1"
+info Has been hoisted to "cypress-grep"
+info This module exists because it's specified in "devDependencies".
+...
+```
+
+Second, make sure you are passing the values to the plugin correctly by inspecting the "Settings" tab in the Cypress Desktop GUI screen. You should see the values you have passed in the "Config" object under the `env` property. For example, if I start the Test Runner with
 
 ```text
 $ npx cypress open --env grep=works,grepFilterTests=true
@@ -419,7 +435,7 @@ Then I expect to see the grep string and the "filter tests" flag in the `env` ob
 
 ### Log messages
 
-This module uses [debug](https://github.com/visionmedia/debug#readme) to log verbose messages. You can enable the debug messages in the plugin file (runs when discovering specs to filter), and inside the browser to see how it determines which tests to run and to skip.
+This module uses [debug](https://github.com/visionmedia/debug#readme) to log verbose messages. You can enable the debug messages in the plugin file (runs when discovering specs to filter), and inside the browser to see how it determines which tests to run and to skip. When opening a new issue, please provide the debug logs from the plugin (if any) and from the browser.
 
 ### Debugging in the plugin
 

src/plugin.js

@@ -3,6 +3,7 @@ const globby = require('globby')
 const { getTestNames } = require('find-test-names')
 const fs = require('fs')
 const path = require('path')
+const { version } = require('../package.json')
 
 /**
  * Prints the cypress-grep environment values if any.
@@ -14,6 +15,7 @@ function cypressGrepPlugin(config) {
   }
 
   debug('Cypress config env object: %o', config.env)
+  debug('plugin version %s', version)
   const grep = config.env.grep
   if (grep) {
     console.log('cypress-grep: tests with "%s" in their names', grep.trim())

src/support.js

@@ -2,6 +2,7 @@
 /// <reference path="./index.d.ts" />
 
 const { parseGrep, shouldTestRun } = require('./utils')
+const { version } = require('../package.json')
 const debug = require('debug')('cypress-grep')
 debug.log = console.info.bind(console)
 
@@ -31,7 +32,7 @@ function cypressGrep() {
 
   if (!grep && !grepTags && !burnSpecified && !grepUntagged) {
     // nothing to do, the user has no specified the "grep" string
-    debug('Nothing to grep')
+    debug('Nothing to grep, version %s', version)
     return
   }
 
@@ -46,7 +47,7 @@ function cypressGrep() {
   const omitFiltered =
     Cypress.env('grepOmitFiltered') || Cypress.env('grep-omit-filtered')
 
-  debug('grep %o', { grep, grepTags, grepBurn, omitFiltered })
+  debug('grep %o', { grep, grepTags, grepBurn, omitFiltered, version })
   if (!Cypress._.isInteger(grepBurn) || grepBurn < 1) {
     throw new Error(`Invalid grep burn value: ${grepBurn}`)
   }