@bahmutov/cy-grep 1.0.0

package/README.md

@@ -0,0 +1,602 @@
+# @bahmutov/cy-grep ![cypress version](https://img.shields.io/badge/cypress-12.1.0-brightgreen)
+
+> Filter tests using substring or tag
+
+```shell
+# run only tests with "hello" in their names
+npx cypress run --env grep=hello
+
+  ✓ hello world
+  - works
+  - works 2 @tag1
+  - works 2 @tag1 @tag2
+
+  1 passing (38ms)
+  3 pending
+```
+
+All other tests will be marked pending, see why in the [Cypress test statuses](https://on.cypress.io/writing-and-organizing-tests#Test-statuses) blog post.
+
+If you have multiple spec files, all specs will be loaded, and every test will be filtered the same way, since the grep is run-time operation and cannot eliminate the spec files without loading them. If you want to run only specific tests, use the built-in [--spec](https://on.cypress.io/command-line#cypress-run-spec-lt-spec-gt) CLI argument.
+
+Watch the video [intro to cypress-grep plugin](https://www.youtube.com/watch?v=HS-Px-Sghd8)
+
+Table of Contents
+
+<!-- MarkdownTOC autolink="true" -->
+
+- [@bahmutov/cy-grep](#bahmutovcy-grep)
+  - [Install](#install)
+    - [Support file](#support-file)
+    - [Config file](#config-file)
+  - [Usage Overview](#usage-overview)
+  - [Filter by test title](#filter-by-test-title)
+    - [OR substring matching](#or-substring-matching)
+    - [Test suites](#test-suites)
+    - [Invert filter](#invert-filter)
+  - [Filter with tags](#filter-with-tags)
+    - [Tags in the test config object](#tags-in-the-test-config-object)
+    - [AND tags](#and-tags)
+    - [OR tags](#or-tags)
+    - [Inverted tags](#inverted-tags)
+    - [NOT tags](#not-tags)
+    - [Tags in test suites](#tags-in-test-suites)
+    - [Grep untagged tests](#grep-untagged-tests)
+  - [Pre-filter specs (grepFilterSpecs)](#pre-filter-specs-grepfilterspecs)
+  - [Omit filtered tests (grepOmitFiltered)](#omit-filtered-tests-grepomitfiltered)
+  - [Disable grep](#disable-grep)
+  - [Burn (repeat) tests](#burn-repeat-tests)
+  - [TypeScript support](#typescript-support)
+  - [General advice](#general-advice)
+  - [DevTools console](#devtools-console)
+  - [Debugging](#debugging)
+    - [Log messages](#log-messages)
+    - [Debugging in the plugin](#debugging-in-the-plugin)
+    - [Debugging in the browser](#debugging-in-the-browser)
+  - [Examples](#examples)
+  - [See also](#see-also)
+  - [Migration guide](#migration-guide)
+    - [from v1 to v2](#from-v1-to-v2)
+    - [from v2 to v3](#from-v2-to-v3)
+  - [Small Print](#small-print)
+
+<!-- /MarkdownTOC -->
+
+## Install
+
+Assuming you have Cypress installed, add this module as a dev dependency.
+
+```shell
+# using NPM
+npm i -D @bahmutov/cy-grep
+# using Yarn
+yarn add -D @bahmutov/cy-grep
+```
+
+**Note**: @bahmutov/cy-grep only works with Cypress version >= 10.
+
+### Support file
+
+**required:** load this module from the [support file](https://on.cypress.io/writing-and-organizing-tests#Support-file) or at the top of the spec file if not using the support file. You import the registration function and then call it:
+
+```js
+// cypress/support/index.js
+// load and register the grep feature using "require" function
+// https://github.com/bahmutov/cy-grep
+const registerCypressGrep = require('@bahmutov/cy-grep')
+registerCypressGrep()
+
+// if you want to use the "import" keyword
+// note: `./index.d.ts` currently extends the global Cypress types and
+// does not define `registerCypressGrep` so the import path is directly
+// pointed to the `support.js` file
+import registerCypressGrep from '@bahmutov/cy-grep/src/support'
+registerCypressGrep()
+
+// "import" with `@ts-ignore`
+// @see error 2306 https://github.com/microsoft/TypeScript/blob/3fcd1b51a1e6b16d007b368229af03455c7d5794/src/compiler/diagnosticMessages.json#L1635
+// @ts-ignore
+import registerCypressGrep from '@bahmutov/cy-grep'
+registerCypressGrep()
+```
+
+### Config file
+
+**optional:** load and register this module from the [config file](https://docs.cypress.io/guides/references/configuration#setupNodeEvents):
+
+```js
+// cypress.config.js
+{
+  e2e: {
+    setupNodeEvents(on, config) {
+      require('@bahmutov/cy-grep/src/plugin')(config);
+      return config;
+  },
+  }
+}
+```
+
+Installing the plugin via `setupNodeEvents()` is required to enable the [grepFilterSpecs](#grepfilterspecs) feature.
+
+## Usage Overview
+
+You can filter tests to run using part of their title via `grep`, and via explicit tags via `grepTags` Cypress environment variables.
+
+Most likely you will pass these environment variables from the command line. For example, to only run tests with "login" in their title and tagged "smoke", you would run:
+
+Here are a few examples:
+
+```shell
+# run only the tests with "auth user" in the title
+$ npx cypress run --env grep="auth user"
+# run tests with "hello" or "auth user" in their titles
+# by separating them with ";" character
+$ npx cypress run --env grep="hello; auth user"
+# run tests tagged @fast
+$ npx cypress run --env grepTags=@fast
+# run only the tests tagged "smoke"
+# that have "login" in their titles
+$ npx cypress run --env grep=login,grepTags=smoke
+# only run the specs that have any tests with "user" in their titles
+$ npx cypress run --env grep=user,grepFilterSpecs=true
+# only run the specs that have any tests tagged "@smoke"
+$ npx cypress run --env grepTags=@smoke,grepFilterSpecs=true
+# run only tests that do not have any tags
+# and are not inside suites that have any tags
+$ npx cypress run --env grepUntagged=true
+```
+
+You can use any way to modify the environment values `grep` and `grepTags`, except the run-time `Cypress.env('grep')` (because it is too late at run-time). You can set the `grep` value in the `cypress.json` file to run only tests with the substring `viewport` in their names
+
+```json
+{
+  "env": {
+    "grep": "viewport"
+  }
+}
+```
+
+You can also set the `env.grep` object in the plugin file, but remember to return the changed config object:
+
+```js
+// cypress/plugin/index.js
+module.exports = (on, config) => {
+  config.env.grep = 'viewport'
+  return config
+}
+```
+
+You can also set the grep and grepTags from the DevTools console while running Cypress in the interactive mode `cypress open`, see [DevTools Console section](#devtools-console).
+
+## Filter by test title
+
+```shell
+# run all tests with "hello" in their title
+$ npx cypress run --env grep=hello
+# run all tests with "hello world" in their title
+$ npx cypress run --env grep="hello world"
+```
+
+### OR substring matching
+
+You can pass multiple title substrings to match separating them with `;` character. Each substring is trimmed.
+
+```shell
+# run all tests with "hello world" or "auth user" in their title
+$ npx cypress run --env grep="hello world; auth user"
+```
+
+### Test suites
+
+The filter is also applied to the "describe" blocks. In that case, the tests look up if any of their outer suites are enabled.
+
+```js
+describe('block for config', () => {
+  it('should run', () => {})
+
+  it('should also work', () => {})
+})
+```
+
+```
+# run any tests in the blocks including "config"
+--env grep=config
+```
+
+**Note:** global function `describe` and `context` are aliases and both supported by this plugin.
+
+### Invert filter
+
+```shell
+# run all tests WITHOUT "hello world" in their title
+$ npx cypress run --env grep="-hello world"
+# run tests with "hello", but without "world" in the titles
+$ npx cypress run --env grep="hello; -world"
+```
+
+**Note:** Inverted title filter is not compatible with the `grepFilterSpecs` option
+
+## Filter with tags
+
+You can select tests to run or skip using tags by passing `--env grepTags=...` value.
+
+```
+# enable the tests with tag "one" or "two"
+--env grepTags="one two"
+# enable the tests with both tags "one" and "two"
+--env grepTags="one+two"
+# enable the tests with "hello" in the title and tag "smoke"
+--env grep=hello,grepTags=smoke
+```
+
+If you can pass commas in the environment variable `grepTags`, you can use `,` to separate the tags
+
+```
+# enable the tests with tag "one" or "two"
+CYPRESS_grepTags=one,two npx cypress run
+```
+
+### Tags in the test config object
+
+Cypress tests can have their own [test config object](https://on.cypress.io/configuration#Test-Configuration), and when using this plugin you can put the test tags there, either as a single tag string or as an array of tags.
+
+```js
+it('works as an array', { tags: ['config', 'some-other-tag'] }, () => {
+  expect(true).to.be.true
+})
+
+it('works as a string', { tags: 'config' }, () => {
+  expect(true).to.be.true
+})
+```
+
+You can run both of these tests using `--env grepTags=config` string.
+
+### AND tags
+
+Use `+` to require both tags to be present
+
+```
+--env grepTags=@smoke+@fast
+```
+
+### OR tags
+
+You can run tests that match one tag or another using spaces. Make sure to quote the grep string!
+
+```
+# run tests with tags "@slow" or "@critical" in their names
+--env grepTags='@slow @critical'
+```
+
+### Inverted tags
+
+You can skip running the tests with specific tag using the invert option: prefix the tag with the character `-`.
+
+```
+# do not run any tests with tag "@slow"
+--env grepTags=-@slow
+```
+
+If you want to run all tests with tag `@slow` but without tag `@smoke`:
+
+```
+--env grepTags=@slow+-@smoke
+```
+
+**Note:** Inverted tag filter is not compatible with the `grepFilterSpecs` option
+
+### NOT tags
+
+You can skip running the tests with specific tag, even if they have a tag that should run, using the not option: prefix the tag with `--`.
+
+Note this is the same as appending `+-<tag to never run>` to each tag. May be useful with large number of tags.
+
+If you want to run tests with tags `@slow` or `@regression` but without tag `@smoke`
+
+```
+--env grepTags='@slow @regression --@smoke'
+```
+
+which is equivalent to
+
+```
+--env grepTags='@slow+-@smoke @regression+-@smoke'
+```
+
+### Tags in test suites
+
+The tags are also applied to the "describe" blocks. In that case, the tests look up if any of their outer suites are enabled.
+
+```js
+describe('block with config tag', { tags: '@smoke' }, () => {})
+```
+
+```
+# run any tests in the blocks having "@smoke" tag
+--env grepTags=@smoke
+# skip any blocks with "@smoke" tag
+--env grepTags=-@smoke
+```
+
+See the [cypress/integration/describe-tags-spec.js](./cypress/integration/describe-tags-spec.js) file.
+
+**Note:** global function `describe` and `context` are aliases and both supported by this plugin.
+
+### Grep untagged tests
+
+Sometimes you want to run only the tests without any tags, and these tests are inside the describe blocks without any tags.
+
+```
+$ npx cypress run --env grepUntagged=true
+```
+
+## Pre-filter specs (grepFilterSpecs)
+
+By default, when using `grep` and `grepTags` all specs are executed, and inside each the filters are applied. This can be very wasteful, if only a few specs contain the `grep` in the test titles. Thus when doing the positive `grep`, you can pre-filter specs using the `grepFilterSpecs=true` parameter.
+
+```
+# filter all specs first, and only run the ones with
+# suite or test titles containing the string "it loads"
+$ npx cypress run --env grep="it loads",grepFilterSpecs=true
+# filter all specs files, only run the specs with a tag "@smoke"
+$ npx cypress run --env grepTags=@smoke,grepFilterSpecs=true
+```
+
+**Note 1:** this requires installing this plugin in your project's plugin file, see the [Install](#install).
+
+**Note 2:** the `grepFilterSpecs` option is only compatible with the positive `grep` and `grepTags` options, not with the negative (inverted) "-..." filter.
+
+**Note 3:** if there are no files remaining after filtering, the plugin prints a warning and leaves all files unchanged to avoid the test runner erroring with "No specs found".
+
+**Tip:** you can set this environment variable in the [config file](https://docs.cypress.io/guides/references/configuration) file to enable it by default and skip using the environment variable:
+
+```js
+{
+  "env": {
+    "grepFilterSpecs": true
+  }
+}
+```
+
+## Omit filtered tests (grepOmitFiltered)
+
+By default, all filtered tests are made _pending_ using `it.skip` method. If you want to completely omit them, pass the environment variable `grepOmitFiltered=true`.
+
+Pending filtered tests
+
+```
+cypress run --env grep="works 2"
+```
+
+![Pending tests](./images/includes-pending.png)
+
+Omit filtered tests
+
+```
+cypress run --env grep="works 2",grepOmitFiltered=true
+```
+
+![Only running tests remaining](./images/omit-pending.png)
+
+**Tip:** you can set this environment variable in the config file (usually `cypress.config.js`) file to enable it by default and skip using the environment variable:
+
+```json
+{
+  "env": {
+    "grepOmitFiltered": true
+  }
+}
+```
+
+## Disable grep
+
+If you specify the `grep` parameters the [config file](https://docs.cypress.io/guides/references/configuration), you can disable it from the command line
+
+```
+$ npx cypress run --env grep=,grepTags=,burn=
+```
+
+## Burn (repeat) tests
+
+You can burn the filtered tests to make sure they are flake-free
+
+```
+npx cypress run --env grep="hello world",burn=5
+```
+
+You can pass the number of times to run the tests via environment name `burn` or `grepBurn` or `grep-burn`. Note, if a lot of tests match the grep and grep tags, a lot of tests will be burnt!
+
+If you do not specify the "grep" or "grep tags" option, the "burn" will repeat _every_ test.
+
+## TypeScript support
+
+Because the Cypress test config object type definition does not have the `tags` property we are using above, the TypeScript linter will show an error. Just add an ignore comment above the test:
+
+```js
+// @ts-ignore
+it('runs on deploy', { tags: 'smoke' }, () => {
+  ...
+})
+```
+
+This package comes with [src/index.d.ts](./src/index.d.ts) definition file that adds the property `tags` to the Cypress test overrides interface. Include this file in your specs or TS config settings. For example, you can load it using a reference comment
+
+```js
+// cypress/integration/my-spec.js
+/// <reference types="@bahmutov/cy-grep" />
+```
+
+If you have `tsconfig.json` file, add this library to the types list
+
+```json
+{
+  "compilerOptions": {
+    "target": "es5",
+    "lib": ["es5", "dom"],
+    "types": ["cypress", "@bahmutov/cy-grep"]
+  },
+  "include": ["**/*.ts"]
+}
+```
+
+## General advice
+
+- keep it simple.
+- I like using `@` as tag prefix to make the tags searchable
+
+```js
+// ✅ good practice
+describe('auth', { tags: '@critical' }, () => ...)
+it('works', { tags: '@smoke' }, () => ...)
+it('works quickly', { tags: ['@smoke', '@fast'] }, () => ...)
+
+// 🚨 NOT GOING TO WORK
+// ERROR: treated as a single tag,
+// probably want an array instead
+it('works', { tags: '@smoke @fast' }, () => ...)
+```
+
+Grepping the tests
+
+```shell
+# run the tests by title
+$ npx cypress run --env grep="works quickly"
+# run all tests tagged @smoke
+$ npx cypress run --env grepTags=@smoke
+# run all tests except tagged @smoke
+$ npx cypress run --env grepTags=-@smoke
+# run all tests that have tag @fast but do not have tag @smoke
+$ npx cypress run --env grepTags=@fast+-@smoke
+```
+
+I would run all tests by default, and grep tests from the command line. For example, I could run the smoke tests first using grep plugin, and if the smoke tests pass, then run all the tests. See the video [How I organize pull request workflows by running smoke tests first](https://www.youtube.com/watch?v=SFW7Ecj5TNE) and its [pull request workflow file](https://github.com/bahmutov/cypress-grep-example/blob/main/.github/workflows/pr.yml).
+
+## DevTools console
+
+You can set the grep string from the DevTools Console. This plugin adds method `Cypress.grep` and `Cypress.grepTags` to set the grep strings and restart the tests
+
+```js
+// filter tests by title substring
+Cypress.grep('hello world')
+// run filtered tests 100 times
+Cypress.grep('hello world', null, 100)
+// filter tests by tag string
+// in this case will run tests with tag @smoke OR @fast
+Cypress.grep(null, '@smoke @fast')
+// run tests tagged @smoke AND @fast
+Cypress.grep(null, '@smoke+@fast')
+// run tests with title containing "hello" and tag @smoke
+Cypress.grep('hello', '@smoke')
+// run tests with title containing "hello" and tag @smoke 10 times
+Cypress.grep('hello', '@smoke', 10)
+```
+
+- to remove the grep strings enter `Cypress.grep()`
+
+## Debugging
+
+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
+```
+
+Then I expect to see the grep string and the "filter tests" flag in the `env` object.
+
+![Values in the env object](./images/config.png)
+
+### 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. When opening a new issue, please provide the debug logs from the plugin (if any) and from the browser.
+
+### Debugging in the plugin
+
+Start Cypress with the environment variable `DEBUG=cypress-grep`. You will see a few messages from this plugin in the terminal output:
+
+```
+$ DEBUG=cypress-grep npx cypress run --env grep=works,grepFilterSpecs=true
+cypress-grep: tests with "works" in their names
+cypress-grep: filtering specs using "works" in the title
+  cypress-grep Cypress config env object: { grep: 'works', grepFilterSpecs: true }
+  ...
+  cypress-grep found 1 spec files +5ms
+  cypress-grep [ 'spec.js' ] +0ms
+  cypress-grep spec file spec.js +5ms
+  cypress-grep suite and test names: [ 'hello world', 'works', 'works 2 @tag1',
+    'works 2 @tag1 @tag2', 'works @tag2' ] +0ms
+  cypress-grep found "works" in 1 specs +0ms
+  cypress-grep [ 'spec.js' ] +0ms
+```
+
+### Debugging in the browser
+
+To enable debug console messages in the browser, from the DevTools console set `localStorage.debug='cypress-grep'` and run the tests again.
+
+![Debug messages](./images/debug.png)
+
+To see how to debug this plugin, watch the video [Debug cypress-grep Plugin](https://youtu.be/4YMAERddHYA).
+
+## Examples
+
+- [cypress-grep-example](https://github.com/bahmutov/cypress-grep-example)
+- [todo-graphql-example](https://github.com/bahmutov/todo-graphql-example)
+
+## See also
+
+- [cypress-select-tests](https://github.com/bahmutov/cypress-select-tests)
+- [cypress-skip-test](https://github.com/cypress-io/cypress-skip-test)
+
+## Migration guide
+
+### from v1 to v2
+
+In v2 we have separated grepping by part of the title string from tags.
+
+**v1**
+
+```
+--env grep="one two"
+```
+
+The above scenario was confusing - did you want to find all tests with title containing "one two" or did you want to run tests tagged `one` or `two`?
+
+**v2**
+
+```
+# enable the tests with string "one two" in their titles
+--env grep="one two"
+# enable the tests with tag "one" or "two"
+--env grepTags="one two"
+# enable the tests with both tags "one" and "two"
+--env grepTags="one+two"
+# enable the tests with "hello" in the title and tag "smoke"
+--env grep=hello,grepTags=smoke
+```
+
+### from v2 to v3
+
+Version >= 3 of cypress-grep _only_ supports Cypress >= 10.
+
+## Small Print
+
+License: MIT - do anything with the code, but don't blame me if it does not work.
+
+Support: if you find any problems with this module, email / tweet /
+[open issue](https://github.com/bahmutov/cy-grep/issues) on Github

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@bahmutov/cy-grep",
+  "version": "1.0.0",
+  "description": "Filter Cypress tests using title or tags",
+  "main": "src/support.js",
+  "scripts": {
+    "cy:run": "cypress run --config specPattern='**/unit.js'",
+    "cy:open": "cypress open --e2e -b electron --config specPattern='**/unit.js'",
+    "badges": "npx -p dependency-version-badge update-badge cypress",
+    "semantic-release": "semantic-release"
+  },
+  "dependencies": {
+    "cypress-plugin-config": "^1.2.0",
+    "debug": "^4.3.2",
+    "find-test-names": "^1.22.2",
+    "globby": "^11.0.4"
+  },
+  "devDependencies": {
+    "cypress": "12.1.0",
+    "cypress-each": "^1.11.0",
+    "cypress-expect": "^2.5.3",
+    "prettier": "^2.8.1",
+    "semantic-release": "^19.0.5",
+    "typescript": "^4.7.4"
+  },
+  "peerDependencies": {
+    "cypress": ">=10"
+  },
+  "files": [
+    "src"
+  ],
+  "types": "src/index.d.ts",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bahmutov/cy-grep.git"
+  },
+  "homepage": "https://github.com/bahmutov/cy-grep",
+  "author": "Gleb Bahmutov <gleb.bahmutov@gmail.com>",
+  "bugs": {
+    "url": "https://github.com/bahmutov/cy-grep/issues"
+  },
+  "keywords": [
+    "cypress",
+    "grep"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/index.d.ts

@@ -0,0 +1,31 @@
+/// <reference types="cypress" />
+
+declare namespace Cypress {
+  interface SuiteConfigOverrides {
+    /**
+     * List of tags for this suite
+     * @example a single tag
+     *  describe('block with config tag', { tags: '@smoke' }, () => {})
+     * @example multiple tags
+     *  describe('block with config tag', { tags: ['@smoke', '@slow'] }, () => {})
+     */
+    tags?: string | string[]
+  }
+
+  // specify additional properties in the TestConfig object
+  // in our case we will add "tags" property
+  interface TestConfigOverrides {
+    /**
+     * List of tags for this test
+     * @example a single tag
+     *  it('logs in', { tags: '@smoke' }, () => { ... })
+     * @example multiple tags
+     *  it('works', { tags: ['@smoke', '@slow'] }, () => { ... })
+     */
+    tags?: string | string[]
+  }
+
+  interface Cypress {
+    grep?: (grep?: string, tags?: string, burn?: string) => void
+  }
+}

package/src/plugin.js

@@ -0,0 +1,156 @@
+const debug = require('debug')('cypress-grep')
+const globby = require('globby')
+const { getTestNames } = require('find-test-names')
+const fs = require('fs')
+const { version } = require('../package.json')
+const { parseGrep, shouldTestRun } = require('./utils')
+
+/**
+ * Prints the cypress-grep environment values if any.
+ * @param {Cypress.ConfigOptions} config
+ */
+function cypressGrepPlugin (config) {
+  if (!config || !config.env) {
+    return config
+  }
+
+  const { env } = config
+
+  if (!config.specPattern) {
+    throw new Error(
+      'Incompatible versions detected, cypress-grep 3.0.0+ requires Cypress 10.0.0+',
+    )
+  }
+
+  debug('cypress-grep plugin version %s', version)
+  debug('Cypress config env object: %o', env)
+
+  const grep = env.grep ? String(env.grep) : undefined
+
+  if (grep) {
+    console.log('cypress-grep: tests with "%s" in their names', grep.trim())
+  }
+
+  const grepTags = env.grepTags || env['grep-tags']
+
+  if (grepTags) {
+    console.log('cypress-grep: filtering using tag(s) "%s"', grepTags)
+    const parsedGrep = parseGrep(null, grepTags)
+
+    debug('parsed grep tags %o', parsedGrep.tags)
+  }
+
+  const grepBurn = env.grepBurn || env['grep-burn'] || env.burn
+
+  if (grepBurn) {
+    console.log('cypress-grep: running filtered tests %d times', grepBurn)
+  }
+
+  const grepUntagged = env.grepUntagged || env['grep-untagged']
+
+  if (grepUntagged) {
+    console.log('cypress-grep: running untagged tests')
+  }
+
+  const omitFiltered = env.grepOmitFiltered || env['grep-omit-filtered']
+
+  if (omitFiltered) {
+    console.log('cypress-grep: will omit filtered tests')
+  }
+
+  const { specPattern, excludeSpecPattern } = config
+  const integrationFolder = env.grepIntegrationFolder || process.cwd()
+
+  const grepFilterSpecs = env.grepFilterSpecs === true
+
+  if (grepFilterSpecs) {
+    debug('specPattern', specPattern)
+    debug('excludeSpecPattern', excludeSpecPattern)
+    debug('integrationFolder', integrationFolder)
+    const specFiles = globby.sync(specPattern, {
+      cwd: integrationFolder,
+      ignore: excludeSpecPattern,
+      absolute: true,
+    })
+
+    debug('found %d spec files', specFiles.length)
+    debug('%o', specFiles)
+    let greppedSpecs = []
+
+    if (grep) {
+      console.log('cypress-grep: filtering specs using "%s" in the title', grep)
+      const parsedGrep = parseGrep(grep)
+
+      debug('parsed grep %o', parsedGrep)
+      greppedSpecs = specFiles.filter((specFile) => {
+        const text = fs.readFileSync(specFile, { encoding: 'utf8' })
+
+        try {
+          const names = getTestNames(text)
+          const testAndSuiteNames = names.suiteNames.concat(names.testNames)
+
+          debug('spec file %s', specFile)
+          debug('suite and test names: %o', testAndSuiteNames)
+
+          return testAndSuiteNames.some((name) => {
+            const shouldRun = shouldTestRun(parsedGrep, name)
+
+            return shouldRun
+          })
+        } catch (err) {
+          debug(err.message)
+          debug(err.stack)
+          console.error('Could not determine test names in file: %s', specFile)
+          console.error('Will run it to let the grep filter the tests')
+
+          return true
+        }
+      })
+
+      debug('found grep "%s" in %d specs', grep, greppedSpecs.length)
+      debug('%o', greppedSpecs)
+    } else if (grepTags) {
+      const parsedGrep = parseGrep(null, grepTags)
+
+      debug('parsed grep tags %o', parsedGrep)
+      greppedSpecs = specFiles.filter((specFile) => {
+        const text = fs.readFileSync(specFile, { encoding: 'utf8' })
+
+        try {
+          const testInfo = getTestNames(text)
+
+          debug('spec file %s', specFile)
+          debug('test info: %o', testInfo.tests)
+
+          return testInfo.tests.some((info) => {
+            const shouldRun = shouldTestRun(parsedGrep, null, info.tags)
+
+            return shouldRun
+          })
+        } catch (err) {
+          console.error('Could not determine test names in file: %s', specFile)
+          console.error('Will run it to let the grep filter the tests')
+
+          return true
+        }
+      })
+
+      debug('found grep tags "%s" in %d specs', grepTags, greppedSpecs.length)
+      debug('%o', greppedSpecs)
+    }
+
+    if (greppedSpecs.length) {
+      config.specPattern = greppedSpecs
+    } else {
+      // hmm, we filtered out all specs, probably something is wrong
+      console.warn('grep and/or grepTags has eliminated all specs')
+      grep ? console.warn('grep: %s', grep) : null
+      grepTags ? console.warn('grepTags: %s', grepTags) : null
+      console.warn('Will leave all specs to run to filter at run-time')
+    }
+  }
+
+  return config
+}
+
+module.exports = cypressGrepPlugin

package/src/support.js

@@ -0,0 +1,256 @@
+// @ts-check
+/// <reference path="./index.d.ts" />
+
+const { parseGrep, shouldTestRun } = require('./utils')
+// @ts-ignore
+const { version } = require('../package.json')
+const {
+  getPluginConfigValue,
+  setPluginConfigValue,
+} = require('cypress-plugin-config')
+const debug = require('debug')('@bahmutov/cy-grep')
+
+debug.log = console.info.bind(console)
+
+// preserve the real "it" function
+const _it = it
+const _describe = describe
+
+/**
+ * Wraps the "it" and "describe" functions that support tags.
+ * @see https://github.com/cypress-io/cypress-grep
+ */
+function cypressGrep() {
+  /** @type {string} Part of the test title go grep */
+  let grep = getPluginConfigValue('grep')
+
+  if (grep) {
+    grep = String(grep).trim()
+  }
+
+  /** @type {string} Raw tags to grep string */
+  const grepTags =
+    getPluginConfigValue('grepTags') || getPluginConfigValue('grep-tags')
+
+  const burnSpecified =
+    getPluginConfigValue('grepBurn') ||
+    getPluginConfigValue('grep-burn') ||
+    getPluginConfigValue('burn')
+
+  const grepUntagged =
+    getPluginConfigValue('grepUntagged') ||
+    getPluginConfigValue('grep-untagged')
+
+  if (!grep && !grepTags && !burnSpecified && !grepUntagged) {
+    // nothing to do, the user has no specified the "grep" string
+    debug('Nothing to grep, version %s', version)
+
+    return
+  }
+
+  /** @type {number} Number of times to repeat each running test */
+  const grepBurn =
+    getPluginConfigValue('grepBurn') ||
+    getPluginConfigValue('grep-burn') ||
+    getPluginConfigValue('burn') ||
+    1
+
+  /** @type {boolean} Omit filtered tests completely */
+  const omitFiltered =
+    getPluginConfigValue('grepOmitFiltered') ||
+    getPluginConfigValue('grep-omit-filtered')
+
+  debug('grep %o', { grep, grepTags, grepBurn, omitFiltered, version })
+  if (!Cypress._.isInteger(grepBurn) || grepBurn < 1) {
+    throw new Error(`Invalid grep burn value: ${grepBurn}`)
+  }
+
+  const parsedGrep = parseGrep(grep, grepTags)
+
+  debug('parsed grep %o', parsedGrep)
+
+  // prevent multiple registrations
+  // https://github.com/cypress-io/cypress-grep/issues/59
+  if (it.name === 'itGrep') {
+    debug('already registered cypress-grep')
+
+    return
+  }
+
+  it = function itGrep(name, options, callback) {
+    if (typeof options === 'function') {
+      // the test has format it('...', cb)
+      callback = options
+      options = {}
+    }
+
+    if (!callback) {
+      // the pending test by itself
+      return _it(name, options)
+    }
+
+    let configTags = options && options.tags
+
+    if (typeof configTags === 'string') {
+      configTags = [configTags]
+    }
+
+    const nameToGrep = suiteStack
+      .map((item) => item.name)
+      .concat(name)
+      .join(' ')
+    const tagsToGrep = suiteStack
+      .flatMap((item) => item.tags)
+      .concat(configTags)
+      .filter(Boolean)
+
+    const shouldRun = shouldTestRun(
+      parsedGrep,
+      nameToGrep,
+      tagsToGrep,
+      grepUntagged,
+    )
+
+    if (tagsToGrep && tagsToGrep.length) {
+      debug(
+        'should test "%s" with tags %s run? %s',
+        name,
+        tagsToGrep.join(','),
+        shouldRun,
+      )
+    } else {
+      debug('should test "%s" run? %s', nameToGrep, shouldRun)
+    }
+
+    if (shouldRun) {
+      if (grepBurn > 1) {
+        // repeat the same test to make sure it is solid
+        return Cypress._.times(grepBurn, (k) => {
+          const fullName = `${name}: burning ${k + 1} of ${grepBurn}`
+
+          _it(fullName, options, callback)
+        })
+      }
+
+      return _it(name, options, callback)
+    }
+
+    if (omitFiltered) {
+      // omit the filtered tests completely
+      return
+    }
+
+    // skip tests without grep string in their names
+    return _it.skip(name, options, callback)
+  }
+
+  // list of "describe" suites for the current test
+  // when we encounter a new suite, we push it to the stack
+  // when the "describe" function exits, we pop it
+  // Thus a test can look up the tags from its parent suites
+  const suiteStack = []
+
+  describe = function describeGrep(name, options, callback) {
+    if (typeof options === 'function') {
+      // the block has format describe('...', cb)
+      callback = options
+      options = {}
+    }
+
+    const stackItem = { name }
+
+    suiteStack.push(stackItem)
+
+    if (!callback) {
+      // the pending suite by itself
+      const result = _describe(name, options)
+
+      suiteStack.pop()
+
+      return result
+    }
+
+    let configTags = options && options.tags
+
+    if (typeof configTags === 'string') {
+      configTags = [configTags]
+    }
+
+    if (!configTags || !configTags.length) {
+      // if the describe suite does not have explicit tags
+      // move on, since the tests inside can have their own tags
+      _describe(name, options, callback)
+      suiteStack.pop()
+
+      return
+    }
+
+    // when looking at the suite of the tests, I found
+    // that using the name is quickly becoming very confusing
+    // and thus we need to use the explicit tags
+    stackItem.tags = configTags
+    _describe(name, options, callback)
+    suiteStack.pop()
+
+    return
+  }
+
+  // overwrite "context" which is an alias to "describe"
+  context = describe
+
+  // overwrite "specify" which is an alias to "it"
+  specify = it
+
+  // keep the ".skip", ".only" methods the same as before
+  it.skip = _it.skip
+  it.only = _it.only
+  // preserve "it.each" method if found
+  // https://github.com/cypress-io/cypress-grep/issues/72
+  if (typeof _it.each === 'function') {
+    it.each = _it.each
+  }
+
+  describe.skip = _describe.skip
+  describe.only = _describe.only
+  if (typeof _describe.each === 'function') {
+    describe.each = _describe.each
+  }
+}
+
+function restartTests() {
+  setTimeout(() => {
+    window.top.document.querySelector('.reporter .restart').click()
+  }, 0)
+}
+
+if (!Cypress.grep) {
+  /**
+   * A utility method to set the grep and run the tests from
+   * the DevTools console. Restarts the test runner
+   * @example
+   *  // run only the tests with "hello w" in the title
+   *  Cypress.grep('hello w')
+   *  // runs only tests tagged both "@smoke" and "@fast"
+   *  Cypress.grep(null, '@smoke+@fast')
+   *  // runs the grepped tests 100 times
+   *  Cypress.grep('add items', null, 100)
+   *  // remove all current grep settings
+   *  // and run all tests
+   *  Cypress.grep()
+   * @see "Grep from DevTools console" https://github.com/cypress-io/cypress-grep#devtools-console
+   */
+  Cypress.grep = function grep(grep, tags, burn) {
+    setPluginConfigValue('grep', grep)
+    setPluginConfigValue('grepTags', tags)
+    setPluginConfigValue('grepBurn', burn)
+    // remove any aliased values
+    setPluginConfigValue('grep-tags', null)
+    setPluginConfigValue('grep-burn', null)
+    setPluginConfigValue('burn', null)
+
+    debug('set new grep to "%o" restarting tests', { grep, tags, burn })
+    restartTests()
+  }
+}
+
+module.exports = cypressGrep

package/src/utils.js

@@ -0,0 +1,187 @@
+// @ts-check
+
+// Universal code - should run in Node or in the browser
+
+/**
+ * Parses test title grep string.
+ * The string can have "-" in front of it to invert the match.
+ * @param {string} s Input substring of the test title
+ */
+function parseTitleGrep (s) {
+  if (!s || typeof s !== 'string') {
+    return null
+  }
+
+  s = s.trim()
+  if (s.startsWith('-')) {
+    return {
+      title: s.substring(1),
+      invert: true,
+    }
+  }
+
+  return {
+    title: s,
+    invert: false,
+  }
+}
+
+function parseFullTitleGrep (s) {
+  if (!s || typeof s !== 'string') {
+    return []
+  }
+
+  // separate each title
+  return s.split(';').map(parseTitleGrep)
+}
+
+/**
+ * Parses tags to grep for.
+ * @param {string} s Tags string like "@tag1+@tag2"
+ */
+function parseTagsGrep (s) {
+  if (!s) {
+    return []
+  }
+
+  const explicitNotTags = []
+
+  // top level split - using space or comma, each part is OR
+  const ORS = s
+  .split(/[ ,]/)
+  // remove any empty tags
+  .filter(Boolean)
+  .map((part) => {
+    // now every part is an AND
+    if (part.startsWith('--')) {
+      explicitNotTags.push({
+        tag: part.slice(2),
+        invert: true,
+      })
+
+      return
+    }
+
+    const parsed = part.split('+').map((tag) => {
+      if (tag.startsWith('-')) {
+        return {
+          tag: tag.slice(1),
+          invert: true,
+        }
+      }
+
+      return {
+        tag,
+        invert: false,
+      }
+    })
+
+    return parsed
+  })
+
+  // filter out undefined from explicit not tags
+  const ORS_filtered = ORS.filter((x) => x !== undefined)
+
+  if (explicitNotTags.length > 0) {
+    ORS_filtered.forEach((OR, index) => {
+      ORS_filtered[index] = OR.concat(explicitNotTags)
+    })
+
+    if (ORS_filtered.length === 0) {
+      ORS_filtered[ 0 ] = explicitNotTags
+    }
+  }
+
+  return ORS_filtered
+}
+
+function shouldTestRunTags (parsedGrepTags, tags = []) {
+  if (!parsedGrepTags.length) {
+    // there are no parsed tags to search for, the test should run
+    return true
+  }
+
+  // now the test has tags and the parsed tags are present
+
+  // top levels are OR
+  const onePartMatched = parsedGrepTags.some((orPart) => {
+    const everyAndPartMatched = orPart.every((p) => {
+      if (p.invert) {
+        return !tags.includes(p.tag)
+      }
+
+      return tags.includes(p.tag)
+    })
+    // console.log('every part matched %o?', orPart, everyAndPartMatched)
+
+    return everyAndPartMatched
+  })
+
+  // console.log('onePartMatched', onePartMatched)
+  return onePartMatched
+}
+
+function shouldTestRunTitle (parsedGrep, testName) {
+  if (!testName) {
+    // if there is no title, let it run
+    return true
+  }
+
+  if (!parsedGrep) {
+    return true
+  }
+
+  if (!Array.isArray(parsedGrep)) {
+    console.error('Invalid parsed title grep')
+    console.error(parsedGrep)
+    throw new Error('Expected title grep to be an array')
+  }
+
+  if (!parsedGrep.length) {
+    return true
+  }
+
+  const inverted = parsedGrep.filter((g) => g.invert)
+  const straight = parsedGrep.filter((g) => !g.invert)
+
+  return (
+    inverted.every((titleGrep) => !testName.includes(titleGrep.title)) &&
+    (!straight.length ||
+      straight.some((titleGrep) => testName.includes(titleGrep.title)))
+  )
+}
+
+// note: tags take precedence over the test name
+function shouldTestRun (parsedGrep, testName, tags = [], grepUntagged = false) {
+  if (grepUntagged) {
+    return !tags.length
+  }
+
+  if (Array.isArray(testName)) {
+    // the caller passed tags only, no test name
+    tags = testName
+    testName = undefined
+  }
+
+  return (
+    shouldTestRunTitle(parsedGrep.title, testName) &&
+    shouldTestRunTags(parsedGrep.tags, tags)
+  )
+}
+
+function parseGrep (titlePart, tags) {
+  return {
+    title: parseFullTitleGrep(titlePart),
+    tags: parseTagsGrep(tags),
+  }
+}
+
+module.exports = {
+  parseGrep,
+  parseTitleGrep,
+  parseFullTitleGrep,
+  parseTagsGrep,
+  shouldTestRun,
+  shouldTestRunTags,
+  shouldTestRunTitle,
+}