feat: remove preload.js from TypeScript templates (#2938)

* fix: Remove preload.js files from TypeScript templates

* test: Add/update tests for ensuring js files are cleaned up from TypeScript templates

* chore: Apply prettier formatting and lints

* fix: add missing devDependencies to templates

packages/template/typescript-webpack/package.json

@@ -20,6 +20,8 @@
     "fs-extra": "^10.0.0"
   },
   "devDependencies": {
-    "@electron-forge/test-utils": "6.0.0-beta.66"
+    "@electron-forge/test-utils": "6.0.0-beta.66",
+    "chai": "^4.3.3",
+    "fast-glob": "^3.2.7"
   }
 }

packages/template/typescript-webpack/test/TypeScriptWebpackTemplate_spec.ts

@@ -1,7 +1,9 @@
 import * as testUtils from '@electron-forge/test-utils';
 import fs from 'fs-extra';
+import glob from 'fast-glob';
 import path from 'path';
 import template from '../src/TypeScriptWebpackTemplate';
+import { expect } from 'chai';
 
 describe('TypeScriptWebpackTemplate', () => {
   let dir: string;
@@ -33,6 +35,11 @@ describe('TypeScriptWebpackTemplate', () => {
     }
   });
 
+  it('should ensure js source files from base template are removed', async () => {
+    const jsFiles = await glob(path.join(dir, 'src', '**', '*.js'));
+    expect(jsFiles.length).to.equal(0, `The following unexpected js files were found in the src/ folder: ${JSON.stringify(jsFiles)}`);
+  });
+
   describe('lint', () => {
     before(async () => {
       await testUtils.ensureModulesInstalled(

packages/template/typescript/package.json

@@ -21,6 +21,7 @@
   },
   "devDependencies": {
     "@electron-forge/test-utils": "6.0.0-beta.66",
-    "chai": "^4.3.3"
+    "chai": "^4.3.3",
+    "fast-glob": "^3.2.7"
   }
 }

packages/template/typescript/src/TypeScriptTemplate.ts

@@ -33,6 +33,8 @@ class TypeScriptTemplate extends BaseTemplate {
       await fs.remove(filePath('index.js'));
       await this.copyTemplateFile(path.join(directory, 'src'), 'index.ts');
 
+      // Remove preload.js and replace with preload.ts
+      await fs.remove(filePath('preload.js'));
       await this.copyTemplateFile(path.join(directory, 'src'), 'preload.ts');
     });
   }

packages/template/typescript/test/TypeScriptTemplate_spec.ts

@@ -1,6 +1,7 @@
 import * as testUtils from '@electron-forge/test-utils';
 import { expect } from 'chai';
 import fs from 'fs-extra';
+import glob from 'fast-glob';
 import path from 'path';
 import template from '../src/TypeScriptTemplate';
 
@@ -16,18 +17,17 @@ describe('TypeScriptTemplate', () => {
   });
 
   context('template files are copied to project', () => {
-    const expectedFiles = ['.eslintrc.json', 'tsconfig.json', path.join('src', 'preload.ts')];
+    const expectedFiles = ['.eslintrc.json', 'tsconfig.json', path.join('src', 'index.ts'), path.join('src', 'preload.ts')];
     for (const filename of expectedFiles) {
       it(`${filename} should exist`, async () => {
         await testUtils.expectProjectPathExists(dir, filename, 'file');
       });
     }
   });
 
-  it('should convert the main process file to typescript', async () => {
-    await testUtils.expectProjectPathNotExists(dir, path.join('src', 'index.js'), 'file');
-    await testUtils.expectProjectPathExists(dir, path.join('src', 'index.ts'), 'file');
-    expect((await fs.readFile(path.join(dir, 'src', 'index.ts'))).toString()).to.match(/import\b.*\bBrowserWindow\b/);
+  it('should ensure js source files from base template are removed', async () => {
+    const jsFiles = await glob(path.join(dir, 'src', '**', '*.js'));
+    expect(jsFiles.length).to.equal(0, `The following unexpected js files were found in the src/ folder: ${JSON.stringify(jsFiles)}`);
   });
 
   describe('lint', () => {