breaking: convert @cypress/grep to TypeScript and change what is exported

BREAKING CHANGE: @cypress/grep now exports a register function that can be imported from the users spec file. Additionally, the plugin can be imported via @cypress/grep/plugin.

Author: AtofStryker

.circleci/src/workflows/@workflows.yml

@@ -2368,9 +2368,34 @@ jobs:
     resource_class: small
     steps:
       - restore_cached_workspace
+      - run: yarn workspace @cypress/grep cypress:run:tags:before
+      - run: yarn workspace @cypress/grep cypress:run:tags:describe
+      - run: yarn workspace @cypress/grep cypress:run:tags:config
+      - run: yarn workspace @cypress/grep cypress:run:burn
+      - run: yarn workspace @cypress/grep cypress:run:tags:inherit
+      - run: yarn workspace @cypress/grep cypress:run:multiple-registrations
+      - run: yarn workspace @cypress/grep cypress:run:tags:nested-describe
+      - run: yarn workspace @cypress/grep cypress:run:skip
+      - run: yarn workspace @cypress/grep cypress:run:this
+      - run: yarn workspace @cypress/grep cypress:run:tags
+      - run: yarn workspace @cypress/grep cypress:run:each
+      - run: yarn workspace @cypress/grep cypress:run:grep
+      - run: yarn workspace @cypress/grep cypress:run:tags:or
+      - run: yarn workspace @cypress/grep cypress:run:tags:and
+      - run: yarn workspace @cypress/grep cypress:run:tags:and:not
+      - run: yarn workspace @cypress/grep cypress:run:or
+      - run: yarn workspace @cypress/grep cypress:run:and
+      - run: yarn workspace @cypress/grep cypress:run:and:not
+      - run: yarn workspace @cypress/grep cypress:run:filter:specs
+      - run: yarn workspace @cypress/grep cypress:run:tags:filter:specs
+      - run: yarn workspace @cypress/grep cypress:run:omit:specs
+      - run: yarn workspace @cypress/grep cypress:run:tags:omit:specs
+      - run: yarn workspace @cypress/grep cypress:run:untagged
+      - run: yarn workspace @cypress/grep cypress:run:tag:inverted
+      - run: yarn workspace @cypress/grep cypress:run:inverted
       - run:
-          name: Run tests
-          command: yarn workspace @cypress/grep cy:run
+          name: Run unit tests
+          command: yarn workspace @cypress/grep test
       - sanitize-verify-and-store-mocha-results:
           testResultsPath: npm/grep/test_results
 

.circleci/workflows.yml

@@ -2002,9 +2002,34 @@ jobs:
     resource_class: small
     steps:
       - restore_cached_workspace
-      - run:
-          command: yarn workspace @cypress/grep cy:run
-          name: Run tests
+      - run: yarn workspace @cypress/grep cypress:run:tags:before
+      - run: yarn workspace @cypress/grep cypress:run:tags:describe
+      - run: yarn workspace @cypress/grep cypress:run:tags:config
+      - run: yarn workspace @cypress/grep cypress:run:burn
+      - run: yarn workspace @cypress/grep cypress:run:tags:inherit
+      - run: yarn workspace @cypress/grep cypress:run:multiple-registrations
+      - run: yarn workspace @cypress/grep cypress:run:tags:nested-describe
+      - run: yarn workspace @cypress/grep cypress:run:skip
+      - run: yarn workspace @cypress/grep cypress:run:this
+      - run: yarn workspace @cypress/grep cypress:run:tags
+      - run: yarn workspace @cypress/grep cypress:run:each
+      - run: yarn workspace @cypress/grep cypress:run:grep
+      - run: yarn workspace @cypress/grep cypress:run:tags:or
+      - run: yarn workspace @cypress/grep cypress:run:tags:and
+      - run: yarn workspace @cypress/grep cypress:run:tags:and:not
+      - run: yarn workspace @cypress/grep cypress:run:or
+      - run: yarn workspace @cypress/grep cypress:run:and
+      - run: yarn workspace @cypress/grep cypress:run:and:not
+      - run: yarn workspace @cypress/grep cypress:run:filter:specs
+      - run: yarn workspace @cypress/grep cypress:run:tags:filter:specs
+      - run: yarn workspace @cypress/grep cypress:run:omit:specs
+      - run: yarn workspace @cypress/grep cypress:run:tags:omit:specs
+      - run: yarn workspace @cypress/grep cypress:run:untagged
+      - run: yarn workspace @cypress/grep cypress:run:tag:inverted
+      - run: yarn workspace @cypress/grep cypress:run:inverted
+      - run:
+          command: yarn workspace @cypress/grep test
+          name: Run unit tests
       - sanitize-verify-and-store-mocha-results:
           testResultsPath: npm/grep/test_results
     working_directory: ~/cypress

npm/grep/README.md

@@ -37,15 +37,15 @@ yarn add --dev @cypress/grep
 
 ```js
 // cypress/support/e2e.js
-const registerCypressGrep = require('@cypress/grep')
+const { register: registerCypressGrep } = require('@cypress/grep')
 registerCypressGrep()
 ```
 
 Or using ES modules / TypeScript:
 
 ```ts
 // cypress/support/e2e.ts
-import registerCypressGrep from '@cypress/grep/src/support'
+import { register as registerCypressGrep } from '@cypress/grep'
 registerCypressGrep()
 ```
 
@@ -60,7 +60,24 @@ const { defineConfig } = require('cypress')
 module.exports = defineConfig({
   e2e: {
     setupNodeEvents(on, config) {
-      require('@cypress/grep/src/plugin')(config)
+      const { plugin: cypressGrepPlugin } = require('@cypress/grep/plugin')
+      cypressGrepPlugin(config)
+      return config
+    },
+  },
+})
+```
+
+Or using ES modules / TypeScript:
+
+```ts
+// cypress.config.ts
+import { plugin as cypressGrepPlugin } from '@cypress/grep/plugin'
+
+export default defineConfig({
+  e2e: {
+    setupNodeEvents(on, config) {
+      cypressGrepPlugin(config)
       return config
     },
   },
@@ -227,9 +244,10 @@ npx cypress run --env grepUntagged=true
 ### In cypress.config.js
 
 ```js
-const { defineConfig } = require('cypress')
+import { defineConfig } from 'cypress'
+import { plugin as cypressGrepPlugin } from '@cypress/grep/plugin'
 
-module.exports = defineConfig({
+export default defineConfig({
   env: {
     // Always filter by viewport tests
     grep: "viewport",
@@ -240,7 +258,7 @@ module.exports = defineConfig({
   },
   e2e: {
     setupNodeEvents(on, config) {
-      require('@cypress/grep/src/plugin')(config)
+      cypressGrepPlugin(config)
       return config
     },
   },
@@ -262,6 +280,10 @@ module.exports = defineConfig({
 
 ## TypeScript Support
 
+As of v5 of `@cypress/grep`, TypeScript declaration files are now included.
+These definitions should be automatically detected, but in the case you are using
+an older `moduleResolution` or configuration, some of the below techniques should work.
+
 ### Option 1: Reference types (Recommended)
 
 ```js
@@ -400,16 +422,40 @@ Then refresh and run tests.
 
 ## Migration
 
-### From v1 to v2
+### From v4 to v5
 
-- `--env grep="tag1 tag2"` → `--env grepTags="tag1 tag2"`
-- Title filtering and tag filtering are now separate
+The support file registration and plugin have changed their export signature, meaning:
 
-### From v2 to v3+
+In your support file, change the registration function from
+```js
+const registerCypressGrep = require('@cypress/grep')
+```
+
+to the following
+```js
+const { register: registerCypressGrep } = require('@cypress/grep')
+```
+
+Additionally, in your support file, change the plugin registration from
+```js
+const cypressGrepPlugin = require('@cypress/grep/src/plugin')
+```
+
+to the following
+```js
+const { plugin: cypressGrepPlugin } = require('@cypress/grep/plugin')
+```
+
+### From v2 to v3/v4
 
 - Requires Cypress 10.0.0+
 - No breaking changes in functionality
 
+### From v1 to v2
+
+- `--env grep="tag1 tag2"` → `--env grepTags="tag1 tag2"`
+- Title filtering and tag filtering are now separate
+
 ## Support
 
 - **Documentation**: [Cypress Docs](https://docs.cypress.io)

npm/grep/cypress.config.js renamed to npm/grep/cypress.config.ts

@@ -1,7 +1,7 @@
-const { defineConfig } = require('cypress')
-const cypressGrepPlugin = require('./src/plugin')
+import { defineConfig } from 'cypress'
+import { plugin as cypressGrepPlugin } from './src/plugin'
 
-module.exports = defineConfig({
+export default defineConfig({
   e2e: {
     defaultCommandTimeout: 1000,
     setupNodeEvents (on, config) {
@@ -15,7 +15,6 @@ module.exports = defineConfig({
 
       return config
     },
-    specPattern: '**/spec.js',
   },
   fixturesFolder: false,
 })

npm/grep/cypress/e2e/before-spec.js renamed to npm/grep/cypress/e2e/before.cy.ts

@@ -1,5 +1,3 @@
-/// <reference types="cypress" />
-
 // if we specify just the burn parameter
 // then this test will be repeated N times
 describe('burning a test N times', () => {

npm/grep/cypress/e2e/burn-spec.js renamed to npm/grep/cypress/e2e/burn.cy.ts

@@ -1,5 +1,3 @@
-// @ts-check
-/// <reference path="../../src/index.d.ts" />
 describe('tags in the config object', () => {
   it('works as an array', { tags: ['config', 'some-other-tag'] }, () => {
     expect(true).to.be.true

npm/grep/cypress/e2e/config-tags-spec.js renamed to npm/grep/cypress/e2e/config-tags.cy.ts

@@ -1,5 +1,3 @@
-// @ts-check
-/// <reference types="cypress" />
 describe('tests that use config object', () => {
   it('still works @config', { baseUrl: 'http://localhost:8000' }, () => {
     expect(Cypress.config('baseUrl')).to.equal('http://localhost:8000')

npm/grep/cypress/e2e/config-spec.js renamed to npm/grep/cypress/e2e/config.cy.ts

@@ -1,7 +1,3 @@
-/// <reference path="../../src/index.d.ts" />
-
-// @ts-check
-
 describe('block with no tags', () => {
   it('inside describe 1', () => {})
 

npm/grep/cypress/e2e/describe-tags-spec.js renamed to npm/grep/cypress/e2e/describe-tags.cy.ts

@@ -1,5 +1,3 @@
-/// <reference types="cypress" />
-
 // https://github.com/bahmutov/cypress-each
 import 'cypress-each'