Update run_ci.sh

Ref: https://github.com/highlightjs/highlight.js/issues/2277

.dockerignore

@@ -0,0 +1,12 @@
+**/node_modules
+Assets/
+.git/
+_releases/
+packages/app-desktop
+packages/app-cli
+packages/app-mobile
+packages/app-clipper
+packages/generator-joplin
+packages/plugin-repo-cli
+packages/server/db-*.sqlite
+packages/server/temp

.env-sample

@@ -0,0 +1,26 @@
+# =============================================================================
+# PRODUCTION CONFIG EXAMPLE
+# -----------------------------------------------------------------------------
+# By default it will use SQLite, but that's mostly to test and evaluate the
+# server. So you'll want to specify db connection settings to use Postgres.
+# =============================================================================
+#
+# APP_BASE_URL=https://example.com/joplin
+# APP_PORT=22300
+# 
+# DB_CLIENT=pg
+# POSTGRES_PASSWORD=joplin
+# POSTGRES_DATABASE=joplin
+# POSTGRES_USER=joplin
+# POSTGRES_PORT=5432
+# POSTGRES_HOST=localhost
+
+# =============================================================================
+# DEV CONFIG EXAMPLE
+# -----------------------------------------------------------------------------
+# Example of local config, for development. In dev mode, you would usually use
+# SQLite so database settings are not needed.
+# =============================================================================
+#
+# APP_BASE_URL=http://localhost:22300
+# APP_PORT=22300

.eslintrc.js

@@ -1,12 +1,13 @@
 module.exports = {
+	'root': true,
 	'env': {
 		'browser': true,
 		'es6': true,
 		'node': true,
 	},
-	"parser": "@typescript-eslint/parser",
+	'parser': '@typescript-eslint/parser',
 	'extends': ['eslint:recommended'],
-	"settings": {
+	'settings': {
 		'react': {
 			'version': '16.12',
 		},
@@ -15,7 +16,8 @@ module.exports = {
 		'Atomics': 'readonly',
 		'SharedArrayBuffer': 'readonly',
 
-		// Jasmine variables
+		// Jest variables
+		'test': 'readonly',
 		'expect': 'readonly',
 		'describe': 'readonly',
 		'it': 'readonly',
@@ -23,7 +25,7 @@ module.exports = {
 		'afterAll': 'readonly',
 		'beforeEach': 'readonly',
 		'afterEach': 'readonly',
-		'jasmine': 'readonly',
+		'jest': 'readonly',
 
 		// React Native variables
 		'__DEV__': 'readonly',
@@ -33,33 +35,54 @@ module.exports = {
 		'chrome': 'readonly',
 		'browser': 'readonly',
 
+		// Server admin UI global variables
+		'onDocumentReady': 'readonly',
+		'setupPasswordStrengthHandler': 'readonly',
+		'$': 'readonly',
+		'zxcvbn': 'readonly',
+
 		'tinymce': 'readonly',
 	},
 	'parserOptions': {
 		'ecmaVersion': 2018,
-		"ecmaFeatures": {
-			"jsx": true,
-	    },
-	    "sourceType": "module",
+		'ecmaFeatures': {
+			'jsx': true,
+		},
+		'sourceType': 'module',
 	},
 	'rules': {
 		// -------------------------------
 		// Code correctness
 		// -------------------------------
-		"react/jsx-uses-react": "error",
-		"react/jsx-uses-vars": "error",
-		"no-unused-vars": "error",
-		"@typescript-eslint/no-unused-vars": "error",
-		"no-constant-condition": 0,
-		"no-prototype-builtins": 0,
+		'react/jsx-uses-react': 'error',
+		'react/jsx-uses-vars': 'error',
+		'no-unused-vars': ['error', { 'argsIgnorePattern': '^_' }],
+		'@typescript-eslint/no-unused-vars': ['error', { 'argsIgnorePattern': '^_' }],
+		'@typescript-eslint/explicit-member-accessibility': 'off',
+		'no-constant-condition': 0,
+		'no-prototype-builtins': 0,
 		// This error is always a false positive so far since it detects
 		// possible race conditions in contexts where we know it cannot happen.
-		"require-atomic-updates": 0,
-		"prefer-const": ["error"],
-		"no-var": ["error"],
+		'require-atomic-updates': 0,
+		'prefer-const': ['error'],
+		'no-var': ['error'],
+		'no-new-func': ['error'],
+		'import/prefer-default-export': ['error'],
+
+		// This rule should not be enabled since it matters in what order
+		// imports are done, in particular in relation to the shim.setReact
+		// call, which should be done first, but this rule might move it down.
+		// 'import/first': ['error'],
+
+		'no-array-constructor': ['error'],
+		'radix': ['error'],
+
+		// Warn only for now because fixing everything would take too much
+		// refactoring, but new code should try to stick to it.
+		// 'complexity': ['warn', { max: 10 }],
 
 		// Checks rules of Hooks
-		"react-hooks/rules-of-hooks": "error",
+		'react-hooks/rules-of-hooks': 'error',
 		// Checks effect dependencies
 		// Disable because of this: https://github.com/facebook/react/issues/16265
 		// "react-hooks/exhaustive-deps": "warn",
@@ -67,42 +90,137 @@ module.exports = {
 		// -------------------------------
 		// Formatting
 		// -------------------------------
-		"space-in-parens": ["error", "never"],
-		"space-infix-ops": ["error"],
-		"curly": ["error", "multi-line", "consistent"],
-		"semi": ["error", "always"],
-		"eol-last": ["error", "always"],
-		"quotes": ["error", "single"],
-		"indent": ["error", "tab"],
-		"comma-dangle": ["error", "always-multiline"],
-		"no-trailing-spaces": "error",
-		"linebreak-style": ["error", "unix"],
-		"prefer-template": ["error"],
-		"template-curly-spacing": ["error", "never"],
-		"object-curly-spacing": ["error", "always"],
-		"array-bracket-spacing": ["error", "never"],
-		"key-spacing": ["error", {
-			"beforeColon": false,
-			"afterColon": true,
-			"mode": "strict"
+		'space-in-parens': ['error', 'never'],
+		'space-infix-ops': ['error'],
+		'curly': ['error', 'multi-line', 'consistent'],
+		'semi': ['error', 'always'],
+		'eol-last': ['error', 'always'],
+		'quotes': ['error', 'single'],
+		'indent': ['error', 'tab'],
+		'comma-dangle': ['error', {
+			'arrays': 'always-multiline',
+			'objects': 'always-multiline',
+			'imports': 'always-multiline',
+			'exports': 'always-multiline',
+			'functions': 'never',
 		}],
-		"block-spacing": ["error"],
-		"brace-style": ["error", "1tbs", { "allowSingleLine": true }],
-		"no-spaced-func": ["error"],
-		"func-call-spacing": ["error"],
-		"space-before-function-paren": ["error", {
-			"anonymous": "never",
-			"named": "never",
-			"asyncArrow": "always"
+		'no-trailing-spaces': 'error',
+		'linebreak-style': ['error', 'unix'],
+		'prefer-template': ['error'],
+		'template-curly-spacing': ['error', 'never'],
+		'object-curly-spacing': ['error', 'always'],
+		'array-bracket-spacing': ['error', 'never'],
+		'key-spacing': ['error', {
+			'beforeColon': false,
+			'afterColon': true,
+			'mode': 'strict',
 		}],
-		"multiline-comment-style": ["error", "separate-lines"],
-		"space-before-blocks": "error",
-		"spaced-comment": ["error", "always"],
-		"keyword-spacing": ["error", { "before": true, "after": true }],
+		'block-spacing': ['error'],
+		'brace-style': ['error', '1tbs', { 'allowSingleLine': true }],
+		'no-spaced-func': ['error'],
+		'func-call-spacing': ['error'],
+		'space-before-function-paren': ['error', {
+			'anonymous': 'never',
+			'named': 'never',
+			'asyncArrow': 'always',
+		}],
+		'multiline-comment-style': ['error', 'separate-lines'],
+		'space-before-blocks': 'error',
+		'spaced-comment': ['error', 'always'],
+		'keyword-spacing': ['error', { 'before': true, 'after': true }],
+		'no-multi-spaces': ['error'],
 	},
-	"plugins": [
-		"react",
-		"@typescript-eslint",
-		"react-hooks"
+	'plugins': [
+		'react',
+		'@typescript-eslint',
+		'react-hooks',
+		'import',
+	],
+	'overrides': [
+		{
+			// enable the rule specifically for TypeScript files
+			'files': ['*.ts', '*.tsx'],
+			'parserOptions': {
+				// Required for @typescript-eslint/no-floating-promises
+				'project': './tsconfig.eslint.json',
+			},
+			'rules': {
+				// Warn only because it would make it difficult to convert JS classes to TypeScript, unless we
+				// make everything public which is not great. New code however should specify member accessibility.
+				'@typescript-eslint/explicit-member-accessibility': ['warn'],
+				'@typescript-eslint/type-annotation-spacing': ['error', { 'before': false, 'after': true }],
+				'@typescript-eslint/comma-dangle': ['error', {
+					'arrays': 'always-multiline',
+					'objects': 'always-multiline',
+					'imports': 'always-multiline',
+					'exports': 'always-multiline',
+					'enums': 'always-multiline',
+					'generics': 'always-multiline',
+					'tuples': 'always-multiline',
+					'functions': 'never',
+				}],
+				'@typescript-eslint/semi': ['error', 'always'],
+				'@typescript-eslint/member-delimiter-style': ['error', {
+					'multiline': {
+						'delimiter': 'semi',
+						'requireLast': true,
+					},
+					'singleline': {
+						'delimiter': 'semi',
+						'requireLast': false,
+					},
+				}],
+				'@typescript-eslint/no-floating-promises': ['error'],
+				'@typescript-eslint/naming-convention': ['error',
+					// Naming conventions over the codebase is very inconsistent
+					// unfortunately and fixing it would be way too much work.
+					// In general, we use "strictCamelCase" for variable names.
+
+					// {
+					// 	selector: 'default',
+					// 	format: ['StrictPascalCase', 'strictCamelCase', 'snake_case', 'UPPER_CASE'],
+					// 	leadingUnderscore: 'allow',
+					// 	trailingUnderscore: 'allow',
+					// },
+
+					// Each rule below is made of two blocks: first the rule we
+					// actually want, and below exceptions to the rule.
+
+					// -----------------------------------
+					// ENUM
+					// -----------------------------------
+
+					{
+						selector: 'enumMember',
+						format: ['StrictPascalCase'],
+					},
+					{
+						selector: 'enumMember',
+						format: null,
+						'filter': {
+							'regex': '^(GET|POST|PUT|DELETE|PATCH|HEAD|SQLite|PostgreSQL|ASC|DESC|E2EE|OR|AND|UNION|INTERSECT|EXCLUSION|INCLUSION|EUR|GBP|USD|SJCL.*)$',
+							'match': true,
+						},
+					},
+
+					// -----------------------------------
+					// INTERFACE
+					// -----------------------------------
+
+					{
+						selector: 'interface',
+						format: ['StrictPascalCase'],
+					},
+					{
+						selector: 'interface',
+						format: null,
+						'filter': {
+							'regex': '^(RSA|RSAKeyPair)$',
+							'match': true,
+						},
+					},
+				],
+			},
+		},
 	],
 };

.github/ISSUE_TEMPLATE/---feature-requests-and-support.md

@@ -1,15 +0,0 @@
----
-name: "\U0001F914 Feature requests and support"
-about: 'For non-bug issues we recommend using the forum, where you''ll be more likely
-  to get an answer: https://discourse.joplinapp.org/'
-title: ''
-labels: ''
-assignees: ''
-
----
-
-If this is a feature request or a support query, please note that you'll not get an answer here.
-
-Instead we recommend using the forum where you'll are a lot more likely to get an answer: https://discourse.joplinapp.org/
-
-The forum is also the right place to submit a feature request so that it can be discussed by other users.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+    - name: "\U0001F914 Feature requests and support"
+      url: https://discourse.joplinapp.org/
+      about: I have a question or feature request …

.github/PULL_REQUEST_TEMPLATE

@@ -2,14 +2,24 @@
 
 Please prefix the title with the platform you are targetting:
 
+Here are some examples of good titles:
+
+- Desktop: Resolves #123: Added new setting to change font
+- Mobile, Desktop: Fixes #456: Fixed config screen error
+- All: Resolves #777: Made synchronisation faster
+
+And here's an explanation of the title format:
+
 - "Desktop" for the Windows/macOS/Linux app (Electron app)
 - "Mobile" for the mobile app (or "Android" / "iOS" if the pull request only applies to one of the mobile platforms)
 - "CLI" for the CLI app
 
+If it's two platforms, separate them with commas - "Desktop, Mobile" or if it's for all platforms, prefix with "All".
+
 If it's not related to any platform (such as a translation, change to the documentation, etc.), simply don't add a platform.
 
-For example: "Desktop: Added new setting to change font", or "Mobile: Fixed config screen error"
+Then please append the issue that you've addressed or fixed. Use "Resolves #123" for new features or improvements and "Fixes #123" for bug fixes.
 
-PLEASE READ THE GUIDE FIRST: https://github.com/laurent22/joplin/blob/master/CONTRIBUTING.md
+AND PLEASE READ THE GUIDE: https://github.com/laurent22/joplin/blob/dev/CONTRIBUTING.md
 
 -->

.github/scripts/run_ci.sh

@@ -0,0 +1,148 @@
+#!/bin/bash
+
+# =============================================================================
+# Setup environment variables
+# =============================================================================
+
+SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
+ROOT_DIR="$SCRIPT_DIR/../.."
+
+IS_PULL_REQUEST=0
+IS_DEV_BRANCH=0
+IS_LINUX=0
+IS_MACOS=0
+
+if [ "$GITHUB_EVENT_NAME" == "pull_request" ]; then
+	IS_PULL_REQUEST=1
+fi
+
+if [ "$GITHUB_REF" == "refs/heads/dev" ]; then
+	IS_DEV_BRANCH=1
+fi
+
+if [ "$RUNNER_OS" == "Linux" ]; then
+	IS_LINUX=1
+	IS_MACOS=0
+else
+	IS_LINUX=0
+	IS_MACOS=1
+fi
+
+# =============================================================================
+# Print environment
+# =============================================================================
+
+echo "GITHUB_WORKFLOW=$GITHUB_WORKFLOW"
+echo "GITHUB_EVENT_NAME=$GITHUB_EVENT_NAME"
+echo "GITHUB_REF=$GITHUB_REF"
+echo "RUNNER_OS=$RUNNER_OS"
+echo "GIT_TAG_NAME=$GIT_TAG_NAME"
+
+echo "IS_CONTINUOUS_INTEGRATION=$IS_CONTINUOUS_INTEGRATION"
+echo "IS_PULL_REQUEST=$IS_PULL_REQUEST"
+echo "IS_DEV_BRANCH=$IS_DEV_BRANCH"
+echo "IS_LINUX=$IS_LINUX"
+echo "IS_MACOS=$IS_MACOS"
+
+echo "Node $( node -v )"
+echo "Npm $( npm -v )"
+
+# =============================================================================
+# Install packages
+# =============================================================================
+
+cd "$ROOT_DIR"
+npm install
+
+# =============================================================================
+# Run test units. Only do it for pull requests and dev branch because we don't
+# want it to randomly fail when trying to create a desktop release.
+# =============================================================================
+
+if [ "$IS_PULL_REQUEST" == "1" ] || [ "$IS_DEV_BRANCH" = "1" ]; then
+	echo "Step: Running tests..."
+
+	# Need this because we're getting this error:
+	#
+	# @joplin/lib: FATAL ERROR: Ineffective mark-compacts near heap limit
+	# Allocation failed - JavaScript heap out of memory
+	#
+	# https://stackoverflow.com/questions/38558989
+	export NODE_OPTIONS="--max-old-space-size=4096"
+	npm run test-ci
+	testResult=$?
+	if [ $testResult -ne 0 ]; then
+		exit $testResult
+	fi
+fi
+
+# =============================================================================
+# Run linter for pull requests only. We also don't want this to make the desktop
+# release randomly fail.
+# =============================================================================
+
+if [ "$IS_PULL_REQUEST" == "1" ]; then
+	echo "Step: Running linter..."
+
+	npm run linter-ci ./
+	testResult=$?
+	if [ $testResult -ne 0 ]; then
+		exit $testResult
+	fi
+fi
+
+# =============================================================================
+# Validate translations - this is needed as some users manually edit .po files
+# (and often make mistakes) instead of using a proper tool like poedit. Doing it
+# for Linux only is sufficient.
+# =============================================================================
+
+if [ "$IS_PULL_REQUEST" == "1" ]; then
+	if [ "$IS_LINUX" == "1" ]; then
+		echo "Step: Validating translations..."
+
+		node packages/tools/validate-translation.js
+		testResult=$?
+		if [ $testResult -ne 0 ]; then
+			exit $testResult
+		fi
+	fi
+fi
+
+# =============================================================================
+# Find out if we should run the build or not. Electron-builder gets stuck when
+# building PRs so we disable it in this case. The Linux build should provide
+# enough info if the app builds or not.
+# https://github.com/electron-userland/electron-builder/issues/4263
+# =============================================================================
+
+if [ "$IS_PULL_REQUEST" == "1" ]; then
+	if [ "$IS_MACOS" == "1" ]; then
+		echo "Step: Not building Electron app"
+		exit 0
+	fi
+fi
+
+# =============================================================================
+# Prepare the Electron app and build it
+#
+# If the current tag is a desktop release tag (starts with "v", such as
+# "v1.4.7"), we build and publish to github
+#
+# Otherwise we only build but don't publish to GitHub. It helps finding
+# out any issue in pull requests and dev branch.
+# =============================================================================
+
+cd "$ROOT_DIR/packages/app-desktop"
+
+if [[ $GIT_TAG_NAME = v* ]]; then
+	echo "Step: Building and publishing desktop application..."
+	USE_HARD_LINKS=false npm run dist
+elif [[ $GIT_TAG_NAME = server-v* ]] && [[ $IS_LINUX = 1 ]]; then
+	echo "Step: Building Docker Image..."
+	cd "$ROOT_DIR"
+	npm run buildServerDocker -- --tag-name $GIT_TAG_NAME --push-images
+else
+	echo "Step: Building but *not* publishing desktop application..."
+	USE_HARD_LINKS=false npm run dist -- --publish=never
+fi

.github/stale.yml

@@ -1,6 +1,6 @@
 # Configuration for probot-stale - https://github.com/probot/stale
 # Number of days of inactivity before an issue becomes stale
-daysUntilStale: 45
+daysUntilStale: 30
 # Number of days of inactivity before a stale issue is closed
 daysUntilClose: 7
 # Issues with these labels will never be considered stale
@@ -9,6 +9,9 @@ exemptLabels:
   - "upstream"
   - "backlog"
   - "high"
+  - "medium"
+  - "spec"
+  - "cannot reproduce"
 # Label to use when marking an issue as stale
 staleLabel: stale
 # Comment to post when marking an issue as stale. Set to `false` to disable

.github/workflows/github-actions-main.yml

@@ -0,0 +1,76 @@
+name: Joplin Continuous Integration
+on: [push, pull_request]
+jobs:
+  Main:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [macos-latest, ubuntu-latest, windows-2016]
+    steps:
+
+      # Silence apt-get update errors (for example when a module doesn't
+      # exist) since otherwise it will make the whole build fails, even though
+      # it might work without update. libsecret-1-dev is required for keytar -
+      # https://github.com/atom/node-keytar
+
+      - name: Install Linux dependencies
+        if: runner.os == 'Linux'
+        run: |
+          sudo apt-get update || true
+          sudo apt-get install -y gettext
+          sudo apt-get install -y libsecret-1-dev
+
+      - name: Install Docker Engine
+        if: runner.os == 'Linux' && startsWith(github.ref, 'refs/tags/server-v')
+        run: |
+          sudo apt-get install -y apt-transport-https
+          sudo apt-get install -y ca-certificates
+          sudo apt-get install -y curl
+          sudo apt-get install -y gnupg
+          sudo apt-get install -y lsb-release
+          curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
+          echo \
+              "deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \
+              $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
+          sudo apt-get update || true
+          sudo apt-get install -y docker-ce docker-ce-cli containerd.io
+
+      - uses: actions/checkout@v2
+      - uses: olegtarasov/get-tag@v2.1
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '16'
+      
+      # Login to Docker only if we're on a server release tag. If we run this on
+      # a pull request it will fail because the PR doesn't have access to
+      # secrets
+      - uses: docker/login-action@v1
+        if: runner.os == 'Linux' && startsWith(github.ref, 'refs/tags/server-v')
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Run tests, build and publish Linux and macOS apps
+        if: runner.os == 'Linux' || runner.os == 'macOs'
+        env:
+          APPLE_ASC_PROVIDER: ${{ secrets.APPLE_ASC_PROVIDER }}
+          APPLE_ID: ${{ secrets.APPLE_ID }}
+          APPLE_ID_PASSWORD: ${{ secrets.APPLE_ID_PASSWORD }}
+          CSC_KEY_PASSWORD: ${{ secrets.APPLE_CSC_KEY_PASSWORD }}
+          CSC_LINK: ${{ secrets.APPLE_CSC_LINK }}
+          GH_TOKEN: ${{ secrets.GH_TOKEN }}
+          IS_CONTINUOUS_INTEGRATION: 1
+        run: |
+          "${GITHUB_WORKSPACE}/.github/scripts/run_ci.sh"
+
+      - name: Build and publish Windows app
+        if: runner.os == 'Windows' && startsWith(github.ref, 'refs/tags/v')
+        env:
+          CSC_KEY_PASSWORD: ${{ secrets.WINDOWS_CSC_KEY_PASSWORD }}
+          CSC_LINK: ${{ secrets.WINDOWS_CSC_LINK }}
+          GH_TOKEN: ${{ secrets.GH_TOKEN }}
+          IS_CONTINUOUS_INTEGRATION: 1
+        run: |
+          npm install
+          cd packages/app-desktop
+          npm run dist

.travis.yml

@@ -1,112 +0,0 @@
-# Only build tags (Doesn't work - doesn't build anything)
-if: tag IS present OR type = pull_request
-
-rvm: 2.3.3
-
-# It's important to only build production branches otherwise Electron Builder
-# might take assets from dev branches and overwrite those of production.
-# https://docs.travis-ci.com/user/customizing-the-build/#Building-Specific-Branches
-branches:
-  only:
-    - master
-    - /^v\d+\.\d+(\.\d+)?(-\S*)?$/
-
-matrix:
-  include:
-    - os: osx
-      osx_image: xcode9.0
-      language: node_js
-      node_js: "8"
-      env:
-        - ELECTRON_CACHE=$HOME/.cache/electron
-        - ELECTRON_BUILDER_CACHE=$HOME/.cache/electron-builder
-
-    - os: linux
-      sudo: required
-      dist: trusty
-      language: node_js
-      node_js: "8"
-      env:
-        - ELECTRON_CACHE=$HOME/.cache/electron
-        - ELECTRON_BUILDER_CACHE=$HOME/.cache/electron-builder
-
-# cache:
-#   directories:
-#   - node_modules
-#   - $HOME/.cache/electron
-#   - $HOME/.cache/electron-builder
- 
-before_install:
-  # HOMEBREW_NO_AUTO_UPDATE needed so that Homebrew doesn't upgrade to the next
-  # version, which requires Ruby 2.3, which is not available on the Travis VM.
-
-  # Silence apt-get update errors (for example when a module doesn't exist) since
-  # otherwise it will make the whole build fails, even though all we need is yarn.
-  - |
-    if [ "$TRAVIS_OS_NAME" == "osx" ]; then
-      HOMEBREW_NO_AUTO_UPDATE=1 brew install yarn
-    else
-      curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
-      echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
-      sudo apt-get update || true
-      sudo apt-get install -y yarn
-      sudo apt-get install -y gettext
-    fi
-
-script:
-  - |
-    # Install tools
-    npm install
-    cd Tools
-    npm install
-    cd ..
-
-    # Run test units.
-    # Only do it for pull requests because Travis randomly fails to run them
-    # and that would break the desktop release.
-    if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then
-      cd CliClient
-      npm run test
-      testResult=$?
-      if [ $testResult -ne 0 ]; then
-        exit $testResult
-      fi
-      cd ..
-    fi
-
-    # Run linter for pull requests only - this is so that
-    # bypassing eslint is allowed for urgent fixes.
-    if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then
-      npm run linter-ci ./
-      testResult=$?
-      if [ $testResult -ne 0 ]; then
-        exit $testResult
-      fi
-    fi
-
-    # Validate translations - this is needed as some users manually
-    # edit .po files (and often make mistakes) instead of using a proper
-    # tool like poedit. Doing it for Linux only is sufficient.
-    if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then
-      if [ "$TRAVIS_OS_NAME" != "osx" ]; then
-        node Tools/validate-translation.js
-        testResult=$?
-        if [ $testResult -ne 0 ]; then
-          exit $testResult
-        fi
-      fi
-    fi
-
-    # Find out if we should run the build or not. Electron-builder gets stuck when
-    # builing PRs so we disable it in this case. The Linux build should provide
-    # enough info if the app builds or not.
-    # https://github.com/electron-userland/electron-builder/issues/4263
-    if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then
-      if [ "$TRAVIS_OS_NAME" == "osx" ]; then
-        exit 0
-      fi
-    fi
-
-    # Prepare the Electron app and build it
-    cd ElectronClient
-    USE_HARD_LINKS=false yarn dist

Assets/LICENSE

@@ -0,0 +1,3 @@
+All assets in this directory including, but not limited to, logos, icons
+and images are copyright (c) Laurent Cozic, all rights reserved.
+They may not be used without a permission.

Assets/PluginDocTheme/helpers/index.js

@@ -0,0 +1,37 @@
+function camelCaseToDots(s) {
+	const output = [];
+	for (let i = 0; i < s.length; i++) {
+		const c = s[i];
+		if (c === c.toLowerCase() || i === 0) {
+			output.push(c.toLowerCase());
+		} else {
+			output.push('.');
+			output.push(c.toLowerCase());
+		}
+	}
+
+	return output.join('');
+}
+
+module.exports = {
+	jpFormatClassName: function(className) {
+		if (className.indexOf('Joplin') !== 0 || className.indexOf(' ') >= 0) return className;
+
+		const p = className.substr(6);
+		if (p === '') return 'joplin';
+
+		return `joplin.${camelCaseToDots(p)
+			.replace(/menu\.items/, 'menuItems')
+			.replace(/toolbar\.buttons/, 'toolbarButtons')
+			.replace(/content\.scripts/, 'contentScripts')}`;
+	},
+
+	jpIsAllowedGroup: function(name) {
+		return name !== 'Constructors';
+	},
+
+	jsIsNotKindVariable: function(classes) {
+		if (!classes) return true;
+		return classes.indexOf('tsd-kind-variable') < 0;
+	},
+};

Assets/PluginDocTheme/index.md

@@ -0,0 +1,3 @@
+# Joplin Plugin Documentation
+
+Welcome to Joplin Plugin Documentation

Assets/PluginDocTheme/layouts/default.hbs

@@ -0,0 +1,51 @@
+<!doctype html>
+<html class="default no-js">
+<head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <title>{{#ifCond model.name '==' project.name}}{{project.name}}{{else}}{{jpFormatClassName model.name}} | {{project.name}}{{/ifCond}}</title>
+    <meta name="description" content="Documentation for {{project.name}}">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+
+    <link rel="stylesheet" href="{{relativeURL "assets/css/main.css"}}">
+</head>
+<body>
+
+{{> header}}
+
+<div class="container container-main">
+    <div class="row">
+        <div class="col-8 col-content">
+            {{{contents}}}
+        </div>
+        <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
+            <!--
+            <nav class="tsd-navigation primary">
+                <ul>
+                    {{#each navigation.children}}
+                        {{> navigation}}
+                    {{/each}}
+                </ul>
+            </nav>
+            -->
+
+            <nav class="tsd-navigation secondary menu-sticky">
+                <ul class="before-current">
+                    {{#each toc.children}}
+                        {{> toc.root}}
+                    {{/each}}
+                </ul>
+            </nav>
+        </div>
+    </div>
+</div>
+
+{{> footer}}
+
+<div class="overlay"></div>
+<script src="{{relativeURL "assets/js/main.js"}}"></script>
+
+{{> analytics}}
+
+</body>
+</html>

Assets/PluginDocTheme/partials/analytics.hbs

@@ -0,0 +1,11 @@
+{{#if settings.gaID}}
+    <script>
+        (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+            (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+                m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+        })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+        ga('create', '{{settings.gaID}}', '{{settings.gaSite}}');
+        ga('send', 'pageview');
+    </script>
+{{/if}}

Assets/PluginDocTheme/partials/breadcrumb.hbs

@@ -0,0 +1,18 @@
+{{#if parent}}
+    {{#with parent}}{{> breadcrumb}}{{/with}}
+    <li>
+        {{#if url}}
+            <a href="{{relativeURL url}}">{{jpFormatClassName name}}</a>
+        {{else}}
+            <span>{{jpFormatClassName name}}</span>
+        {{/if}}
+    </li>
+{{else}}
+<!--
+    {{#if url}}
+        <li>
+            <a href="{{relativeURL url}}">Globals</a>
+        </li>
+    {{/if}}
+-->
+{{/if}}

Assets/PluginDocTheme/partials/comment.hbs

@@ -0,0 +1,22 @@
+{{#with comment}}
+    {{#if hasVisibleComponent}}
+        <div class="tsd-comment tsd-typography">
+            {{#if shortText}}
+                <div class="lead">
+                    {{#markdown}}{{{shortText}}}{{/markdown}}
+                </div>
+            {{/if}}
+            {{#if text}}
+                {{#markdown}}{{{text}}}{{/markdown}}
+            {{/if}}
+            {{#if tags}}
+                <dl class="tsd-comment-tags">
+                    {{#each tags}}
+                        <dt>{{tagName}}</dt>
+                        <dd>{{#markdown}}{{{text}}}{{/markdown}}</dd>
+                    {{/each}}
+                </dl>
+            {{/if}}
+        </div>
+    {{/if}}
+{{/with}}

Assets/PluginDocTheme/partials/footer.hbs

@@ -0,0 +1,23 @@
+
+<!-- JOPLINCHANGE
+<footer{{#unless settings.hideGenerator}} class="with-border-bottom"{{/unless}}>
+    <div class="container">
+        <h2>Legend</h2>
+        <div class="tsd-legend-group">
+            {{#each legend}}
+                <ul class="tsd-legend">
+                    {{#each .}}
+                        <li class="{{#compact}}{{#each classes}} {{.}}{{/each}}{{/compact}}"><span class="tsd-kind-icon">{{name}}</span></li>
+                    {{/each}}
+                </ul>
+            {{/each}}
+        </div>
+    </div>
+</footer>
+
+{{#unless settings.hideGenerator}}
+    <div class="container tsd-generator">
+        <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
+    </div>
+{{/unless}}
+-->

Assets/PluginDocTheme/partials/header.hbs

@@ -0,0 +1,71 @@
+<header>
+    <div class="tsd-page-toolbar">
+        <div class="container">
+            <div class="table-wrap">
+                <div class="table-cell" id="tsd-search" data-index="{{relativeURL "assets/js/search.json"}}" data-base="{{relativeURL "./"}}">
+                    <div class="field">
+                        <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
+                        <input id="tsd-search-field" type="text" />
+                    </div>
+
+                    <ul class="results">
+                        <li class="state loading">Preparing search index...</li>
+                        <li class="state failure">The search index is not available</li>
+                    </ul>
+
+                    <a href="{{relativeURL "classes/joplin.html"}}" class="title">{{project.name}}</a>
+                </div>
+
+                <div class="table-cell" id="tsd-widgets">
+                    <div id="tsd-filter">
+                        <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
+                        <div class="tsd-filter-group">
+                            <div class="tsd-select" id="tsd-filter-visibility">
+                                <span class="tsd-select-label">All</span>
+                                <ul class="tsd-select-list">
+                                    <li data-value="public">Public</li>
+                                    <li data-value="protected">Public/Protected</li>
+                                    <li data-value="private" class="selected">All</li>
+                                </ul>
+                            </div>
+
+                            <input type="checkbox" id="tsd-filter-inherited" checked />
+                            <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
+
+                            {{#unless settings.excludeExternals}}
+                                <input type="checkbox" id="tsd-filter-externals" checked />
+                                <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
+                            {{/unless}}
+
+                            {{#unless settings.excludeNotExported}}
+                                <input type="checkbox" id="tsd-filter-only-exported" />
+                                <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
+                            {{/unless}}
+                        </div>
+                    </div>
+
+                    <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
+                </div>
+            </div>
+        </div>
+    </div>
+    <div class="tsd-page-title">
+        <div class="container">
+            <ul class="tsd-breadcrumb">
+                {{#with model}}{{> breadcrumb}}{{/with}}
+            </ul>
+            <h1>{{#compact}}
+                <!-- {{model.kindString}}&nbsp; -->
+                {{jpFormatClassName model.name}}
+                {{#if model.typeParameters}}
+                    &lt;
+                    {{#each model.typeParameters}}
+                        {{#if @index}},&nbsp;{{/if}}
+                        {{name}}
+                    {{/each}}
+                    &gt;
+                {{/if}}
+            {{/compact}}</h1>
+        </div>
+    </div>
+</header>

Assets/PluginDocTheme/partials/hierarchy.hbs

@@ -0,0 +1,17 @@
+<ul class="tsd-hierarchy">
+    {{#each types}}
+        <li>
+            {{#if ../isTarget}}
+                <span class="target">{{this}}</span>
+            {{else}}
+                {{#compact}}{{> type}}{{/compact}}
+            {{/if}}
+
+            {{#if @last}}
+                {{#with ../next}}
+                    {{> hierarchy}}
+                {{/with}}
+            {{/if}}
+        </li>
+    {{/each}}
+</ul>

Assets/PluginDocTheme/partials/index.hbs

@@ -0,0 +1,32 @@
+{{#if groups}}
+<section class="tsd-panel-group tsd-index-group">
+    <h2>Index</h2>
+    <section class="tsd-panel tsd-index-panel">
+        <div class="tsd-index-content">
+            {{#each groups}}
+                <section class="tsd-index-section {{cssClasses}}">
+                    {{#if categories}}
+                        {{#each categories}}
+                            <h3>{{#if title}}{{title}} {{/if}}{{../title}}</h3>
+                            <ul class="tsd-index-list">
+                                {{#each children}}
+                                    <li class="{{cssClasses}}"><a href="{{relativeURL url}}" class="tsd-kind-icon">{{#if name}}{{{wbr name}}}{{else}}<em>{{{wbr kindString}}}</em>{{/if}}</a></li>
+                                {{/each}}
+                            </ul>
+                        {{/each}}
+                    {{else}}
+                        {{#if (jpIsAllowedGroup title)}}
+                            <h3>{{title}}</h3>
+                            <ul class="tsd-index-list">
+                                {{#each children}}
+                                    <li class="{{cssClasses}}"><a href="{{relativeURL url}}" class="tsd-kind-icon">{{#if name}}{{{wbr name}}}{{else}}<em>{{{wbr kindString}}}</em>{{/if}}</a></li>
+                                {{/each}}
+                            </ul>
+                        {{/if}}
+                    {{/if}}
+                </section>
+            {{/each}}
+        </div>
+    </section>
+</section>
+{{/if}}

Assets/PluginDocTheme/partials/member.declaration.hbs

@@ -0,0 +1,36 @@
+<div class="tsd-signature tsd-kind-icon">{{#compact}}
+    {{{wbr name}}}
+    {{#if typeParameters}}
+        &lt;
+        {{#each typeParameters}}
+            {{#if @index}},&nbsp;{{/if}}
+            {{name}}
+        {{/each}}
+        &gt;
+    {{/if}}
+    <span class="tsd-signature-symbol">{{#if isOptional}}?{{/if}}:</span>&nbsp;{{#with type}}{{>type}}{{/with}}
+    {{#if defaultValue}}
+        <span class="tsd-signature-symbol">
+        &nbsp;=&nbsp;
+        {{defaultValue}}
+        </span>
+    {{/if}}
+{{/compact}}</div>
+
+{{> member.sources}}
+
+{{> comment}}
+
+{{#if typeParameters}}
+    <h4 class="tsd-type-parameters-title">Type parameters</h4>
+    {{> typeParameters}}
+{{/if}}
+
+{{#if type.declaration}}
+    <div class="tsd-type-declaration">
+        <h4>Type declaration</h4>
+        {{#with type.declaration}}
+            {{> parameter}}
+        {{/with}}
+    </div>
+{{/if}}

Assets/PluginDocTheme/partials/member.getterSetter.hbs

@@ -0,0 +1,37 @@
+<ul class="tsd-signatures {{cssClasses}}">
+    {{#if getSignature}}
+        {{#with getSignature}}
+            <li class="tsd-signature tsd-kind-icon">{{#compact}}
+                <span class="tsd-signature-symbol">get</span>&nbsp;
+                {{../name}}
+                {{> member.signature.title hideName=true }}
+            {{/compact}}</li>
+        {{/with}}
+    {{/if}}
+    {{#if setSignature}}
+        {{#with setSignature}}
+            <li class="tsd-signature tsd-kind-icon">{{#compact}}
+                <span class="tsd-signature-symbol">set</span>&nbsp;
+                {{../name}}
+                {{> member.signature.title hideName=true }}
+            {{/compact}}</li>
+        {{/with}}
+    {{/if}}
+</ul>
+
+<ul class="tsd-descriptions">
+    {{#if getSignature}}
+        {{#with getSignature}}
+            <li class="tsd-description">
+                {{> member.signature.body }}
+            </li>
+        {{/with}}
+    {{/if}}
+    {{#if setSignature}}
+        {{#with setSignature}}
+            <li class="tsd-description">
+                {{> member.signature.body }}
+            </li>
+        {{/with}}
+    {{/if}}
+</ul>

Assets/PluginDocTheme/partials/member.hbs

@@ -0,0 +1,24 @@
+<section class="tsd-panel tsd-member {{cssClasses}}">
+    <a name="{{anchor}}" class="tsd-anchor"></a>
+    {{#if name}}
+        <h3>{{#each flags}}<span class="tsd-flag ts-flag{{this}}">{{this}}</span> {{/each}}{{{wbr name}}}</h3>
+    {{/if}}
+
+    {{#if signatures}}
+        {{> member.signatures}}
+    {{else}}{{#if hasGetterOrSetter}}
+        {{> member.getterSetter}}
+    {{else}}{{#if isReference}}
+        {{> member.reference}}
+    {{else}}
+        {{> member.declaration}}
+    {{/if}}{{/if}}{{/if}}
+
+    {{#each groups}}
+        {{#each children}}
+            {{#unless hasOwnDocument}}
+                {{> member}}
+            {{/unless}}
+        {{/each}}
+    {{/each}}
+</section>

Assets/PluginDocTheme/partials/member.reference.hbs

@@ -0,0 +1,11 @@
+{{#with tryGetTargetReflectionDeep}}
+    {{#ifCond ../name '===' name}}
+        Re-exports <a href="{{relativeURL url}}">{{name}}</a>
+    {{else if flags.isExported}}
+        Renames and re-exports <a href="{{relativeURL url}}">{{name}}</a>
+    {{else}}
+        Renames and exports <a href="{{relativeURL url}}">{{name}}</a>
+    {{/ifCond}}
+{{else}}
+    Re-exports {{name}}
+{{/with}}

Assets/PluginDocTheme/partials/member.signature.body.hbs

@@ -0,0 +1,58 @@
+{{#unless hideSources}}
+    {{> member.sources}}
+{{/unless}}
+
+{{> comment}}
+
+{{#if typeParameters}}
+    <h4 class="tsd-type-parameters-title">Type parameters</h4>
+    {{> typeParameters}}
+{{/if}}
+
+{{#if parameters}}
+    <h4 class="tsd-parameters-title">Parameters</h4>
+    <ul class="tsd-parameters">
+        {{#each parameters}}
+            <li>
+                <h5>{{#compact}}
+                    {{#each flags}}
+                        <span class="tsd-flag ts-flag{{this}}">{{this}}</span>&nbsp;
+                    {{/each}}
+                    {{#if flags.isRest}}<span class="tsd-signature-symbol">...</span>{{/if}}
+                    {{name}}:&nbsp;
+                    {{#with type}}{{>type}}{{/with}}
+                    {{#if defaultValue}}
+                        <span class="tsd-signature-symbol">
+                        &nbsp;=&nbsp;
+                        {{defaultValue}}
+                        </span>
+                    {{/if}}
+                {{/compact}}</h5>
+
+                {{> comment}}
+
+                {{#if type.declaration}}
+                    {{#with type.declaration}}
+                        {{> parameter}}
+                    {{/with}}
+                {{/if}}
+            </li>
+        {{/each}}
+    </ul>
+{{/if}}
+
+<!-- JOPLINCHANGE
+{{#if type}}
+    <h4 class="tsd-returns-title">Returns {{#compact}}{{#with type}}{{>type}}{{/with}}{{/compact}}</h4>
+
+    {{#if comment.returns}}
+        {{#markdown}}{{{comment.returns}}}{{/markdown}}
+    {{/if}}
+
+    {{#if type.declaration}}
+        {{#with type.declaration}}
+            {{> parameter}}
+        {{/with}}
+    {{/if}}
+{{/if}}
+-->

Assets/PluginDocTheme/partials/member.signature.title.hbs

@@ -0,0 +1,32 @@
+{{#unless hideName}}{{{wbr name}}}{{/unless}}
+{{#if typeParameters}}
+    <
+    {{#each typeParameters}}
+        {{#if @index}}, {{/if}}
+        {{name}}
+    {{/each}}
+    >
+{{/if}}
+<span class="tsd-signature-symbol">(</span>
+{{#each parameters}}
+    {{#if @index}},&nbsp;{{/if}}
+    {{#if flags.isRest}}<span class="tsd-signature-symbol">...</span>{{/if}}
+    {{name}}
+    <span class="tsd-signature-symbol">
+        {{#if flags.isOptional}}?{{/if}}
+        {{#if defaultValue}}?{{/if}}
+        :&nbsp;
+    </span>
+    {{#with type}}{{>type}}{{/with}}
+{{/each}}
+<span class="tsd-signature-symbol">)</span>
+{{#if type}}
+    {{#if arrowStyle}}
+        <span class="tsd-signature-symbol"> =&gt; </span>
+    {{else}}
+        <span class="tsd-signature-symbol">: </span>
+    {{/if}}
+    {{#with type}}
+        {{>type}}
+    {{/with}}
+{{/if}}

Assets/PluginDocTheme/partials/member.signatures.hbs

@@ -0,0 +1,13 @@
+<ul class="tsd-signatures {{cssClasses}}">
+    {{#each signatures}}
+        <li class="tsd-signature tsd-kind-icon">{{#compact}}{{> member.signature.title }}{{/compact}}</li>
+    {{/each}}
+</ul>
+
+<ul class="tsd-descriptions">
+    {{#each signatures}}
+        <li class="tsd-description">
+            {{> member.signature.body }}
+        </li>
+    {{/each}}
+</ul>

Assets/PluginDocTheme/partials/member.sources.hbs

@@ -0,0 +1,11 @@
+<aside class="tsd-sources">
+    {{#if implementationOf}}
+        <p>Implementation of {{#with implementationOf}}{{> typeAndParent}}{{/with}}</p>
+    {{/if}}
+    {{#if inheritedFrom}}
+        <p>Inherited from {{#with inheritedFrom}}{{> typeAndParent}}{{/with}}</p>
+    {{/if}}
+    {{#if overwrites}}
+        <p>Overrides {{#with overwrites}}{{> typeAndParent}}{{/with}}</p>
+    {{/if}}
+</aside>

Assets/PluginDocTheme/partials/members.group.hbs

@@ -0,0 +1,23 @@
+{{#if categories}}
+    {{#each categories}}
+        <section class="tsd-panel-group tsd-member-group {{cssClasses}}">
+            <h2>{{#if title}}{{title}} {{/if}}{{../title}}</h2>
+            {{#each children}}
+                {{#unless hasOwnDocument}}
+                    {{> member}}
+                {{/unless}}
+            {{/each}}
+        </section>
+    {{/each}}
+{{else}}
+    <section class="tsd-panel-group tsd-member-group {{cssClasses}}">
+        {{#if (jpIsAllowedGroup title)}}
+            <h2>{{title}}</h2>
+            {{#each children}}
+                {{#unless hasOwnDocument}}
+                    {{> member}}
+                {{/unless}}
+            {{/each}}
+        {{/if}}
+    </section>
+{{/if}}

Assets/PluginDocTheme/partials/members.hbs

@@ -0,0 +1,20 @@
+{{#if categories}}
+    {{#each categories}}
+        {{#unless allChildrenHaveOwnDocument}}
+            <section class="tsd-panel-group tsd-member-group {{cssClasses}}">
+                <h2>{{title}}</h2>
+                {{#each children}}
+                    {{#unless hasOwnDocument}}
+                        {{> member}}
+                    {{/unless}}
+                {{/each}}
+            </section>
+        {{/unless}}
+    {{/each}}
+{{else}}
+    {{#each groups}}
+        {{#unless allChildrenHaveOwnDocument}}
+            {{> members.group}}
+        {{/unless}}
+    {{/each}}
+{{/if}}

Assets/PluginDocTheme/partials/navigation.hbs

@@ -0,0 +1,26 @@
+{{#if isVisible}}
+    {{#if isLabel}}
+        <li class="label {{cssClasses}}">
+            <span>{{{wbr title}}}</span>
+        </li>
+    {{else}}
+        {{#if isGlobals}}
+            <li class="globals {{#if isInPath}}current{{/if}} {{cssClasses}}">
+                <a href="{{relativeURL url}}"><em>{{{wbr title}}}</em></a>
+            </li>
+        {{else}}
+            <li class="{{#if isInPath}}current{{/if}} {{cssClasses}}">
+                <a href="{{relativeURL url}}">{{{wbr title}}}</a>
+                {{#if isInPath}}
+                    {{#if children}}
+                        <ul>
+                            {{#each children}}
+                                {{> navigation}}
+                            {{/each}}
+                        </ul>
+                    {{/if}}
+                {{/if}}
+            </li>
+        {{/if}}
+    {{/if}}
+{{/if}}

Assets/PluginDocTheme/partials/parameter.hbs

@@ -0,0 +1,83 @@
+<ul class="tsd-parameters">
+    {{#if signatures}}
+        <li class="tsd-parameter-signature">
+            <ul class="tsd-signatures {{cssClasses}}">
+                {{#each signatures}}
+                    <li class="tsd-signature tsd-kind-icon">{{#compact}}
+                        {{> member.signature.title hideName=true }}
+                    {{/compact}}</li>
+                {{/each}}
+            </ul>
+
+            <ul class="tsd-descriptions">
+                {{#each signatures}}
+                    <li class="tsd-description">{{> member.signature.body hideSources=true }}</li>
+                {{/each}}
+            </ul>
+        </li>
+    {{/if}}
+    {{#if indexSignature}}
+        <li class="tsd-parameter-index-signature">
+            <h5>{{#compact}}
+                <span class="tsd-signature-symbol">[</span>
+                {{#each indexSignature.parameters}}
+                    {{#if flags.isRest}}<span class="tsd-signature-symbol">...</span>{{/if}}{{name}}:&nbsp;{{#with type}}{{>type}}{{/with}}
+                {{/each}}
+                <span class="tsd-signature-symbol">]:&nbsp;</span>
+                {{#with indexSignature.type}}{{>type}}{{/with}}
+            {{/compact}}</h5>
+
+            {{#with indexSignature}}
+                {{> comment}}
+            {{/with}}
+
+            {{#if indexSignature.type.declaration}}
+                {{#with indexSignature.type.declaration}}
+                    {{> parameter}}
+                {{/with}}
+            {{/if}}
+        </li>
+    {{/if}}
+    {{#each children}}
+        <li class="tsd-parameter">
+            {{#if signatures}}
+                <h5>{{#compact}}
+                    {{#if flags.isRest}}<span class="tsd-signature-symbol">...</span>{{/if}}
+                    {{{wbr name}}}
+                    <span class="tsd-signature-symbol">
+                        {{#if isOptional}}?{{/if}}
+                        :&nbsp;
+                    </span>
+                    function
+                {{/compact}}</h5>
+
+                {{> member.signatures}}
+            {{else}}
+                <h5>{{#compact}}
+                    {{#each flags}}
+                        <span class="tsd-flag ts-flag{{this}}">{{this}}</span>&nbsp;
+                    {{/each}}
+                    {{#if flags.isRest}}<span class="tsd-signature-symbol">...</span>{{/if}}
+                    {{{wbr name}}}
+                    <span class="tsd-signature-symbol">
+                        {{#if flags.isOptional}}?{{/if}}
+                        :&nbsp;
+                    </span>
+                    {{#with type}}{{>type}}{{/with}}
+                {{/compact}}</h5>
+
+                {{> comment}}
+
+                {{#if children}}
+                    {{> parameter}}
+                {{/if}}
+
+                {{#if type.declaration}}
+                    {{#with type.declaration}}
+                        {{> parameter}}
+                    {{/with}}
+                {{/if}}
+            {{/if}}
+        </li>
+    {{/each}}
+</ul>

Assets/PluginDocTheme/partials/toc.hbs

@@ -0,0 +1,10 @@
+<li class="{{#if isInPath}}current{{/if}} {{cssClasses}}">
+    <a href="{{relativeURL url}}" class="tsd-kind-icon">{{{wbr title}}}</a>
+    {{#if children}}
+        <ul>
+            {{#each children}}
+                {{> toc}}
+            {{/each}}
+        </ul>
+    {{/if}}
+</li>

Assets/PluginDocTheme/partials/toc.root.hbs

@@ -0,0 +1,21 @@
+{{#if isInPath}}
+    </ul>
+    <ul class="current">
+{{/if}}
+
+{{#if (jsIsNotKindVariable cssClasses)}}
+    <li class="{{#if isInPath}}current{{/if}} {{cssClasses}}">
+        <a href="{{relativeURL url}}" class="tsd-kind-icon">{{{jpFormatClassName title}}}</a>
+        {{#if children}}
+            <ul>
+                {{#each children}}
+                    {{> toc}}
+                {{/each}}
+            </ul>
+        {{/if}}
+    </li>
+    {{#if isInPath}}
+        </ul>
+        <ul class="after-current">
+    {{/if}}
+{{/if}}

Assets/PluginDocTheme/partials/type.hbs

@@ -0,0 +1,211 @@
+{{! Each type gets its own inline helper to determine how it is rendered. }}
+{{! The name of the helper is the value of the 'type' property on the type.}}
+
+{{!
+The type helper accepts an optional needsParens parameter that is checked
+if an inner type may result in invalid output without them. For example:
+1 | 2[] !== (1 | 2)[]
+() => 1 | 2 !== (() => 1) | 2
+}}
+
+{{#*inline 'array'}}
+    {{#with elementType}}
+        {{> type needsParens=true}}
+        <span class="tsd-signature-symbol">[]</span>
+    {{/with}}
+{{/inline}}
+
+{{#*inline 'conditional'}}
+    {{#if needsParens}}
+        <span class="tsd-signature-symbol">(</span>
+    {{/if}}
+    {{#with checkType}}
+        {{> type needsParens=true}}
+    {{/with}}
+    <span class="tsd-signature-symbol"> extends </span>
+    {{#with extendsType}}
+        {{> type}}
+    {{/with}}
+    <span class="tsd-signature-symbol"> ? </span>
+    {{#with trueType}}
+        {{> type}}
+    {{/with}}
+    <span class="tsd-signature-symbol"> : </span>
+    {{#with falseType}}
+        {{> type}}
+    {{/with}}
+    {{#if needsParens}}
+        <span class="tsd-signature-symbol">)</span>
+    {{/if}}
+{{/inline}}
+
+{{#*inline 'indexedAccess'}}
+    {{#with objectType}}
+        {{> type}}
+    {{/with}}
+    <span class="tsd-signature-symbol">[</span>
+    {{#with indexType}}
+        {{> type}}
+    {{/with}}
+    <span class="tsd-signature-symbol">]</span>
+{{/inline}}
+
+{{#*inline 'inferred'}}
+    <span class="tsd-signature-symbol">infer </span> {{name}}
+{{/inline}}
+
+{{#*inline 'intersection'}}
+    {{#if needsParens}}
+        <span class="tsd-signature-symbol">(</span>
+    {{/if}}
+    {{#each types}}
+        {{#unless @first}}
+            <span class="tsd-signature-symbol"> &amp; </span>
+        {{/unless}}
+        {{> type}}
+    {{/each}}
+    {{#if needsParens}}
+        <span class="tsd-signature-symbol">)</span>
+    {{/if}}
+{{/inline}}
+
+{{#*inline 'intrinsic'}}
+    <span class="tsd-signature-type">{{name}}</span>
+{{/inline}}
+
+{{#*inline 'predicate'}}
+    {{#if asserts}}
+        <span class="tsd-signature-symbol">asserts</span>
+    {{/if}}
+    <span class="tsd-signature-type">{{name}}</span>
+    {{#if targetType}}
+        <span class="tsd-signature-symbol"> is </span>
+        {{#with targetType}}
+            {{>type}}
+        {{/with}}
+    {{/if}}
+{{/inline}}
+
+{{#*inline 'query'}}
+    <span class="tsd-signature-symbol">typeof </span>
+    {{#with queryType}}
+        {{> type}}
+    {{/with}}
+{{/inline}}
+
+{{#*inline 'reference'}}
+    {{#if reflection}}
+        <a href="{{relativeURL reflection.url}}" class="tsd-signature-type">
+            {{jpFormatClassName reflection.name}}
+        </a>
+    {{else}}
+        <span class="tsd-signature-type">{{jpFormatClassName name}}</span>
+    {{/if}}
+    {{#if typeArguments}}
+        <span class="tsd-signature-symbol">&lt;</span>
+        {{#each typeArguments}}
+            {{#unless @first}}
+                <span class="tsd-signature-symbol">, </span>
+            {{/unless}}
+            {{> type}}
+        {{/each}}
+        <span class="tsd-signature-symbol">&gt;</span>
+    {{/if}}
+{{/inline}}
+
+{{#*inline 'reflection'}}
+    {{#if declaration.children}} {{! object literal }}
+        <span class="tsd-signature-symbol">{ </span>
+        {{#each declaration.children}}
+            {{#unless @first}}
+                <span class="tsd-signature-symbol">; </span>
+            {{/unless}}
+            {{name}}
+            {{#if flags.isOptional }}
+                <span class="tsd-signature-symbol">?: </span>
+            {{else}}
+                <span class="tsd-signature-symbol">: </span>
+            {{/if}}
+            {{#with type}}
+                {{> type}}
+            {{else}}
+                <span class="tsd-signature-type">any</span>
+            {{/with}}
+        {{/each}}
+        <span class="tsd-signature-symbol"> }</span>
+    {{else if declaration.signatures}}
+        {{#if (lookup declaration.signatures 1) }} {{! more than one signature}}
+            <span class="tsd-signature-symbol">{ </span>
+            {{#each declaration.signatures}}
+                {{> member.signature.title hideName=true}}
+                {{#unless @last}}
+                    <span class="tsd-signature-symbol">; </span>
+                {{/unless}}
+            {{/each}}
+            <span class="tsd-signature-symbol"> }</span>
+        {{else}}
+            {{#if needsParens}}
+                <span class="tsd-signature-symbol">(</span>
+            {{/if}}
+            {{#with (lookup declaration.signatures '0') }}
+                {{> member.signature.title hideName=true arrowStyle=true}}
+            {{/with}}
+            {{#if needsParens}}
+                <span class="tsd-signature-symbol">)</span>
+            {{/if}}
+        {{/if}}
+    {{else}}
+        <span class="tsd-signature-symbol">{}</span>
+    {{/if}}
+{{/inline}}
+
+{{#*inline 'stringLiteral'}}
+    <span class="tsd-signature-type">"{{value}}"</span>
+{{/inline}}
+
+{{#*inline 'tuple'}}
+    <span class="tsd-signature-symbol">[</span>
+    {{#each elements}}
+        {{#unless @first}}
+            <span class="tsd-signature-symbol">, </span>
+        {{/unless}}
+        {{> type}}
+    {{/each}}
+    <span class="tsd-signature-symbol">]</span>
+{{/inline}}
+
+{{#*inline 'typeOperator'}}
+    <span class="tsd-signature-symbol">{{operator}} </span>
+    {{#with target}}
+        {{> type}}
+    {{/with}}
+{{/inline}}
+
+{{#*inline 'typeParameter'}}
+    <span class="tsd-signature-type">{{name}}</span>
+{{/inline}}
+
+{{#*inline 'union'}}
+    {{#if needsParens}}
+        <span class="tsd-signature-symbol">(</span>
+    {{/if}}
+    {{#each types}}
+        {{#unless @first}}
+            <span class="tsd-signature-symbol"> | </span>
+        {{/unless}}
+        {{> type needsParens=true}}
+    {{/each}}
+    {{#if needsParens}}
+        <span class="tsd-signature-symbol">)</span>
+    {{/if}}
+{{/inline}}
+
+{{#*inline 'unknown'}}
+    <span class="tsd-signature-type">{{name}}</span>
+{{/inline}}
+
+{{#if this}}
+    {{> (lookup . 'type') }}
+{{else}}
+    <span class="tsd-signature-type">void</span>
+{{/if}}

Assets/PluginDocTheme/partials/typeAndParent.hbs

@@ -0,0 +1,42 @@
+{{#compact}}
+    {{#if this}}
+        {{#if elementType}}
+            {{#with elementType}}
+                {{> typeAndParent}}
+            {{/with}}
+            []
+        {{else}}
+            {{#if reflection}}
+                {{#ifSignature reflection}}
+                    {{#if reflection.parent.parent.url}}
+                        <a href="{{relativeURL reflection.parent.parent.url}}">{{reflection.parent.parent.name}}</a>
+                    {{else}}
+                        {{reflection.parent.parent.name}}
+                    {{/if}}
+                    .
+                    {{#if reflection.parent.url}}
+                        <a href="{{relativeURL reflection.parent.url}}">{{reflection.parent.name}}</a>
+                    {{else}}
+                        {{reflection.parent.name}}
+                    {{/if}}
+                {{else}}
+                    {{#if reflection.parent.url}}
+                        <a href="{{relativeURL reflection.parent.url}}">{{reflection.parent.name}}</a>
+                    {{else}}
+                        {{reflection.parent.name}}
+                    {{/if}}
+                    .
+                    {{#if reflection.url}}
+                        <a href="{{relativeURL reflection.url}}">{{reflection.name}}</a>
+                    {{else}}
+                        {{reflection.name}}
+                    {{/if}}
+                {{/ifSignature}}
+            {{else}}
+                {{this}}
+            {{/if}}
+        {{/if}}
+    {{else}}
+        void
+    {{/if}}
+{{/compact}}

Assets/PluginDocTheme/partials/typeParameters.hbs

@@ -0,0 +1,14 @@
+<ul class="tsd-type-parameters">
+    {{#each typeParameters}}
+        <li>
+            <h4>{{#compact}}
+                {{name}}
+                {{#if type}}
+                    <span class="tsd-signature-symbol">:&nbsp;</span>
+                    {{#with type}}{{> type}}{{/with}}
+                {{/if}}
+            {{/compact}}</h4>
+            {{> comment}}
+        </li>
+    {{/each}}
+</ul>

Assets/PluginDocTheme/templates/index.hbs

@@ -0,0 +1,3 @@
+<div class="tsd-panel tsd-typography">
+    {{#markdown}}{{{model.readme}}}{{/markdown}}
+</div>

Assets/PluginDocTheme/templates/reflection.hbs

@@ -0,0 +1,81 @@
+{{#with model}}
+    {{#if hasComment}}
+        <section class="tsd-panel tsd-comment">
+            {{> comment}}
+        </section>
+    {{/if}}
+{{/with}}
+
+{{#if model.typeParameters}}
+    <section class="tsd-panel tsd-type-parameters">
+        <h3>Type parameters</h3>
+        {{#with model}}{{> typeParameters}}{{/with}}
+    </section>
+{{/if}}
+
+{{#if model.typeHierarchy}}
+    <!--
+    <section class="tsd-panel tsd-hierarchy">
+        <h3>Hierarchy</h3>
+        {{#with model.typeHierarchy}}{{> hierarchy}}{{/with}}
+    </section>
+    -->
+{{/if}}
+
+{{#if model.implementedTypes}}
+    <section class="tsd-panel">
+        <h3>Implements</h3>
+        <ul class="tsd-hierarchy">
+            {{#each model.implementedTypes}}
+                <li>{{#compact}}{{> type}}{{/compact}}</li>
+            {{/each}}
+        </ul>
+    </section>
+{{/if}}
+
+{{#if model.implementedBy}}
+    <section class="tsd-panel">
+        <h3>Implemented by</h3>
+        <ul class="tsd-hierarchy">
+            {{#each model.implementedBy}}
+                <li>{{#compact}}{{> type}}{{/compact}}</li>
+            {{/each}}
+        </ul>
+    </section>
+{{/if}}
+
+{{#if model.signatures}}
+    <section class="tsd-panel">
+        <h3 class="tsd-before-signature">Callable</h3>
+        {{#with model}}{{> member.signatures}}{{/with}}
+    </section>
+{{/if}}
+
+{{#if model.indexSignature}}
+    <section class="tsd-panel {{model.cssClasses}}">
+        <h3 class="tsd-before-signature">Indexable</h3>
+        <div class="tsd-signature tsd-kind-icon">{{#compact}}
+            <span class="tsd-signature-symbol">[</span>
+            {{#each model.indexSignature.parameters}}
+                {{name}}:&nbsp;{{#with type}}{{>type}}{{/with}}
+            {{/each}}
+            <span class="tsd-signature-symbol">]:&nbsp;</span>
+            {{#with model.indexSignature.type}}{{>type}}{{/with}}
+        {{/compact}}</div>
+
+        {{#with model.indexSignature}}
+            {{> comment}}
+        {{/with}}
+
+        {{#if model.indexSignature.type.declaration}}
+            {{#with model.indexSignature.type.declaration}}
+                {{> parameter}}
+            {{/with}}
+        {{/if}}
+    </section>
+{{/if}}
+
+{{#with model}}
+    {{> index}}
+    {{> members}}
+{{/with}}

Assets/TinyMCE/IconPack/gulpfile.js

@@ -0,0 +1,27 @@
+const iconPackager = require('@ephox/oxide-icons-tools').iconPackager;
+const clean = require('gulp-clean');
+const gulp = require('gulp');
+const fs = require('fs');
+
+gulp.task('icon-packager', function() {
+	const contents = fs.readFileSync('package.json');
+	const name = JSON.parse(contents).iconPackName;
+
+	return gulp.src('src/svg/**/*.svg')
+		.pipe(iconPackager({ name }))
+		.pipe(gulp.dest('dist'));
+});
+
+gulp.task('deploy', function() {
+	fs.copyFileSync(`${__dirname}/dist/icons/Joplin/icons.js`, `${__dirname}/../../../packages/app-desktop/gui/NoteEditor/NoteBody/TinyMCE/icons.js`);
+	return Promise.resolve();
+});
+
+gulp.task('clean', function() {
+	return gulp.src('./dist', {
+		read: false,
+		allowEmpty: true,
+	}).pipe(clean());
+});
+
+gulp.task('default', gulp.series('clean', 'icon-packager', 'deploy'));

Assets/TinyMCE/JoplinLists/Gruntfile.js

@@ -27,7 +27,7 @@ module.exports = function(grunt) {
 		// },
 
 		shell: {
-			command: 'tsc',
+			command: 'tsc --project tsconfig.json',
 		},
 
 		rollup: {
@@ -125,7 +125,7 @@ module.exports = function(grunt) {
 					// { src: ['changelog.txt'], dest: 'dist', expand: true },
 					{
 						src: ['dist/joplinLists.js'],
-						dest: '../../../ElectronClient/gui/NoteEditor/NoteBody/TinyMCE/plugins/lists.js',
+						dest: '../../../packages/app-desktop/gui/NoteEditor/NoteBody/TinyMCE/plugins/lists.js',
 					},
 				],
 			},

Assets/TinyMCE/JoplinLists/README.md

@@ -0,0 +1,13 @@
+# TinyMCE Joplin Lists Plugin
+
+**As of 2020-11-02 this module no longer builds (a ton of TypeScript errors). No idea why since nothing was changed but should be investigated if modifying this plugin is ever needed.**
+
+This is based on https://github.com/tinymce/tinymce/tree/59748a11303fb7cf00fdb8c9392dcb082ee9d965/modules/tinymce/src/plugins/lists
+
+But with support for Joplin checkboxes.
+
+## Building
+
+Use `npm i && npm run build` to build the plugin, which will also copy the compiled version to the right packages/app-desktop sub-directory.
+
+To test the plugin, use `npm run buildAndStart`, which will build the plugin and start the desktop application.

Assets/TinyMCE/JoplinLists/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "joplin-tinymce-lists",
+  "version": "1.0.0",
+  "description": "",
+  "scripts": {
+    "prepublishOnly": "npm run lint && npm run build",
+    "lint": "tslint src/**/*.ts",
+    "build": "grunt",
+    "test": "bedrock-auto -b phantomjs -d src/test/ts/",
+    "test-manual": "bedrock -d src/test/ts/",
+    "start": "grunt webpack",
+    "buildAndStart": "yarn build && cd .. && cd .. && cd .. && cd packages/app-desktop && npm start"
+  },
+  "keywords": [],
+  "author": "Tiny Technologies Inc.",
+  "devDependencies": {
+    "@ephox/agar": "latest",
+    "@ephox/bedrock": "latest",
+    "@ephox/mcagar": "latest",
+    "@ephox/swag": "latest",
+    "@ephox/tslint-rules": "latest",
+    "awesome-typescript-loader": "^5.2.1",
+    "grunt": "^1.0.4",
+    "grunt-contrib-clean": "^2.0.0",
+    "grunt-contrib-concat": "^1.0.1",
+    "grunt-contrib-copy": "^1.0.0",
+    "grunt-contrib-uglify": "^4.0.0",
+    "grunt-shell": "^2.1.0",
+    "grunt-tslint": "^5.0.2",
+    "grunt-webpack": "^3.1.3",
+    "load-grunt-tasks": "^4.0.0",
+    "tinymce": "latest",
+    "ts-loader": "^5.3.0",
+    "tslib": "^1.9.3",
+    "tslint": "^5.11.0",
+    "typescript": "^3.1.6",
+    "webpack": "^4.25.1",
+    "webpack-livereload-plugin": "^2.1.1"
+  },
+  "files": [
+    "lib/main",
+    "lib/demo",
+    "lib/test",
+    "src",
+    "tsconfig.json",
+    "readme.md",
+    "LEGAL.txt",
+    "LICENSE.txt"
+  ],
+  "main": "./lib/main/ts/api/Main.js",
+  "module": "./lib/main/ts/api/Main.js",
+  "types": "./lib/main/ts/api/Main.d.ts",
+  "license": "Apache-2.0"
+}

Assets/TinyMCE/JoplinLists/src/main/ts/ui/Buttons.ts

@@ -48,7 +48,7 @@ const listState = function (editor: Editor, listName, options:any = {}) {
       // dependent on how the checkbox is styled, so if the style is changed, this might need
       // to be updated too.
       // For the styling, see:
-      // ReactNativeClient/lib/joplin-renderer/MdToHtml/rules/checkbox.ts
+      // packages/renderer/MdToHtml/rules/checkbox.ts
       //
       // The previous solution was to use "pointer-event: none", which mostly work, however
       // it means that links are no longer clickable when they are within the checkbox label.