@cypress/grep cannot find module cypress-grep or it's corresponding type declarations

Current behavior

Support file, Config file, and the tsconfig file installation instructions are incorrect.

Module names and paths are incorrect.

Support file: I am getting a could not find a declaration file for module @cypress/grep/src/support as that’s what I have at the moment. Following the readme, the error is Cannot find module ‘cypress-grep’. Additionally, the function appears to be cypressGrep and not registerCypressGrep.

Config file registration: require('@cypress/grep/src/plugin')(config)

tsconfig.json: the types array addition should be "@cypress/grep"

I am probably missing something.

Desired behavior

I am able to install the package, follow the configuration instructions, grepping specs works.

Test code to reproduce

n/a

Cypress Version

10.10.0

Node version

16.17.1

Operating System

Windows 10

Debug Logs

No response

Other

No response

[cypress-bot[bot]]

The code for this is done in cypress-io/cypress#24844, but has yet to be released. We’ll update this issue and reference the changelog when it’s released.

[samtsai]

Note if you’re on Cypress 11, you’ll need to update TestConfigOverrides to SuiteConfigOverrides (unless that’s been updated in main/develop)

/// <reference types="cypress" />
declare namespace Cypress {
  // specify additional properties in the TestConfig object
  // in our case we will add "tags" property
  interface SuiteConfigOverrides {
    /**
     * 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
  }
}