feat: validate specPattern root level

npm/design-system/cypress.config.js

@@ -6,12 +6,12 @@ module.exports = {
   env: {
     reactDevtools: true,
   },
-  ignoreSpecPattern: [
-    '**/__snapshots__/*',
-    '**/__image_snapshots__/*',
-  ],
   fixturesFolder: false,
   component: {
+    ignoreSpecPattern: [
+      '**/__snapshots__/*',
+      '**/__image_snapshots__/*',
+    ],
     devServer (cypressConfig) {
       const { startDevServer } = require('@cypress/vite-dev-server')
 

npm/react/cypress.config.js

@@ -8,13 +8,13 @@ module.exports = {
   'env': {
     'reactDevtools': true,
   },
-  'ignoreSpecPattern': [
-    '**/__snapshots__/*',
-    '**/__image_snapshots__/*',
-  ],
   'experimentalFetchPolyfill': true,
   'component': {
-    ignoreSpecPattern: 'examples/**/*',
+    'ignoreSpecPattern': [
+      '**/__snapshots__/*',
+      '**/__image_snapshots__/*',
+      'examples/**/*',
+    ],
     devServer (cypressConfig, devServerConfig) {
       const { startDevServer } = require('@cypress/webpack-dev-server')
       const path = require('path')

npm/react/examples/snapshots/cypress.config.js

@@ -3,16 +3,16 @@ module.exports = {
   'fixturesFolder': false,
   'viewportWidth': 500,
   'viewportHeight': 500,
-  'ignoreSpecPattern': [
-    '**/__snapshots__/*',
-    '**/__image_snapshots__/*',
-  ],
   'env': {
     'cypress-plugin-snapshots': {
       'prettier': true,
     },
   },
   'component': {
+    'ignoreSpecPattern': [
+      '**/__snapshots__/*',
+      '**/__image_snapshots__/*',
+    ],
     setupNodeEvents (on, config) {
       // load file devServer that comes with this plugin
       // https://github.com/bahmutov/cypress-react-unit-test#install

packages/config/lib/options.ts

@@ -540,4 +540,14 @@ export const breakingRootOptions: Array<BreakingOption> = [
     errorKey: 'SUPPORT_FILE_ROOT_NOT_SUPPORTED',
     isWarning: false,
   },
+  {
+    name: 'specPattern',
+    errorKey: 'SPEC_PATTERN_ROOT_NOT_SUPPORTED',
+    isWarning: false,
+  },
+  {
+    name: 'ignoreSpecPattern',
+    errorKey: 'IGNORE_SPEC_PATTERN_ROOT_NOT_SUPPORTED',
+    isWarning: false,
+  },
 ]

packages/data-context/test/unit/sources/ProjectDataSource.spec.ts

@@ -1,5 +1,11 @@
 import { expect } from 'chai'
-import { matchedSpecs, transformSpec, SpecWithRelativeRoot } from '../../../src/sources'
+import { matchedSpecs, transformSpec, SpecWithRelativeRoot, BrowserApiShape } from '../../../src/sources'
+import path from 'path'
+import { DataContext } from '../../../src'
+import { graphqlSchema } from '@packages/graphql/src/schema'
+import { AppApiShape, AuthApiShape, ElectronApiShape, LocalSettingsApiShape, ProjectApiShape } from '../../../src/actions'
+import { ErrorApiShape } from '../../../src/DataContext'
+import { InjectedConfigApi } from '../../../src/data'
 
 describe('matchedSpecs', () => {
   context('got a single spec pattern from --spec via cli', () => {
@@ -114,3 +120,60 @@ describe('transformSpec', () => {
     expect(result).to.eql(actual)
   })
 })
+
+describe('findSpecs', () => {
+  const temporary = 'tmp'
+
+  const fixture = [
+    'component/App.spec.ts',
+    'component/App.cy.ts',
+    'component/App.cy.js',
+    'e2e/onboarding.spec.ts',
+    'e2e/onboarding.cy.ts',
+    'e2e/onboarding.cy.js',
+  ]
+
+  let ctx: DataContext
+
+  beforeEach(async () => {
+    ctx = new DataContext({
+      schema: graphqlSchema,
+      mode: 'run',
+      modeOptions: {},
+      appApi: {} as AppApiShape,
+      localSettingsApi: {} as LocalSettingsApiShape,
+      authApi: {} as AuthApiShape,
+      errorApi: {} as ErrorApiShape,
+      configApi: {
+        getServerPluginHandlers: () => [],
+      } as InjectedConfigApi,
+      projectApi: {} as ProjectApiShape,
+      electronApi: {} as ElectronApiShape,
+      browserApi: {} as BrowserApiShape,
+    })
+
+    await Promise.all(fixture.map((element) => ctx.fs.outputFile(path.join(temporary, element), '')))
+  })
+
+  afterEach(async () => {
+    await ctx.fs.remove(temporary)
+  })
+
+  it('find all the *.cy.{ts,js} excluding the e2e', async () => {
+    const specs = await ctx.project.findSpecs(temporary, 'component', ['**/*.cy.{ts,js}'], ['e2e/*.{spec,cy}.{ts,js}'], [])
+
+    expect(specs).to.have.length(2)
+  })
+
+  it('find all the *.{cy,spec}.{ts,js} excluding the e2e', async () => {
+    const specs = await ctx.project.findSpecs(temporary, 'component', ['**/*.{cy,spec}.{ts,js}'], ['e2e/*.{spec,cy}.{ts,js}'], [])
+
+    expect(specs).to.have.length(3)
+  })
+
+  it('find all the e2e specs', async () => {
+    const specs = await ctx.project.findSpecs(temporary, 'e2e', ['e2e/*.{cy,spec}.{ts,js}'], [], [])
+
+    expect(specs).to.have.length(3)
+  })
+})

packages/server/lib/errors.js

@@ -1063,6 +1063,16 @@ const getMsgByType = function (type, ...args) {
       return stripIndent`\
         The ${chalk.yellow(`\`supportFile\``)} configuration option was removed from the root in Cypress version \`10.0.0\`. Please update this option under each testing type property.
 
+        https://on.cypress.io/migration-guide`
+    case 'SPEC_PATTERN_ROOT_NOT_SUPPORTED':
+      return stripIndent`\
+        The ${chalk.yellow(`\`specPattern\``)} configuration option was removed from the root in Cypress version \`10.0.0\`. Please update this option under each testing type property.
+
+        https://on.cypress.io/migration-guide`
+    case 'IGNORE_SPEC_PATTERN_ROOT_NOT_SUPPORTED':
+      return stripIndent`\
+        The ${chalk.yellow(`\`ignoreSpecPattern\``)} configuration option was removed from the root in Cypress version \`10.0.0\`. Please update this option under each testing type property.
+
         https://on.cypress.io/migration-guide`
     default:
   }

packages/server/test/integration/cypress_spec.js

@@ -1655,9 +1655,9 @@ describe('lib/cypress', () => {
         // this should be overriden by the env argument
         json.baseUrl = 'http://localhost:8080'
 
-        const { supportFile, ...rest } = json
+        const { supportFile, specPattern, ignoreSpecPattern, ...rest } = json
 
-        return settings.writeForTesting(this.todosPath, rest)
+        return settings.writeForTesting(this.todosPath, { ...rest, e2e: { supportFile, specPattern, ignoreSpecPattern } })
       }).then(() => {
         return cypress.start([
           '--port=2121',

packages/server/test/unit/config_spec.js

@@ -395,25 +395,25 @@ describe('lib/config', () => {
 
       context('ignoreSpecPattern', () => {
         it('passes if a string', function () {
-          this.setup({ ignoreSpecPattern: '*.jsx' })
+          this.setup({ e2e: { ignoreSpecPattern: '*.jsx', supportFile: false } })
 
           return this.expectValidationPasses()
         })
 
         it('passes if an array of strings', function () {
-          this.setup({ ignoreSpecPattern: ['*.jsx'] })
+          this.setup({ e2e: { ignoreSpecPattern: ['*.jsx'], supportFile: false } })
 
           return this.expectValidationPasses()
         })
 
         it('fails if not a string or array', function () {
-          this.setup({ ignoreSpecPattern: 5 })
+          this.setup({ e2e: { ignoreSpecPattern: 5 } })
 
           return this.expectValidationFails('be a string or an array of strings')
         })
 
         it('fails if not an array of strings', function () {
-          this.setup({ ignoreSpecPattern: [5] })
+          this.setup({ e2e: { ignoreSpecPattern: [5] } })
           this.expectValidationFails('be a string or an array of strings')
 
           return this.expectValidationFails('the value was: `[5]`')

system-tests/__snapshots__/config_spec.js

@@ -181,4 +181,25 @@ There is both a \`cypress.config.js\` and a cypress.json file at the location be
 Cypress no longer supports 'cypress.json' config, please remove it from your project.
 
 
+`
+
+exports['e2e config throws an error if supportFile is set on the root level 1'] = `
+The \`supportFile\` configuration option was removed from the root in Cypress version \`10.0.0\`. Please update this option under each testing type property.
+
+https://on.cypress.io/migration-guide
+
+`
+
+exports['e2e config throws an error if specPattern is set on the root level 1'] = `
+The \`specPattern\` configuration option was removed from the root in Cypress version \`10.0.0\`. Please update this option under each testing type property.
+
+https://on.cypress.io/migration-guide
+
+`
+
+exports['e2e config throws an error if ignoreSpecPattern is set on the root level 1'] = `
+The \`ignoreSpecPattern\` configuration option was removed from the root in Cypress version \`10.0.0\`. Please update this option under each testing type property.
+
+https://on.cypress.io/migration-guide
+
 `

system-tests/projects/invalid-root-level-config/invalid-ignoreSpecPattern.config.js

@@ -0,0 +1,4 @@
+module.exports = {
+  ignoreSpecPattern: 'src/**/*.cy.js',
+  e2e: {},
+}

system-tests/projects/invalid-root-level-config/invalid-specPattern.config.js

@@ -0,0 +1,4 @@
+module.exports = {
+  specPattern: 'src/**/*.cy.js',
+  e2e: {},
+}

system-tests/projects/invalid-root-level-config/invalid-supportFile.config.js

@@ -0,0 +1,4 @@
+module.exports = {
+  supportFile: 'cypress/support/e2e.js',
+  e2e: {},
+}

system-tests/test/config_spec.js

@@ -112,4 +112,40 @@ describe('e2e config', () => {
       snapshot: true,
     })
   })
+
+  it('throws an error if supportFile is set on the root level', function () {
+    Fixtures.scaffoldProject('invalid-root-level-config')
+    Fixtures.projectPath('invalid-root-level-config')
+
+    return systemTests.exec(this, {
+      project: 'invalid-root-level-config',
+      configFile: 'invalid-supportFile.config.js',
+      expectedExitCode: 1,
+      snapshot: true,
+    })
+  })
+
+  it('throws an error if specPattern is set on the root level', function () {
+    Fixtures.scaffoldProject('invalid-root-level-config')
+    Fixtures.projectPath('invalid-root-level-config')
+
+    return systemTests.exec(this, {
+      project: 'invalid-root-level-config',
+      configFile: 'invalid-specPattern.config.js',
+      expectedExitCode: 1,
+      snapshot: true,
+    })
+  })
+
+  it('throws an error if ignoreSpecPattern is set on the root level', function () {
+    Fixtures.scaffoldProject('invalid-root-level-config')
+    Fixtures.projectPath('invalid-root-level-config')
+
+    return systemTests.exec(this, {
+      project: 'invalid-root-level-config',
+      configFile: 'invalid-ignoreSpecPattern.config.js',
+      expectedExitCode: 1,
+      snapshot: true,
+    })
+  })
 })