misc: convert @cypress/webpack-batteries-included-preprocessor tests to vitest

Author: AtofStryker

guides/esm-migration.md

@@ -88,7 +88,7 @@ When migrating some of these projects away from the `ts-node` entry [see `@packa
 - [x] npm/grep ✅ **COMPLETED** 
 - [x] npm/puppeteer ✅ **COMPLETED** 
 - [x] npm/vite-dev-server ✅ **COMPLETED** 
-- [ ] npm/webpack-batteries-included-preprocessor
+- [x] npm/webpack-batteries-included-preprocessor ✅ **COMPLETED** 
 - [x] npm/webpack-dev-server ✅ **COMPLETED** 
 - [x] npm/webpack-preprocessor ✅ **COMPLETED**
 

npm/webpack-batteries-included-preprocessor/eslint.config.ts

@@ -9,6 +9,9 @@ export default [
   {
     files: ['**/*.js', '**/*.ts'],
     languageOptions: {
+      parserOptions: {
+        tsconfigRootDir: __dirname,
+      },
       globals: {
         ...globals.node,
       },

npm/webpack-batteries-included-preprocessor/index.ts

@@ -278,7 +278,7 @@ preprocessor.defaultOptions = {
   watchOptions: {},
 }
 
-preprocessor.getFullWebpackOptions = (filePath: string, typescript: string | boolean) => {
+preprocessor.getFullWebpackOptions = (filePath: string, typescript?: string | boolean) => {
   const webpackOptions = getDefaultWebpackOptions()
 
   if (typescript) {

npm/webpack-batteries-included-preprocessor/package.json

@@ -3,13 +3,15 @@
   "version": "0.0.0-development",
   "description": "Cypress preprocessor for bundling JavaScript via webpack with dependencies included and support for various ES features, TypeScript, and CoffeeScript",
   "private": false,
-  "main": "index.js",
-  "types": "index.d.ts",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "scripts": {
     "build": "tsc || echo 'built, with errors'",
     "check-ts": "tsc --noEmit",
     "lint": "eslint",
-    "test": "yarn build && mocha test/**/*.spec.* --timeout 4000"
+    "test": "vitest run",
+    "test-debug": "vitest --inspect-brk --no-file-parallelism --test-timeout=0"
+
   },
   "dependencies": {
     "@babel/core": "^7.28.0",
@@ -40,16 +42,12 @@
     "@packages/eslint-config": "0.0.0-development",
     "@types/mocha": "^8.0.2",
     "@types/webpack": "^5.28.1",
-    "chai": "^4.2.0",
-    "decache": "^4.6.2",
     "eslint": "^9.31.0",
     "globals": "^15.12.0",
     "jiti": "^2.4.2",
-    "mocha": "^8.1.1",
-    "mock-require": "3.0.3",
     "react": "^16.13.1",
-    "sinon": "18.0.0",
-    "typescript": "~5.4.5"
+    "typescript": "~5.4.5",
+    "vitest": "^3.2.4"
   },
   "peerDependencies": {
     "@cypress/webpack-preprocessor": "^6.0.4"

npm/webpack-batteries-included-preprocessor/test/e2e/features.spec.js renamed to npm/webpack-batteries-included-preprocessor/test/e2e/features.spec.ts

@@ -1,14 +1,13 @@
-const EventEmitter = require('events').EventEmitter
-const { expect } = require('chai')
-const fs = require('fs-extra')
-const path = require('path')
-
-const preprocessor = require('../../index')
+import { describe, it, beforeEach, expect } from 'vitest'
+import { EventEmitter } from 'events'
+import fs from 'fs-extra'
+import path from 'path'
+import preprocessor from '../../dist/index'
 
 const fixturesDir = path.join(__dirname, '..', 'fixtures')
 const outputDir = path.join(__dirname, '..', '_test-output')
 
-const run = (fileName, options) => {
+const run = (fileName: string, options?: any) => {
   const file = Object.assign(new EventEmitter(), {
     filePath: path.join(outputDir, fileName),
     outputPath: path.join(outputDir, fileName.replace('.', '_output.')),
@@ -17,7 +16,7 @@ const run = (fileName, options) => {
   return preprocessor(options)(file)
 }
 
-const runAndEval = async (fileName, options) => {
+const runAndEval = async (fileName: string, options?: any) => {
   const outputPath = await run(fileName, options)
   const contents = await fs.readFile(outputPath)
 
@@ -64,14 +63,15 @@ describe('webpack-batteries-included-preprocessor features', () => {
     const outputPath = await run('es_features_spec.js')
     const contents = await fs.readFile(outputPath)
 
-    expect(contents.toString()).to.include('//# sourceMappingURL=data:application/json;charset=utf-8;base64')
+    expect(contents.toString()).toContain('//# sourceMappingURL=data:application/json;charset=utf-8;base64')
   })
 
   describe('with typescript option set', () => {
     const shouldntResolve = () => {
       throw new Error('Should error, should not resolve')
     }
 
+    // TODO: will need to use the module API in the future to replace this
     const options = { typescript: require.resolve('typescript') }
 
     it('handles typescript (and tsconfig paths)', async () => {
@@ -105,22 +105,24 @@ describe('webpack-batteries-included-preprocessor features', () => {
       await runAndEval('tsx_spec.tsx', { ...options, ...preprocessor.defaultOptions })
     })
 
-    it('errors when processing .ts file and typescript option is not set', () => {
-      return run('ts_spec.ts')
-      .then(shouldntResolve)
-      .catch((err) => {
-        expect(err.message).to.include(`You are attempting to run a TypeScript file, but do not have TypeScript installed. Ensure you have 'typescript' installed to enable TypeScript support`)
-        expect(err.message).to.include('ts_spec.ts')
-      })
+    it('errors when processing .ts file and typescript option is not set', async () => {
+      try {
+        await run('ts_spec.ts')
+        shouldntResolve()
+      } catch (err) {
+        expect(err.message).toContain('You are attempting to run a TypeScript file, but do not have TypeScript installed. Ensure you have \'typescript\' installed to enable TypeScript support')
+        expect(err.message).toContain('ts_spec.ts')
+      }
     })
 
-    it('errors when processing .tsx file and typescript option is not set', () => {
-      return run('tsx_spec.tsx')
-      .then(shouldntResolve)
-      .catch((err) => {
-        expect(err.message).to.include(`You are attempting to run a TypeScript file, but do not have TypeScript installed. Ensure you have 'typescript' installed to enable TypeScript support`)
-        expect(err.message).to.include('tsx_spec.tsx')
-      })
+    it('errors when processing .tsx file and typescript option is not set', async () => {
+      try {
+        await run('tsx_spec.tsx')
+        shouldntResolve()
+      } catch (err) {
+        expect(err.message).toContain('You are attempting to run a TypeScript file, but do not have TypeScript installed. Ensure you have \'typescript\' installed to enable TypeScript support')
+        expect(err.message).toContain('tsx_spec.tsx')
+      }
     })
   })
 })