jiahaog/nativefier

View on GitHub
src/cli.js

Summary

Maintainability
A
2 hrs
Test Coverage
#! /usr/bin/env node

import 'source-map-support/register';
import program from 'commander';
import nativefier from './index';

const dns = require('dns');
const log = require('loglevel');
const packageJson = require('./../package');

function collect(val, memo) {
  memo.push(val);
  return memo;
}

function parseMaybeBoolString(val) {
  switch (val) {
    case 'true':
      return true;
    case 'false':
      return false;
    default:
      return val;
  }
}

function parseJson(val) {
  if (!val) return {};
  return JSON.parse(val);
}

function getProcessEnvs(val) {
  if (!val) return {};
  const pEnv = {};
  pEnv.processEnvs = parseJson(val);
  return pEnv;
}

function checkInternet() {
  dns.lookup('npmjs.com', (err) => {
    if (err && err.code === 'ENOTFOUND') {
      log.warn(
        '\nNo Internet Connection\nTo offline build, download electron from https://github.com/electron/electron/releases\nand place in ~/AppData/Local/electron/Cache/ on Windows,\n~/.cache/electron on Linux or ~/Library/Caches/electron/ on Mac\nUse --electron-version to specify the version you downloaded.',
      );
    }
  });
}

if (require.main === module) {
  const sanitizedArgs = [];
  process.argv.forEach((arg) => {
    if (sanitizedArgs.length > 0) {
      const previousArg = sanitizedArgs[sanitizedArgs.length - 1];

      // Work around commander.js not supporting default argument for options
      if (
        previousArg === '--tray' &&
        !['true', 'false', 'start-in-tray'].includes(arg)
      ) {
        sanitizedArgs.push('true');
      }
    }
    sanitizedArgs.push(arg);
  });

  program
    .version(packageJson.version, '-v, --version')
    .arguments('<targetUrl> [dest]')
    .action((targetUrl, appDir) => {
      program.targetUrl = targetUrl;
      program.out = appDir;
    })
    .option('-n, --name <value>', 'app name')
    .option('-p, --platform <value>', "'osx', 'mas', 'linux' or 'windows'")
    .option('-a, --arch <value>', "'ia32' or 'x64' or 'armv7l'")
    .option(
      '--app-version <value>',
      'The release version of the application.  Maps to the `ProductVersion` metadata property on Windows, and `CFBundleShortVersionString` on OS X.',
    )
    .option(
      '--build-version <value>',
      'The build version of the application. Maps to the `FileVersion` metadata property on Windows, and `CFBundleVersion` on OS X.',
    )
    .option(
      '--app-copyright <value>',
      'The human-readable copyright line for the app. Maps to the `LegalCopyright` metadata property on Windows, and `NSHumanReadableCopyright` on OS X',
    )
    .option(
      '--win32metadata <json-string>',
      'a JSON string of key/value pairs of application metadata (ProductName, InternalName, FileDescription) to embed into the executable (Windows only).',
      parseJson,
    )
    .option(
      '-e, --electron-version <value>',
      "electron version to package, without the 'v', see https://github.com/electron/electron/releases",
    )
    .option(
      '--no-overwrite',
      'do not override output directory if it already exists, defaults to false',
    )
    .option(
      '-c, --conceal',
      'packages the source code within your app into an archive, defaults to false, see https://electronjs.org/docs/tutorial/application-packaging',
    )
    .option(
      '--counter',
      'if the target app should use a persistent counter badge in the dock (macOS only), defaults to false',
    )
    .option(
      '--bounce',
      'if the the dock icon should bounce when counter increases (macOS only), defaults to false',
    )
    .option(
      '-i, --icon <value>',
      'the icon file to use as the icon for the app (should be a .png)',
    )
    .option(
      '--width <value>',
      'set window default width, defaults to 1280px',
      parseInt,
    )
    .option(
      '--height <value>',
      'set window default height, defaults to 800px',
      parseInt,
    )
    .option(
      '--min-width <value>',
      'set window minimum width, defaults to 0px',
      parseInt,
    )
    .option(
      '--min-height <value>',
      'set window minimum height, defaults to 0px',
      parseInt,
    )
    .option(
      '--max-width <value>',
      'set window maximum width, default is no limit',
      parseInt,
    )
    .option(
      '--max-height <value>',
      'set window maximum height, default is no limit',
      parseInt,
    )
    .option('--x <value>', 'set window x location', parseInt)
    .option('--y <value>', 'set window y location', parseInt)
    .option('-m, --show-menu-bar', 'set menu bar visible, defaults to false')
    .option(
      '-f, --fast-quit',
      'quit app after window close (macOS only), defaults to false',
    )
    .option('-u, --user-agent <value>', 'set the user agent string for the app')
    .option(
      '--honest',
      'prevent the nativefied app from changing the user agent string to masquerade as a regular chrome browser',
    )
    .option('--ignore-certificate', 'ignore certificate related errors')
    .option('--disable-gpu', 'disable hardware acceleration')
    .option(
      '--ignore-gpu-blacklist',
      'allow WebGl apps to work on non supported graphics cards',
    )
    .option('--enable-es3-apis', 'force activation of WebGl 2.0')
    .option(
      '--insecure',
      'enable loading of insecure content, defaults to false',
    )
    .option('--flash', 'if flash should be enabled')
    .option(
      '--flash-path <value>',
      'path to Chrome flash plugin, find it in `Chrome://plugins`',
    )
    .option(
      '--disk-cache-size <value>',
      'forces the maximum disk space (in bytes) to be used by the disk cache',
    )
    .option(
      '--inject <value>',
      'path to a CSS/JS file to be injected',
      collect,
      [],
    )
    .option(
      '--full-screen',
      'if the app should always be started in full screen',
    )
    .option('--maximize', 'if the app should always be started maximized')
    .option('--hide-window-frame', 'disable window frame and controls')
    .option('--verbose', 'if verbose logs should be displayed')
    .option('--disable-context-menu', 'disable the context menu')
    .option('--disable-dev-tools', 'disable developer tools')
    .option(
      '--zoom <value>',
      'default zoom factor to use when the app is opened, defaults to 1.0',
      parseFloat,
    )
    .option(
      '--internal-urls <value>',
      'regular expression of URLs to consider "internal"; all other URLs will be opened in an external browser.  (default: URLs on same second-level domain as app)',
    )
    .option(
      '--proxy-rules <value>',
      'proxy rules. See https://electronjs.org/docs/api/session?q=proxy#sessetproxyconfig-callback',
    )
    .option(
      '--crash-reporter <value>',
      'remote server URL to send crash reports',
    )
    .option(
      '--single-instance',
      'allow only a single instance of the application',
    )
    .option(
      '--clear-cache',
      'prevent the application from preserving cache between launches',
    )
    .option(
      '--processEnvs <json-string>',
      'a JSON string of key/value pairs to be set as environment variables before any browser windows are opened.',
      getProcessEnvs,
    )
    .option(
      '--file-download-options <json-string>',
      'a JSON string of key/value pairs to be set as file download options.  See https://github.com/sindresorhus/electron-dl for available options.',
      parseJson,
    )
    .option(
      '--tray [start-in-tray]',
      "Allow app to stay in system tray. If 'start-in-tray' is given as argument, don't show main window on first start",
      parseMaybeBoolString,
    )
    .option('--basic-auth-username <value>', 'basic http(s) auth username')
    .option('--basic-auth-password <value>', 'basic http(s) auth password')
    .option('--always-on-top', 'enable always on top window')
    .option(
      '--title-bar-style <value>',
      "(macOS only) set title bar style ('hidden', 'hiddenInset').  Consider injecting custom CSS (via --inject) for better integration.",
    )
    .option(
      '--global-shortcuts <value>',
      'JSON file with global shortcut configuration. See https://github.com/jiahaog/nativefier/blob/master/docs/api.md#global-shortcuts',
    )
    .option(
      '--browserwindow-options <json-string>',
      'a JSON string that will be sent directly into electron BrowserWindow options. See https://github.com/jiahaog/nativefier/blob/master/docs/api.md#browserwindow-options',
      parseJson,
    )
    .option(
      '--background-color <value>',
      "Sets the background color (for seamless experience while the app is loading). Example value: '#2e2c29'",
    )
    .option(
      '--darwin-dark-mode-support',
      '(macOS only) enable Dark Mode support on macOS 10.14+',
    )
    .parse(sanitizedArgs);

  if (!process.argv.slice(2).length) {
    program.help();
  }
  checkInternet();
  nativefier(program, (error, appPath) => {
    if (error) {
      log.error(error);
      return;
    }

    if (!appPath) {
      // app exists and --overwrite is not passed
      return;
    }
    log.info(`App built to ${appPath}`);
  });
}