chore: convert @packages/scaffold-config tests from mocha to vitest (#32568)

* chore: start vitest conversion and convertsupportFile to vitest

* chore: convert frameworks spec to vitest

* chore: convert detect spec to vitest

* chore: convert ct-detect-third-party spec to vitest

* chore: convert component index template to vitest

* chore: clean up scaffold-config as tests are now converted to vitest

* fix issue where projectRoot was passed inncorrectly in test

Author: AtofStryker

.circleci/src/workflows/@workflows.yml

@@ -1784,7 +1784,7 @@ jobs:
                   source ./scripts/ensure-node.sh
                   yarn lerna run types
             - sanitize-verify-and-store-mocha-results:
-                expectedResultCount: 15
+                expectedResultCount: 14
 
   verify-release-readiness:
     <<: *defaults

.circleci/workflows.yml

@@ -3486,7 +3486,7 @@ jobs:
                   yarn lerna run types
                 name: Test types
             - sanitize-verify-and-store-mocha-results:
-                expectedResultCount: 15
+                expectedResultCount: 14
     working_directory: ~/cypress
   v8-integration-tests:
     environment:

guides/esm-migration.md

@@ -102,7 +102,7 @@
 - [ ] packages/packherd-require
 - [ ] packages/proxy
 - [ ] packages/rewriter
-- [ ] packages/scaffold-config
+- [x] packages/scaffold-config ✅ **COMPLETED**
 - [ ] packages/server
 - [ ] packages/socket
 - [x] packages/stderr-filtering ✅ **COMPLETED**

packages/scaffold-config/package.json

@@ -10,8 +10,8 @@
     "clean": "rimraf --glob './src/*.js' './src/**/*.js' './src/**/**/*.js' './test/**/*.js' || echo 'cleaned'",
     "clean-deps": "rimraf node_modules",
     "lint": "eslint --ext .js,.jsx,.ts,.tsx,.json, .",
-    "test": "yarn test-unit",
-    "test-unit": "mocha -r @packages/ts/register 'test/unit/**' --config ./test/.mocharc.js --exit --reporter mocha-multi-reporters --reporter-options configFile=../../mocha-reporter-config.json",
+    "test": "vitest run",
+    "test-debug": "npx vitest --inspect-brk --no-file-parallelism --test-timeout=0",
     "tslint": "tslint --config ../ts/tslint.json --project ."
   },
   "dependencies": {
@@ -28,8 +28,7 @@
   "devDependencies": {
     "@packages/ts": "0.0.0-development",
     "@packages/types": "0.0.0-development",
-    "chai": "4.2.0",
-    "mocha": "7.0.1"
+    "vitest": "^3.2.4"
   },
   "files": [
     "src"

packages/scaffold-config/src/detect.ts

@@ -171,6 +171,15 @@ export function detectLanguage ({ projectRoot, customConfigFile, pkgJson }: Dete
   try {
     const typescriptFile = require.resolve('typescript', { paths: [projectRoot] })
 
+    // sometimes require.resolve returns a path that does not exist but is cached by require.resolve()
+    const exists = fs.existsSync(typescriptFile)
+
+    if (!exists) {
+      debug('Resolved typescript from %s does not exist', typescriptFile)
+
+      return 'js'
+    }
+
     debug('Resolved typescript from %s', typescriptFile)
   } catch {
     debug('No typescript installed - using js')

packages/scaffold-config/test/.mocharc.js

@@ -1,7 +1,7 @@
-import { expect } from 'chai'
+import { describe, it, expect } from 'vitest'
 import dedent from 'dedent'
-import componentIndexHtmlGenerator from '../../src/component-index-template'
-import { CT_FRAMEWORKS } from '../../src/frameworks'
+import componentIndexHtmlGenerator from '../src/component-index-template'
+import { CT_FRAMEWORKS } from '../src/frameworks'
 
 describe('componentIndexHtmlGenerator', () => {
   it('strips spaces and newlines appropriately', () => {
@@ -21,7 +21,7 @@ describe('componentIndexHtmlGenerator', () => {
       </body>
     </html>`
 
-    expect(generator()).to.eq(expected)
+    expect(generator()).toEqual(expected)
   })
 
   it('handles header modifier', () => {
@@ -42,7 +42,7 @@ describe('componentIndexHtmlGenerator', () => {
       </body>
     </html>`
 
-    expect(generator()).to.eq(expected)
+    expect(generator()).toEqual(expected)
   })
 
   it('generates correct template for Next.js', () => {
@@ -66,6 +66,6 @@ describe('componentIndexHtmlGenerator', () => {
       </body>
     </html>`
 
-    expect(actual).to.eq(expected)
+    expect(actual).toEqual(expected)
   })
 })

packages/scaffold-config/test/unit/component-index-template.spec.ts renamed to packages/scaffold-config/test/component-index-template.spec.ts

@@ -1,8 +1,8 @@
-import { scaffoldMigrationProject, fakeDepsInNodeModules } from './detect.spec'
+import { describe, it, expect, beforeEach, afterEach } from 'vitest'
+import { scaffoldMigrationProject, fakeDepsInNodeModules } from './scaffolding'
 import fs from 'fs-extra'
 import path from 'path'
-import { detectThirdPartyCTFrameworks, validateThirdPartyModule, isThirdPartyDefinition, isRepositoryRoot } from '../../src'
-import { expect } from 'chai'
+import { detectThirdPartyCTFrameworks, validateThirdPartyModule, isThirdPartyDefinition, isRepositoryRoot } from '../src'
 import os from 'os'
 import solidJs from './fixtures'
 
@@ -25,31 +25,31 @@ async function scaffoldQwikApp (thirdPartyModuleNames: Array<'cypress-ct-qwik' |
 }
 
 describe('isThirdPartyDefinition', () => {
-  context('global package', () => {
+  describe('global package', () => {
     it('returns false for invalid prefix', () => {
       const res = isThirdPartyDefinition({ ...solidJs, type: 'non-cypress-ct' })
 
-      expect(res).to.be.false
+      expect(res).toBe(false)
     })
 
     it('returns true for valid prefix', () => {
       const res = isThirdPartyDefinition({ ...solidJs, type: 'cypress-ct-solid-js' })
 
-      expect(res).to.be.true
+      expect(res).toBe(true)
     })
   })
 
-  context('namespaced package', () => {
+  describe('namespaced package', () => {
     it('returns false for non third party with namespace', () => {
       const res = isThirdPartyDefinition({ ...solidJs, type: '@org/non-cypress-ct' })
 
-      expect(res).to.be.false
+      expect(res).toBe(false)
     })
 
     it('returns true for third party with namespace', () => {
       const res = isThirdPartyDefinition({ ...solidJs, type: '@org/cypress-ct-solid-js' })
 
-      expect(res).to.be.true
+      expect(res).toBe(true)
     })
   })
 })
@@ -68,15 +68,15 @@ describe('isRepositoryRoot', () => {
   it('returns false if there is nothing in the directory', async () => {
     const isCurrentRepositoryRoot = await isRepositoryRoot(TEMP_DIR)
 
-    expect(isCurrentRepositoryRoot).to.be.false
+    expect(isCurrentRepositoryRoot).toBe(false)
   })
 
   it('returns true if there is a Git directory', async () => {
     await fs.mkdir(path.join(TEMP_DIR, '.git'))
 
     const isCurrentRepositoryRoot = await isRepositoryRoot(TEMP_DIR)
 
-    expect(isCurrentRepositoryRoot).to.be.true
+    expect(isCurrentRepositoryRoot).toBe(true)
   })
 
   it('returns false if there is a package.json without workspaces field', async () => {
@@ -91,7 +91,7 @@ describe('isRepositoryRoot', () => {
 
     const isCurrentRepositoryRoot = await isRepositoryRoot(TEMP_DIR)
 
-    expect(isCurrentRepositoryRoot).to.be.false
+    expect(isCurrentRepositoryRoot).toBe(false)
   })
 
   it('returns true if there is a package.json with workspaces field', async () => {
@@ -109,7 +109,7 @@ describe('isRepositoryRoot', () => {
 
     const isCurrentRepositoryRoot = await isRepositoryRoot(TEMP_DIR)
 
-    expect(isCurrentRepositoryRoot).to.be.true
+    expect(isCurrentRepositoryRoot).toBe(true)
   })
 })
 
@@ -119,24 +119,24 @@ describe('detectThirdPartyCTFrameworks', () => {
 
     const thirdPartyFrameworks = await detectThirdPartyCTFrameworks(projectRoot)
 
-    expect(thirdPartyFrameworks.frameworks[0].type).eq('cypress-ct-qwik')
+    expect(thirdPartyFrameworks.frameworks[0].type).toEqual('cypress-ct-qwik')
   })
 
   it('detects third party frameworks in org namespace', async () => {
     const projectRoot = await scaffoldQwikApp(['@org/cypress-ct-qwik'])
 
     const thirdPartyFrameworks = await detectThirdPartyCTFrameworks(projectRoot)
 
-    expect(thirdPartyFrameworks.frameworks[0].type).eq('@org/cypress-ct-qwik')
+    expect(thirdPartyFrameworks.frameworks[0].type).toEqual('@org/cypress-ct-qwik')
   })
 
   it('ignores misconfigured third party frameworks', async () => {
     const projectRoot = await scaffoldQwikApp(['cypress-ct-qwik', 'misconfigured-cypress-ct-qwik'])
 
     const thirdPartyFrameworks = await detectThirdPartyCTFrameworks(projectRoot)
 
-    expect(thirdPartyFrameworks.frameworks.length).eq(1)
-    expect(thirdPartyFrameworks.frameworks[0].type).eq('cypress-ct-qwik')
+    expect(thirdPartyFrameworks.frameworks.length).toEqual(1)
+    expect(thirdPartyFrameworks.frameworks[0].type).toEqual('cypress-ct-qwik')
   })
 
   it('detects third party frameworks in monorepos with hoisted dependencies', async () => {
@@ -150,19 +150,19 @@ describe('detectThirdPartyCTFrameworks', () => {
     // Look for third-party modules in packages/foo (where Cypress was launched from)
     const thirdPartyFrameworks = await detectThirdPartyCTFrameworks(projectRoot)
 
-    expect(thirdPartyFrameworks.frameworks[0].type).eq('cypress-ct-qwik')
+    expect(thirdPartyFrameworks.frameworks[0].type).toEqual('cypress-ct-qwik')
   })
 
   it('validates third party module', () => {
-    expect(() => validateThirdPartyModule(solidJs)).to.not.throw()
+    expect(() => validateThirdPartyModule(solidJs)).not.toThrow()
 
     const gen = (m: any) => m
 
-    expect(() => validateThirdPartyModule(gen({ ...solidJs, type: 'misconfigured' }))).to.throw()
+    expect(() => validateThirdPartyModule(gen({ ...solidJs, type: 'misconfigured' }))).toThrow()
     expect(() => validateThirdPartyModule(gen({ ...solidJs, name: 5 }))).to.throw()
-    expect(() => validateThirdPartyModule(gen({ ...solidJs, supportedBundlers: ['random'] }))).to.throw()
-    expect(() => validateThirdPartyModule(gen({ ...solidJs, detectors: {} }))).to.throw()
-    expect(() => validateThirdPartyModule(gen({ ...solidJs, dependencies: {} }))).to.throw()
-    expect(() => validateThirdPartyModule(gen({ ...solidJs, componentIndexHtml: {} }))).to.throw()
+    expect(() => validateThirdPartyModule(gen({ ...solidJs, supportedBundlers: ['random'] }))).toThrow()
+    expect(() => validateThirdPartyModule(gen({ ...solidJs, detectors: {} }))).toThrow()
+    expect(() => validateThirdPartyModule(gen({ ...solidJs, dependencies: {} }))).toThrow()
+    expect(() => validateThirdPartyModule(gen({ ...solidJs, componentIndexHtml: {} }))).toThrow()
   })
 })