Revamp and move to TypeScript (nativefier#898)

## Breaking changes

- Require **Node >= 8.10.0 and npm 5.6.0**
- Move to **Electron 8.1.1**.
- That's it. Lots of care went into breaking CLI & programmatic behavior
  as little as possible. **Please report regressions**.
- Known issue: build may fail behind a proxy. Get in touch if you use one:
  nativefier#907 (comment)

## Changes summary

Nativefier didn't get much love recently, to the point that it's
becoming hard to run on recent Node, due to old dependencies.
Also, some past practices now seem weird, as better expressible
by modern JS/TS, discouraging contributions including mine.

Addressing this, and one thing leading to another, came a
bigger-than-expected revamp, aiming at making Nativefier more
**lean, stable, future-proof, user-friendly and dev-friendly**,
while **not changing the CLI/programmatic interfaces**. Highlights:

- **Require Node>=8**, as imposed by many of our dependencies. Node 8
  is twice LTS, and easily available even in conservative Linux distros.
  No reason not to demand it.
- **Default to Electron 8**.
- **Bump** all dependencies to latest version, including electron-packager.
- **Move to TS**. TS is great. As of today, I see no reason not to use it,
  and fight interface bugs at runtime rather than at compile time.
  With that, get rid of everything Babel/Webpack.
- **Move away from Gulp**. Gulp's selling point is perf via streaming,
  but for small builds like Nativefier, npm tasks are plenty good
  and less dependency bloat. Gulp was the driver for this PR: broken
  on Node 12, and I didn't feel like just upgrading and keeping it.
- Add tons of **verbose logs** everywhere it makes sense, to have a
  fine & clear trace of the program flow. This will be helpful to
  debug user-reported issues, and already helped me fix a few bugs.
    - With better simple logging, get rid of the quirky and buggy
      progress bar based on package `progress`. Nice logging (minimal
      by default, the verbose logging mentioned above is only used
      when passing `--verbose`) is better and one less dependency.
- **Dump `async` package**, a relic from old callback-hell early Node.
  Also dump a few other micro-packages unnecessary now.
- A first pass of code **cleanup** thanks to modern JS/TS features:
  fixes, simplifications, jsdoc type annotations to types, etc.
- **Remove GitHub integrations Hound & CodeClimate**, which are more
  exotic than good'ol'linters, and whose signal-to-noise ratio is too low.
- Quality: **Add tests** and add **Windows + macOS CI builds**.
  Also, add a **manual test script**, helping to quickly verify the
  hard-to-programatically-test stuff before releases, and limit regressions.
- **Fix a very small number of existing bugs**. The goal of this PR was
  *not* to fix bugs, but to get Nativefier in better shape to do so.
  Bugfixes will come later. Still, these got addressed:
  - Add common `Alt`+`Left`/`Right` for previous/next navigation.
  - Improve nativefier#379: fix zoom with `Ctrl` + numpad `+`/`-`
  - Fix pinch-to-zoom (see nativefier#379 (comment) )

.eslintrc.js

@@ -0,0 +1,23 @@
+// # https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/README.md
+module.exports = {
+  root: true,
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    tsconfigRootDir: __dirname,
+    project: ['./tsconfig.json'],
+  },
+  plugins: ['@typescript-eslint', 'prettier'],
+  extends: [
+    'eslint:recommended',
+    'prettier',
+    'plugin:@typescript-eslint/eslint-recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:@typescript-eslint/recommended-requiring-type-checking',
+  ],
+  rules: {
+    'prettier/prettier': 'error',
+    // TODO remove when done killing anys and making tsc strict
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/ban-ts-ignore': 'off',
+  },
+};

.gitignore

@@ -5,7 +5,7 @@
 package-lock.json
 
 # ignore compiled lib files
-lib/*
+lib*
 app/lib/*
 built-tests
 
@@ -48,3 +48,6 @@ node_modules
 *.iml
 out
 gen
+
+# Builds when testing npm pack
+nativefier*.tgz

.npmignore

@@ -1,7 +1,19 @@
 # OSX
-.DS_Store
-
 /*
 !lib/
-!app/lib
-!bin
+!app/lib/
+!icon-scripts
+.DS_Store
+.eslintrc.yml
+src/
+app/src/
+app/node_modules
+*tsconfig.tsbuildinfo
+*package-lock.json
+*tsconfig.json
+*jestSetupFiles*
+*-test.js
+*-test.js.map
+*.test.d.ts
+*.test.js
+*.test.js.map

.travis.yml

@@ -1,21 +1,19 @@
 language: node_js
-addons:
-  code_climate:
-    repo_token: CODE_CLIMATE_TOKEN
+os:
+- linux
+- osx
+- windows
 node_js:
-- '11'
-- '10'
+- '13' # Changing this? Remind to adjust the linter condition below causing linter to run for only one version (for faster CI)
+- '12'
 - '8'
-- '7'
-- '6'
-before_install:
-- npm install -g [email protected]
 install:
-- npm run dev-up
+- npm install
+- npm run build
 script:
-- npm run ci
-after_script:
-- codeclimate-test-reporter < ./coverage/lcov.info
+# Only run linter once, for faster CI
+- if [ "$TRAVIS_OS_NAME" = "linux" ] && [ "$TRAVIS_NODE_VERSION" = "13" ]; then npm run lint; fi
+- npm test
 deploy:
   provider: npm
   skip_cleanup: true
@@ -25,4 +23,4 @@ deploy:
   on:
     tags: true
     repo: jiahaog/nativefier
-    node: '8'
+    node: '12'

README.md

@@ -1,96 +1,73 @@
 # Nativefier
 
-[![Build Status](https://travis-ci.org/jiahaog/nativefier.svg?branch=development)](https://travis-ci.org/jiahaog/nativefier)
-[![Code Climate](https://codeclimate.com/github/jiahaog/nativefier/badges/gpa.svg)](https://codeclimate.com/github/jiahaog/nativefier)
+[![Build Status](https://travis-ci.org/jiahaog/nativefier.svg)](https://travis-ci.org/jiahaog/nativefier)
 [![npm version](https://badge.fury.io/js/nativefier.svg)](https://www.npmjs.com/package/nativefier)
-[![Dependency Status](https://david-dm.org/jiahaog/nativefier.svg)](https://david-dm.org/jiahaog/nativefier)
 
-![Dock](screenshots/dock.png)
+![Dock](dock.png)
 
 You want to make a native wrapper for WhatsApp Web (or any web page).
 
 ```bash
 nativefier web.whatsapp.com
 ```
 
-![Walkthrough](screenshots/walkthrough.gif)
+![Walkthrough animation](walkthrough.gif)
 
 You're done.
 
 ## Table of Contents
 
   - [Installation](#installation)
   - [Usage](#usage)
-  - [Optional dependencies](#optional-dependencies)
   - [How it works](#how-it-works)
   - [Development](docs/development.md)
   - [License](#license)
 
 ## Introduction
 
-Nativefier is a command-line tool to easily create a desktop application for any web site with succinct and minimal configuration. Apps are wrapped by [Electron](http://electron.atom.io) in an OS executable (`.app`, `.exe`, etc.) for use on Windows, macOS and Linux.
+Nativefier is a command-line tool to easily create a desktop application for any web site with succinct and minimal configuration. Apps are wrapped by [Electron](https://www.electronjs.org/) in an OS executable (`.app`, `.exe`, etc.) for use on Windows, macOS and Linux.
 
-I did this because I was tired of having to `⌘-tab` or `alt-tab` to my browser and then search through the numerous open tabs when I was using [Facebook Messenger](http://messenger.com) or [Whatsapp Web](http://web.whatsapp.com) ([relevant Hacker News thread](https://news.ycombinator.com/item?id=10930718)).
+I did this because I was tired of having to `⌘-tab` or `alt-tab` to my browser and then search through the numerous open tabs when I was using [Facebook Messenger](https://messenger.com) or [Whatsapp Web](https://web.whatsapp.com) ([relevant Hacker News thread](https://news.ycombinator.com/item?id=10930718)).
 
-[Changelog](https://github.com/jiahaog/nativefier/blob/master/docs/changelog.md). [Developer docs](https://github.com/jiahaog/nativefier/blob/master/docs/development.md).
+[Changelog](https://github.com/jiahaog/nativefier/blob/master/CHANGELOG.md). [Developer docs](https://github.com/jiahaog/nativefier/blob/master/docs/development.md).
 
-### Features
+Features:
 
 - Automatically retrieves the correct icon and app name.
 - JavaScript and CSS injection.
-- Flash Support (with [`--flash`](docs/api.md#flash) flag).
 - Many more, see the [API docs](docs/api.md) or `nativefier --help`
 
 ## Installation
 
-### Requirements
-
 - macOS 10.9+ / Windows / Linux
-- [Node.js](https://nodejs.org/) `>=6` (4.x may work but is no longer tested, please upgrade)
-- See [optional dependencies](#optional-dependencies) for more.
+- [Node.js](https://nodejs.org/) `>=8`
+- Optional dependencies:
+    - [ImageMagick](http://www.imagemagick.org/) to convert icons. Make sure `convert` and `identify` are in your `$PATH`.
+    - [Wine](https://www.winehq.org/) to package Windows apps under non-Windows platforms. Make sure `wine` is in your `$PATH`.
 
 ```bash
 npm install nativefier -g
 ```
 
 ## Usage
 
-Creating a native desktop app for [medium.com](http://medium.com):
+Creating a native desktop app for [medium.com](https://medium.com):
 
 ```bash
-nativefier "http://medium.com"
+nativefier "medium.com"
 ```
 
-Nativefier will intelligently attempt to determine the app name, your OS and processor architecture, among other options. If desired, the app name or other options can be overwritten by specifying the `--name "Medium"` as part of the command line options:
+Nativefier will attempt to determine the app name, your OS and processor architecture, among other options. If desired, the app name or other options can be overwritten by specifying the `--name "Medium"` as part of the command line options:
 
 ```bash
-nativefier --name "Some Awesome App" "http://medium.com"
+nativefier --name "Some Awesome App" "medium.com"
 ```
-Read the [API documentation](docs/api.md) (or `nativefier --help`) for other command line flags and options that can be used to configure the packaged app.
-
-If you would like high resolution icons to be used, please contribute to the [icon repository](https://github.com/jiahaog/nativefier-icons)!
-
-**Windows Users:** Take note that the application menu is automatically hidden by default, you can press `alt` on your keyboard to access it.
-
-**Linux Users:** Do not put spaces if you define the app name yourself with `--name`, as this will cause problems when pinning a packaged app to the launcher.
-
-## Optional dependencies
-
-### Icons for Windows apps packaged under non-Windows platforms
-
-You need [Wine](https://www.winehq.org/) installed; make sure that `wine` is in your `$PATH`.
-
-### Icon conversion for macOS
-
-To support conversion of a `.png` or `.ico` into a `.icns` for a packaged macOS app icon (currently only supported on macOS), you need the following dependencies.
 
-* [iconutil](https://developer.apple.com/library/mac/documentation/GraphicsAnimation/Conceptual/HighResolutionOSX/Optimizing/Optimizing.html) (comes with [Xcode](https://developer.apple.com/xcode/)).
-* [imagemagick](http://www.imagemagick.org/script/index.php). Make sure `convert` and `identify` are in your `$PATH`.
-* If the tools are not found, then Nativefier will fall back to the built-in macOS tool `sips` to perform the conversion, which is more limited.
+Read the [API documentation](docs/api.md) (or `nativefier --help`) for other command-line flags that can be used to configure the packaged app.
 
-### Flash
+To have high-resolution icons used by default for an app/domain, please contribute to the [icon repository](https://github.com/jiahaog/nativefier-icons)!
 
-[Google Chrome](https://www.google.com/chrome/) is required for flash to be supported; you should pass the path to its embedded Flash plugin to the `--flash` flag. See the [API docs](docs/api.md) for more details.
+Note that the application menu is hidden by default for a minimal UI. You can press the `alt` keyboard key to access it.
 
 ## How it works
 

app/.eslintrc.js

@@ -0,0 +1,24 @@
+// # https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/README.md
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    tsconfigRootDir: __dirname,
+    project: ['./tsconfig.json'],
+  },
+  plugins: ['@typescript-eslint'],
+  extends: [
+    'eslint:recommended',
+    'prettier',
+    'plugin:@typescript-eslint/eslint-recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:@typescript-eslint/recommended-requiring-type-checking',
+  ],
+  rules: {
+    'prettier/prettier': 'error',
+    // TODO remove when done killing anys and making tsc strict
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/ban-ts-ignore': 'off',
+    '@typescript-eslint/no-use-before-define': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+  },
+};

app/package.json

@@ -3,23 +3,24 @@
   "version": "1.0.0",
   "description": "Placeholder for the nativefier cli to override with a target url",
   "main": "lib/main.js",
-  "dependencies": {
-    "electron-context-menu": "^0.10.0",
-    "electron-dl": "^1.10.0",
-    "electron-squirrel-startup": "^1.0.0",
-    "electron-window-state": "^4.1.1",
-    "loglevel": "^1.5.1",
-    "source-map-support": "^0.5.0",
-    "wurl": "^2.5.2"
-  },
-  "devDependencies": {},
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
+  "author": "Jia Hao",
+  "license": "MIT",
   "keywords": [
     "desktop",
-    "electron"
+    "electron",
+    "placeholder"
   ],
-  "author": "Jia Hao",
-  "license": "MIT"
+  "scripts": {},
+  "dependencies": {
+    "electron-context-menu": "0.x",
+    "electron-dl": "3.x",
+    "electron-squirrel-startup": "1.x",
+    "electron-window-state": "5.x",
+    "loglevel": "1.x",
+    "source-map-support": "0.x",
+    "wurl": "2.x"
+  },
+  "devDependencies": {
+    "electron": "8.x"
+  }
 }

app/src/components/contextMenu/contextMenu.js → app/src/components/contextMenu.ts

@@ -1,9 +1,9 @@
 import { shell } from 'electron';
 import contextMenu from 'electron-context-menu';
 
-function initContextMenu(createNewWindow, createNewTab) {
+export function initContextMenu(createNewWindow, createNewTab): void {
   contextMenu({
-    prepend: (params) => {
+    prepend: (actions, params) => {
       const items = [];
       if (params.linkURL) {
         items.push({
@@ -31,5 +31,3 @@ function initContextMenu(createNewWindow, createNewTab) {
     },
   });
 }
-
-export default initContextMenu;

app/src/components/login/loginWindow.js → app/src/components/loginWindow.ts

@@ -1,18 +1,19 @@
+import * as path from 'path';
+
 import { BrowserWindow, ipcMain } from 'electron';
-import path from 'path';
 
-function createLoginWindow(loginCallback) {
+export function createLoginWindow(loginCallback): BrowserWindow {
   const loginWindow = new BrowserWindow({
     width: 300,
     height: 400,
     frame: false,
     resizable: false,
     webPreferences: {
-      nodeIntegration: true,
+      nodeIntegration: true, // TODO work around this; insecure
     },
   });
   loginWindow.loadURL(
-    `file://${path.join(__dirname, '/static/login/login.html')}`,
+    `file://${path.join(__dirname, '..', 'static/login.html')}`,
   );
 
   ipcMain.once('login-message', (event, usernameAndPassword) => {
@@ -21,5 +22,3 @@ function createLoginWindow(loginCallback) {
   });
   return loginWindow;
 }
-
-export default createLoginWindow;