fix(doctor): add electron checks (#2434)

cli/src/android/doctor.ts

@@ -1,5 +1,5 @@
 import { accessSync } from 'fs';
-import { check, isInstalled, logFatal, logSuccess, readXML } from '../common';
+import { check, logFatal, logSuccess, readXML } from '../common';
 import { existsAsync, readFileAsync } from '../util/fs';
 import { Config } from '../config';
 import { join } from 'path';

cli/src/common.ts

@@ -418,7 +418,7 @@ export function resolveNode(config: Config, ...pathSegments: any[]): string | nu
   return join(modulePath, ...path);
 }
 
-function resolveNodeFrom(start: string, id: string): string | null {
+export function resolveNodeFrom(start: string, id: string): string | null {
   const rootPath = parse(start).root;
   let basePath = resolve(start);
   let modulePath;
@@ -451,3 +451,13 @@ export const hasYarn = async (config: Config, projectDir?: string) => {
 export async function installDeps(projectDir: string, deps: string[], config: Config) {
   return runCommand(`cd "${projectDir}" && ${await hasYarn(config, projectDir) ? 'yarn add' : 'npm install --save'} ${deps.join(' ')}`);
 }
+
+export async function checkNPMVersion() {
+  const minVersion = '5.5.0';
+  const version = await runCommand('npm -v');
+  const semver = await import('semver');
+  if (semver.gt(minVersion, version)) {
+    return `Capacitor CLI requires at least NPM ${minVersion}`;
+  }
+  return null;
+}

cli/src/electron/doctor.ts

@@ -0,0 +1,53 @@
+import { check, checkNPMVersion, checkWebDir, logFatal, logSuccess, resolveNodeFrom } from '../common';
+import { Config } from '../config';
+import { existsAsync } from '../util/fs';
+import { join } from 'path';
+
+export async function doctorElectron(config: Config) {
+  try {
+    await check(
+      config,
+      [
+        checkWebDir,
+        checkNPMVersion,
+        checkAppSrcDirs,
+        checkElectronInstall
+      ]
+    );
+    logSuccess('electron looking great! 👌');
+  } catch (e) {
+    logFatal(e);
+  }
+
+}
+
+async function checkAppSrcDirs(config: Config) {
+  const appDir = join(config.electron.platformDir, 'app');
+  if (!await existsAsync(appDir)) {
+    return `"app" directory is missing in: ${config.electron.platformDir}`;
+  }
+
+  const appIndexHtml = join(appDir, 'index.html');
+  if (!await existsAsync(appIndexHtml)) {
+    return `"index.html" directory is missing in: ${appDir}`;
+  }
+  return checkElectronIndexFile(config, config.electron.platformDir);
+}
+
+async function checkElectronIndexFile(config: Config, electronDir: string) {
+  const indexFileName = 'index.js';
+  const indexFilePath = join(electronDir, indexFileName);
+
+  if (!await existsAsync(indexFilePath)) {
+    return `"${indexFilePath}" is missing in: ${electronDir}`;
+  }
+  return null;
+}
+
+async function checkElectronInstall(config: Config) {
+  if (resolveNodeFrom(config.electron.platformDir, 'electron')) {
+    return null;
+  } else {
+    return 'electron not installed';
+  }
+}

cli/src/ios/doctor.ts

@@ -1,5 +1,5 @@
 import { checkCocoaPods, checkIOSProject } from './common';
-import { check, checkWebDir, isInstalled, logFatal, logSuccess, runCommand } from '../common';
+import { check, checkNPMVersion, checkWebDir, isInstalled, logFatal, logSuccess } from '../common';
 import { Config } from '../config';
 import { getPlugins, printPlugins } from '../plugin';
 
@@ -46,12 +46,4 @@ async function checkXcode() {
 }
 
 
-async function checkNPMVersion() {
-  const minVersion = '5.5.0';
-  const version = await runCommand('npm -v');
-  const semver = await import('semver');
-  if (semver.gt(minVersion, version)) {
-    return `Capacitor CLI requires at least NPM ${minVersion}`;
-  }
-  return null;
-}
+

cli/src/tasks/doctor.ts

@@ -1,8 +1,8 @@
 import { Config } from '../config';
-import { log, readJSON, resolveNode, runCommand } from '../common';
+import { log, readJSON, resolveNode, resolveNodeFrom, runCommand } from '../common';
 import { doctorAndroid } from '../android/doctor';
+import { doctorElectron } from '../electron/doctor';
 import { doctorIOS } from '../ios/doctor';
-import { existsAsync, readFileAsync } from '../util/fs';
 import { emoji as _e } from '../util/emoji';
 
 import { join } from 'path';
@@ -24,12 +24,14 @@ export async function doctorCore(config: Config) {
   let cliVersion = await runCommand(`npm info @capacitor/cli version`);
   let coreVersion = await runCommand(`npm info @capacitor/core version`);
   let androidVersion = await runCommand(`npm info @capacitor/android version`);
+  let electronVersion = await runCommand(`npm info @capacitor/android version`);
   let iosVersion = await runCommand(`npm info @capacitor/ios version`);
 
   log(`${chalk.bold.blue('Latest Dependencies:')}\n`);
   log(`  ${chalk.bold('@capacitor/cli:')}`, cliVersion);
   log(`  ${chalk.bold('@capacitor/core:')}`, coreVersion);
   log(`  ${chalk.bold('@capacitor/android:')}`, androidVersion);
+  log(`  ${chalk.bold('@capacitor/electron:')}`, electronVersion);
   log(`  ${chalk.bold('@capacitor/ios:')}`, iosVersion);
 
   log(`${chalk.bold.blue('Installed Dependencies:')}\n`);
@@ -39,24 +41,32 @@ export async function doctorCore(config: Config) {
   log('');
 }
 
-async function printInstalledPackages( config: Config) {
+async function printInstalledPackages(config: Config) {
   const packageNames = ['@capacitor/cli', '@capacitor/core', '@capacitor/android', '@capacitor/ios'];
   await Promise.all(packageNames.map(async packageName => {
-    let version;
     const packagePath = resolveNode(config, packageName, 'package.json');
-    if (packagePath) {
-      version = (await readJSON(packagePath)).version;
-    }
-    log(`  ${chalk.bold(packageName)}`, version || 'not installed');
-    log('');
+    printPackageVersion(packageName, packagePath);
   }));
+  const packagePath = resolveNodeFrom(config.electron.platformDir, '@capacitor/electron');
+  printPackageVersion('@capacitor/electron', packagePath ? join(packagePath, 'package.json') : packagePath);
+}
+
+async function printPackageVersion(packageName: string, packagePath: string | null) {
+  let version;
+  if (packagePath) {
+    version = (await readJSON(packagePath)).version;
+  }
+  log(`  ${chalk.bold(packageName)}`, version || 'not installed');
+  log('');
 }
 
 export async function doctor(config: Config, platformName: string) {
   if (platformName === config.ios.name) {
     await doctorIOS(config);
   } else if (platformName === config.android.name) {
     await doctorAndroid(config);
+  } else if (platformName === config.electron.name) {
+    await doctorElectron(config);
   } else if (platformName === config.web.name) {
     return Promise.resolve();
   } else {