feat: use type=module in generated projects

For Cypress with Typescript, we needed to add a `module` option to the root tsconfig (see cypress-io/cypress#24111).

Author: cexbrayat

index.ts

@@ -447,17 +447,20 @@ async function init() {
 
   if (needsTypeScript) {
     // Convert the JavaScript template to the TypeScript
-    // Check all the remaining `.js` files:
-    //   - If the corresponding TypeScript version already exists, remove the `.js` version.
-    //   - Otherwise, rename the `.js` file to `.ts`
+    // Check all the remaining `.js`/`.cjs` files:
+    //   - If the corresponding TypeScript version already exists, remove the `.js`/`.cjs` version.
+    //   - Otherwise, rename the `.js`/`.cjs` file to `.ts`
     // Remove `jsconfig.json`, because we already have tsconfig.json
     // `jsconfig.json` is not reused, because we use solution-style `tsconfig`s, which are much more complicated.
     preOrderDirectoryTraverse(
       root,
       () => {},
       (filepath) => {
-        if (filepath.endsWith('.js') && !FILES_TO_FILTER.includes(path.basename(filepath))) {
-          const tsFilePath = filepath.replace(/\.js$/, '.ts')
+        if (
+          (filepath.endsWith('.js') || filepath.endsWith('.cjs')) &&
+          !FILES_TO_FILTER.includes(path.basename(filepath))
+        ) {
+          const tsFilePath = filepath.replace(/\.c?js$/, '.ts')
           if (fs.existsSync(tsFilePath)) {
             fs.unlinkSync(filepath)
           } else {

pnpm-lock.yaml

@@ -1,5 +1,6 @@
 {
   "private": true,
+  "type": "module",
   "scripts": {
     "dev": "vite",
     "build": "vite build",

template/base/package.json

@@ -4,11 +4,12 @@
   },
   "devDependencies": {
     "nightwatch": "^3.3.2",
-    "@nightwatch/vue": "0.4.5",
+    "@nightwatch/vue": "^0.4.5",
     "@vitejs/plugin-vue": "^4.5.0",
     "@types/nightwatch": "^2.3.28",
     "geckodriver": "^4.2.1",
     "chromedriver": "^119.0.0",
-    "ts-node": "^10.9.1"
+    "ts-node": "^10.9.1",
+    "vite-plugin-nightwatch": "^0.4.5"
   }
 }

template/config/cypress-ct/cypress.config.js renamed to template/config/cypress-ct/cypress.config.cjs

@@ -1,4 +1,4 @@
-const { test, expect } = require('@playwright/test');
+import { test, expect } from '@playwright/test';
 
 // See here how to get started:
 // https://playwright.dev/docs/intro

template/config/cypress/cypress.config.js renamed to template/config/cypress/cypress.config.cjs

@@ -1,5 +1,8 @@
 {
   "files": [],
+  "compilerOptions": {
+    "module": "es2015"
+  },
   "references": [
     {
       "path": "./tsconfig.node.json"

template/config/nightwatch/nightwatch.conf.js renamed to template/config/nightwatch/nightwatch.conf.cjs

@@ -1,5 +1,8 @@
 {
   "files": [],
+  "compilerOptions": {
+    "module": "es2015"
+  },
   "references": [
     {
       "path": "./tsconfig.node.json"

template/config/nightwatch/nightwatch/custom-assertions/elementHasCount.js renamed to template/config/nightwatch/nightwatch/custom-assertions/elementHasCount.cjs

@@ -1,5 +1 @@
-export const FILES_TO_FILTER = [
-  'nightwatch.e2e.conf.js',
-  'nightwatch.component.conf.js',
-  'globals.js'
-]
+export const FILES_TO_FILTER = []