Android release v1.0.328

File corrected and completed until line 470

.eslintignore

@@ -0,0 +1,77 @@
+*.min.js
+.git/
+.github/
+_mydocs/
+_releases/
+Assets/
+CliClient/build
+CliClient/locales
+CliClient/locales-build
+CliClient/node_modules
+CliClient/tests-build
+CliClient/tests/enex_to_md
+CliClient/tests/html_to_md
+CliClient/tests/logs
+CliClient/tests/support
+CliClient/tests/sync
+CliClient/tests/tmp
+Clipper/content_scripts/JSDOMParser.js
+Clipper/content_scripts/Readability-readerable.js
+Clipper/content_scripts/Readability.js
+Clipper/dist
+Clipper/icons
+Clipper/popup/build
+Clipper/popup/config/webpack.config.js
+Clipper/popup/node_modules
+Clipper/popup/scripts/build.js
+docs/
+ElectronClient/dist
+ElectronClient/gui/editors/TinyMCE/plugins/lists.js
+ElectronClient/lib
+ElectronClient/lib/vendor/sjcl-rn.js
+ElectronClient/lib/vendor/sjcl.js
+ElectronClient/locales
+ElectronClient/node_modules
+ElectronClient/packageInfo.js
+highlight.pack.js
+Modules/TinyMCE/JoplinLists/
+node_modules/
+ReactNativeClient/android
+ReactNativeClient/ios
+ReactNativeClient/lib/joplin-renderer/assets/
+ReactNativeClient/lib/joplin-renderer/vendor/fountain.min.js
+ReactNativeClient/lib/rnInjectedJs/
+ReactNativeClient/lib/vendor/
+ReactNativeClient/lib/welcomeAssets.js
+ReactNativeClient/locales
+ReactNativeClient/node_modules
+ReactNativeClient/pluginAssets/
+readme/
+Server/.git/
+Server/.github/
+Server/bin/
+Server/dist/
+Server/docs/
+Server/node_modules/
+Tools/node_modules
+Tools/PortableAppsLauncher
+Modules/TinyMCE/IconPack/postinstall.js
+
+# AUTO-GENERATED - EXCLUDED TYPESCRIPT BUILD
+ElectronClient/gui/editors/PlainEditor.js
+ElectronClient/gui/editors/TinyMCE.js
+ElectronClient/gui/MultiNoteActions.js
+ElectronClient/gui/NoteContentPropertiesDialog.js
+ElectronClient/gui/NoteText2.js
+ElectronClient/gui/ResourceScreen.js
+ElectronClient/gui/ShareNoteDialog.js
+ElectronClient/gui/utils/NoteText.js
+ReactNativeClient/lib/AsyncActionQueue.js
+ReactNativeClient/lib/joplin-renderer/MdToHtml/rules/checkbox.js
+ReactNativeClient/lib/joplin-renderer/MdToHtml/rules/fence.js
+ReactNativeClient/lib/joplin-renderer/MdToHtml/rules/mermaid.js
+ReactNativeClient/lib/joplin-renderer/MdToHtml/rules/sanitize_html.js
+ReactNativeClient/lib/JoplinServerApi.js
+ReactNativeClient/PluginAssetsLoader.js
+ReactNativeClient/setUpQuickActions.js
+# AUTO-GENERATED - EXCLUDED TYPESCRIPT BUILD

.eslintrc.js

@@ -0,0 +1,107 @@
+module.exports = {
+	'env': {
+		'browser': true,
+		'es6': true,
+		'node': true,
+	},
+	"parser": "@typescript-eslint/parser",
+	'extends': ['eslint:recommended'],
+	"settings": {
+		'react': {
+			'version': '16.12',
+		},
+	},
+	'globals': {
+		'Atomics': 'readonly',
+		'SharedArrayBuffer': 'readonly',
+
+		// Jasmine variables
+		'expect': 'readonly',
+		'describe': 'readonly',
+		'it': 'readonly',
+		'beforeAll': 'readonly',
+		'afterAll': 'readonly',
+		'beforeEach': 'readonly',
+		'afterEach': 'readonly',
+		'jasmine': 'readonly',
+
+		// React Native variables
+		'__DEV__': 'readonly',
+
+		// Clipper variables
+		'browserSupportsPromises_': true,
+		'chrome': 'readonly',
+		'browser': 'readonly',
+
+		'tinymce': 'readonly',
+	},
+	'parserOptions': {
+		'ecmaVersion': 2018,
+		"ecmaFeatures": {
+			"jsx": true,
+	    },
+	    "sourceType": "module",
+	},
+	'rules': {
+		// -------------------------------
+		// Code correctness
+		// -------------------------------
+		"react/jsx-uses-react": "error",
+		"react/jsx-uses-vars": "error",
+		"no-unused-vars": "error",
+		"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"],
+
+		// Checks rules of Hooks
+		"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",
+
+		// -------------------------------
+		// 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"
+		}],
+		"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 }],
+	},
+	"plugins": [
+		"react",
+		"@typescript-eslint",
+		"react-hooks"
+	],
+};

.github/FUNDING.yml

@@ -0,0 +1,5 @@
+# These are supported funding model platforms
+
+patreon: joplin
+github: laurent22
+custom: https://joplinapp.org/donate/

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,9 @@
+👉 Please follow one of these issue templates:
+- https://github.com/laurent22/joplin/issues/new/choose
+
+⚠️
+The GitHub issue tracker is for **bugs** and **security issues** ONLY. For feature requests and support, please use the forum:
+https://discourse.joplinapp.org/
+⚠️
+
+Note: to keep the backlog clean and actionable, issues may be immediately closed if they do not follow one of the above issue templates.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,50 @@
+---
+name: "🐛 Bug Report"
+about: Report a reproducible bug or regression in Joplin.
+title: ''
+labels: 'bug'
+
+---
+
+<!--
+  Please provide a clear and concise description of what the bug is. (In the section Steps To Reproduce.)
+  Include screenshots if needed.
+  Please test using the latest Joplin release to make sure your issue has not already been fixed.
+-->
+
+<!--
+  IMPORTANT: If you are reporting a clipper bug, please include an example URL that shows the issue.
+  Without the URL the issue is likely to be closed.
+-->
+
+## Environment
+
+Joplin version: 
+Platform: 
+OS specifics: 
+
+<!--
+  Platform can be one of: macOS, Linux, Windows, Android, iOS, terminal (or a combination)
+  OS specifics: e.g. OS version, Linux distribution, Android/iOS version...
+-->
+
+## Steps to reproduce
+
+1. 
+2. 
+3. 
+
+<!--
+  Issues without reproduction steps are likely to stall.
+-->
+
+## Describe what you expected to happen
+
+
+
+## Logfile
+
+<!--
+  Please attach a debug log. Issues without a debug log are likely to stall.
+  For information on how to collect a log file: https://joplinapp.org/debugging/
+-->

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,29 @@
+---
+name: "🤔 Questions and Help"
+about: The issue tracker is not for questions. Please ask questions on https://discourse.joplinapp.org/.
+title: ''
+labels: 'invalid'
+
+---
+
+⚠🚨⛔ The issue tracker is not for questions. ⛔🚨⚠
+
+As it happens, support requests that are created as issues are likely to be closed. We want to make sure you are able to find the help you seek.
+
+## Questions and Help
+
+Please read the [documentation](https://joplinapp.org/) and [FAQ](https://joplinapp.org/faq/) first.
+
+### https://discourse.joplinapp.org/
+
+If you have still questions related to Joplin, please open a topic in the [forum](https://discourse.joplinapp.org/).
+You can use your GitHub credentials to login to the forum.
+
+## Links
+
+- Documentation: https://joplinapp.org
+- FAQ: https://joplinapp.org/faq/
+- Forum: https://discourse.joplinapp.org
+- How to enable end-to-end encryption: https://joplinapp.org/e2ee/
+- API documentation: https://joplinapp.org/api/
+- How to enable debug mode: https://joplinapp.org/debugging/

.github/PULL_REQUEST_TEMPLATE

@@ -0,0 +1,15 @@
+<!--
+
+Please prefix the title with the platform you are targetting:
+
+- "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 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"
+
+PLEASE READ THE GUIDE FIRST: https://github.com/laurent22/joplin/blob/master/CONTRIBUTING.md
+
+-->

.github/lock.yml

@@ -0,0 +1,25 @@
+# Configuration for Lock Threads - https://github.com/dessant/lock-threads
+# Number of days of inactivity before a closed issue or pull request is locked
+daysUntilLock: 7
+# Skip issues and pull requests created before a given timestamp. Timestamp must
+# follow ISO 8601 (`YYYY-MM-DD`). Set to `false` to disable
+skipCreatedBefore: false
+# Issues and pull requests with these labels will be ignored. Set to `[]` to disable
+exemptLabels: []
+# Label to add before locking, such as `outdated`. Set to `false` to disable
+lockLabel: false
+# Comment to post before locking. Set to `false` to disable
+lockComment: false
+# Assign `resolved` as the reason for locking. Set to `false` to disable
+setLockReason: false
+# Limit to only `issues` or `pulls`
+only: issues
+# Optionally, specify configuration settings just for `issues` or `pulls`
+# issues:
+#   exemptLabels:
+#     - help-wanted
+#   lockLabel: outdated
+# pulls:
+#   daysUntilLock: 30
+# Repository to extend settings from
+# _extends: repo

.github/stale.yml

@@ -0,0 +1,26 @@
+# Configuration for probot-stale - https://github.com/probot/stale
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 45
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - "good first issue"
+  - "essential"
+  - "essential-reviewed"
+  - "help wanted"
+  - "nice to have"
+  - "upstream"
+  - "backlog"
+  - "high"
+# 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
+markComment: >
+  Hey there, it looks like there has been no activity on this issue recently. Has the issue been fixed, or does it still require the community's attention? This issue may be closed if no further activity occurs.
+  You may comment on the issue and I will leave it open.
+  Thank you for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: >
+  Closing this issue after a prolonged period of inactivity. If this issue is still present in the latest release, please feel free to create a new issue with up-to-date information.
+only: issues

.gitignore

@@ -39,5 +39,31 @@ node_modules
 Tools/github_oauth_token.txt
 _releases
 ReactNativeClient/lib/csstojs/
-ElectronClient/app/gui/note-viewer/fonts/
-Tools/commit_hook.txt
+ReactNativeClient/lib/rnInjectedJs/
+ElectronClient/gui/note-viewer/fonts/
+ElectronClient/gui/note-viewer/lib.js
+Clipper-source/
+Clipper/joplin-webclipper-source.zip
+joplin-webclipper-source.zip
+Tools/commit_hook.txt
+.vscode/*
+*.map
+
+# AUTO-GENERATED - EXCLUDED TYPESCRIPT BUILD
+ElectronClient/gui/editors/PlainEditor.js
+ElectronClient/gui/editors/TinyMCE.js
+ElectronClient/gui/MultiNoteActions.js
+ElectronClient/gui/NoteContentPropertiesDialog.js
+ElectronClient/gui/NoteText2.js
+ElectronClient/gui/ResourceScreen.js
+ElectronClient/gui/ShareNoteDialog.js
+ElectronClient/gui/utils/NoteText.js
+ReactNativeClient/lib/AsyncActionQueue.js
+ReactNativeClient/lib/joplin-renderer/MdToHtml/rules/checkbox.js
+ReactNativeClient/lib/joplin-renderer/MdToHtml/rules/fence.js
+ReactNativeClient/lib/joplin-renderer/MdToHtml/rules/mermaid.js
+ReactNativeClient/lib/joplin-renderer/MdToHtml/rules/sanitize_html.js
+ReactNativeClient/lib/JoplinServerApi.js
+ReactNativeClient/PluginAssetsLoader.js
+ReactNativeClient/setUpQuickActions.js
+# AUTO-GENERATED - EXCLUDED TYPESCRIPT BUILD

.travis.yml

@@ -1,8 +1,16 @@
 # Only build tags (Doesn't work - doesn't build anything)
-if: tag IS present
+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
@@ -42,12 +50,63 @@ before_install:
       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 ../ElectronClient/app
-    rsync -aP --delete ../../ReactNativeClient/lib/ lib/
-    npm install && yarn dist
+    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/JoplinIcon.svg

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:cc="http://creativecommons.org/ns#" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:svg="http://www.w3.org/2000/svg" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 682.66669 682.66669" height="682.66669" width="682.66669" xml:space="preserve" id="svg2" version="1.1">
+  <defs id="defs6">
+    <linearGradient id="linearGradient26" spreadMethod="pad" gradientTransform="matrix(-4387.91,4387.91,4387.91,4387.91,4753.95,366.05)" gradientUnits="userSpaceOnUse" y2="0" x2="1" y1="0" x1="0">
+      <stop id="stop22" offset="0" style="stop-opacity:1;stop-color:#004caf"/>
+      <stop id="stop24" offset="1" style="stop-opacity:1;stop-color:#1f95f8"/>
+    </linearGradient>
+  </defs>
+  <g transform="matrix(1.3333333,0,0,-1.3333333,0,682.66667)" id="g10">
+    <g transform="scale(0.1)" id="g12">
+      <g id="g14">
+        <g clip-path="url(#clipPath20)" id="g16">
+          <path id="path28" style="fill:url(#linearGradient26);fill-opacity:1;fill-rule:nonzero;stroke:none" d="M 3873.89,0 H 1246.11 C 560.754,0 0,560.75 0,1246.11 V 3873.88 C 0,4559.25 560.754,5120 1246.11,5120 H 3873.89 C 4559.25,5120 5120,4559.25 5120,3873.88 V 1246.11 C 5120,560.75 4559.25,0 3873.89,0"/>
+        </g>
+      </g>
+      <path id="path30" style="fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none" d="M 3961.59,4435.23 H 2570.18 c -13.15,0 -23.78,-10.64 -23.78,-23.77 v -441.84 c 0,-14.87 12.04,-26.92 26.92,-26.92 h 190.77 c 77.16,0 139.73,-59.35 146.43,-134.77 V 3505 3336.23 1728.75 1717.36 h -0.05 c 0.48,-16.84 -0.19,-33.4 -1.83,-49.71 -0.18,-2.38 -0.5,-4.73 -0.79,-7.09 -1.1,-9.53 -2.32,-19.01 -4.17,-28.29 -1.01,-5.29 -2.44,-10.44 -3.71,-15.65 -1.71,-6.93 -3.09,-13.97 -5.22,-20.75 -12.58,-40.27 -32.47,-77.62 -59.98,-110.5 -1.01,-1.17 -2.26,-2.25 -3.26,-3.41 -8.39,-9.72 -17.2,-19.19 -26.95,-28.06 -9.84,-8.95 -20.26,-17.27 -31.21,-25 -77.84,-55.14 -182.61,-79.4 -299.67,-68.2 -149.26,14.03 -297.34,81.72 -417.03,190.62 -119.67,108.89 -194.08,243.62 -209.48,379.41 -13.85,121.48 22.55,228.38 102.42,301.05 0.21,0.16 0.4,0.31 0.56,0.48 3.09,2.77 6.49,5.2 9.67,7.87 57.16,47.89 131.67,76.91 216.7,84.91 0.96,0.09 1.88,0.24 2.79,0.32 8.95,0.79 18.07,1.15 27.27,1.49 4.81,0.16 9.56,0.5 14.44,0.54 1.62,0.02 3.16,0.19 4.78,0.19 2.9,0 5.91,-0.38 8.81,-0.42 13.4,-0.21 26.9,-0.76 40.67,-1.94 1.74,-0.14 3.4,-0.08 5.19,-0.24 1.27,-0.13 2.53,-0.41 3.8,-0.54 78,-7.82 155.23,-31.11 228.52,-66.4 1.53,-0.07 3.3,-0.54 5.51,-1.76 22.34,-12.34 26.62,0.9 27.28,9.65 v 382.24 282.82 c 0,19.05 -13.25,35.9 -31.83,39.99 -394.76,86.88 -782.08,-3.55 -1055.38,-252.34 -238.75,-217.18 -354.24,-530.58 -316.82,-859.79 33.39,-293.23 183.91,-574.94 423.88,-793.33 233.89,-212.79 531.69,-345.86 838.88,-374.801 42.33,-3.918 84.86,-5.938 126.36,-5.938 293.38,0 565.61,100.598 766.54,283.379 190.34,173.3 304.35,411.27 321.08,670.16 l 1.55,1697.91 h 0.17 v 453.97 h 0.06 v 7.92 c 1.72,80.12 67.05,144.58 147.61,144.58 h 190.77 c 14.86,0 26.92,12.05 26.92,26.92 v 441.84 c 0,13.13 -10.63,23.77 -23.78,23.77"/>
+    </g>
+  </g>
+</svg>

Assets/JoplinIconBlack.svg

@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   id="svg40"
+   version="1.1"
+   width="1536"
+   height="1536"
+   viewBox="0 0 1536 1536">
+  <metadata
+     id="metadata46">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+        <dc:title></dc:title>
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <defs
+     id="defs44" />
+  <path
+     id="path38"
+     fill="#ffffff"
+     d="M 373.834,0 C 168.227,0 0,168.223 0,373.834 V 1162.17 C 0,1367.778 168.227,1536 373.834,1536 H 1162.17 C 1367.778,1536 1536,1367.778 1536,1162.17 V 373.834 C 1536,168.224 1367.778,0 1162.17,0 Z m 397.222,205.431 h 417.424 a 7.132,7.132 0 0 1 7.132,7.133 v 132.552 c 0,4.461 -3.619,8.073 -8.077,8.073 h -57.23 c -24.168,0 -43.768,19.338 -44.284,43.374 v 2.377 h -0.017 v 136.191 h -0.053 l -0.466,509.375 c -5.02,77.667 -39.222,149.056 -96.324,201.046 -60.28,54.834 -141.948,85.017 -229.962,85.017 -12.45,0 -25.208,-0.61 -37.907,-1.785 -92.157,-8.682 -181.494,-48.601 -251.662,-112.438 -71.99,-65.517 -117.147,-150.03 -127.164,-238 -11.226,-98.763 23.42,-192.783 95.045,-257.937 81.99,-74.637 198.185,-101.768 316.613,-75.704 5.574,1.227 9.55,6.282 9.55,11.997 v 199.52 c -0.199,2.625 -1.481,6.599 -8.183,2.896 -0.663,-0.365 -1.194,-0.511 -1.653,-0.531 -21.987,-10.587 -45.159,-17.57 -68.559,-19.916 -0.38,-0.04 -0.757,-0.124 -1.138,-0.163 -0.537,-0.048 -1.034,-0.033 -1.556,-0.075 -4.13,-0.354 -8.183,-0.517 -12.203,-0.58 -0.87,-0.011 -1.771,-0.127 -2.641,-0.127 -0.486,0 -0.951,0.05 -1.437,0.057 -1.464,0.011 -2.886,0.115 -4.33,0.163 -2.76,0.102 -5.497,0.211 -8.182,0.448 -0.273,0.024 -0.547,0.07 -0.835,0.097 -25.509,2.4 -47.864,11.104 -65.012,25.47 -0.954,0.802 -1.974,1.53 -2.9,2.36 a 1.34,1.34 0 0 1 -0.168,0.146 c -23.96,21.8 -34.881,53.872 -30.726,90.316 4.62,40.737 26.94,81.156 62.841,113.823 35.908,32.67 80.335,52.977 125.113,57.186 35.118,3.36 66.547,-3.919 89.899,-20.461 a 97.255,97.255 0 0 0 9.365,-7.501 c 2.925,-2.661 5.569,-5.5 8.086,-8.416 0.3,-0.348 0.672,-0.673 0.975,-1.024 8.253,-9.864 14.222,-21.067 17.996,-33.148 0.639,-2.034 1.051,-4.148 1.564,-6.227 0.381,-1.563 0.81,-3.106 1.112,-4.693 0.555,-2.784 0.923,-5.632 1.253,-8.49 0.086,-0.709 0.183,-1.414 0.237,-2.128 0.492,-4.893 0.693,-9.858 0.55,-14.91 h 0.013 V 393.623 c -2.01,-22.626 -20.78,-40.434 -43.928,-40.434 h -57.23 a 8.071,8.071 0 0 1 -8.077,-8.073 V 212.564 a 7.132,7.132 0 0 1 7.136,-7.133 z" />
+</svg>

Assets/JoplinLetter.eps

@@ -0,0 +1,96 @@
+%!PS-Adobe-3.0 EPSF-3.0
+%%Creator: cairo 1.15.6 (http://cairographics.org)
+%%CreationDate: Wed Dec 04 10:22:47 2019
+%%Pages: 1
+%%DocumentData: Clean7Bit
+%%LanguageLevel: 2
+%%BoundingBox: 0 0 331 372
+%%EndComments
+%%BeginProlog
+save
+50 dict begin
+/q { gsave } bind def
+/Q { grestore } bind def
+/cm { 6 array astore concat } bind def
+/w { setlinewidth } bind def
+/J { setlinecap } bind def
+/j { setlinejoin } bind def
+/M { setmiterlimit } bind def
+/d { setdash } bind def
+/m { moveto } bind def
+/l { lineto } bind def
+/c { curveto } bind def
+/h { closepath } bind def
+/re { exch dup neg 3 1 roll 5 3 roll moveto 0 rlineto
+      0 exch rlineto 0 rlineto closepath } bind def
+/S { stroke } bind def
+/f { fill } bind def
+/f* { eofill } bind def
+/n { newpath } bind def
+/W { clip } bind def
+/W* { eoclip } bind def
+/BT { } bind def
+/ET { } bind def
+/pdfmark where { pop globaldict /?pdfmark /exec load put }
+    { globaldict begin /?pdfmark /pop load def /pdfmark
+    /cleartomark load def end } ifelse
+/BDC { mark 3 1 roll /BDC pdfmark } bind def
+/EMC { mark /EMC pdfmark } bind def
+/cairo_store_point { /cairo_point_y exch def /cairo_point_x exch def } def
+/Tj { show currentpoint cairo_store_point } bind def
+/TJ {
+  {
+    dup
+    type /stringtype eq
+    { show } { -0.001 mul 0 cairo_font_matrix dtransform rmoveto } ifelse
+  } forall
+  currentpoint cairo_store_point
+} bind def
+/cairo_selectfont { cairo_font_matrix aload pop pop pop 0 0 6 array astore
+    cairo_font exch selectfont cairo_point_x cairo_point_y moveto } bind def
+/Tf { pop /cairo_font exch def /cairo_font_matrix where
+      { pop cairo_selectfont } if } bind def
+/Td { matrix translate cairo_font_matrix matrix concatmatrix dup
+      /cairo_font_matrix exch def dup 4 get exch 5 get cairo_store_point
+      /cairo_font where { pop cairo_selectfont } if } bind def
+/Tm { 2 copy 8 2 roll 6 array astore /cairo_font_matrix exch def
+      cairo_store_point /cairo_font where { pop cairo_selectfont } if } bind def
+/g { setgray } bind def
+/rg { setrgbcolor } bind def
+/d1 { setcachedevice } bind def
+/cairo_flush_ascii85_file { cairo_ascii85_file status { cairo_ascii85_file flushfile } if } def
+/cairo_image { image cairo_flush_ascii85_file } def
+/cairo_imagemask { imagemask cairo_flush_ascii85_file } def
+%%EndProlog
+%%BeginSetup
+%%EndSetup
+%%Page: 1 1
+%%BeginPageSetup
+%%PageBoundingBox: 0 0 331 372
+%%EndPageSetup
+q 0 0 331 372 rectclip
+1 0 0 -1 0 372 cm q
+0 g
+116.223 371.219 m 92.629 368.047 79.551 364.387 63.867 356.57 c 34.902 
+342.121 12.555 317.016 3.848 289.133 c 0.383 278.039 -0.012 275.32 0 262.508
+ c 0.008 251.938 0.258 249.27 1.699 244.234 c 4.723 233.676 8.77 226.742
+ 16.426 219.008 c 25.66 209.676 35.293 205.477 48.723 204.93 c 61.566 204.41
+ 70.113 206.629 78.211 212.594 c 83.371 216.391 88.637 223.828 91.578 231.484
+ c 93.445 236.34 93.59 237.676 94.133 255.008 c 94.699 273.145 95.164 276.641
+ 98.078 284.684 c 102.059 295.672 108.82 303.285 118.855 308.086 c 127.93
+ 312.426 134.84 313.762 146.094 313.348 c 153.41 313.078 156.309 312.625
+ 160.699 311.07 c 173.777 306.434 184.691 296.008 189.934 283.133 c 195.355
+ 269.828 195.344 270.066 195.328 160.883 c 195.313 65.117 195.297 64.098
+ 193.781 60.758 c 190.078 52.586 186.18 51.125 166.371 50.488 c 151.848 
+50.02 l 151.848 0 l 329.973 0.383 l 330.168 25.199 l 330.367 50.02 l 315.918
+ 50.527 l 307.902 50.809 300.027 51.465 298.23 52.004 c 293.328 53.461 290.211
+ 56.363 288.234 61.305 c 286.504 65.633 l 286.027 164.258 l 285.547 264.215
+ 285.48 266.555 282.668 280.234 c 277.531 305.25 259.137 330.953 234.594
+ 347.406 c 214.891 360.621 193.523 367.852 164.223 371.227 c 156.445 372.121
+ 122.898 372.117 116.223 371.219 c h
+116.223 371.219 m f
+Q Q
+showpage
+%%Trailer
+end restore
+%%EOF

Assets/JoplinLetter.svg

@@ -0,0 +1,69 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   viewBox="0 0 682.66669 682.66669"
+   height="682.66669"
+   width="682.66669"
+   xml:space="preserve"
+   id="svg2"
+   version="1.1"
+   sodipodi:docname="JoplinLetter.svg"
+   inkscape:version="1.0beta1 (32d4812, 2019-09-19)"><metadata
+   id="metadata23">
+  <rdf:RDF>
+    <cc:Work
+   rdf:about="">
+      <dc:format>image/svg+xml</dc:format>
+
+      <dc:type
+   rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+
+      <dc:title></dc:title>
+
+    </cc:Work>
+
+  </rdf:RDF>
+
+</metadata>
+
+<sodipodi:namedview
+   pagecolor="#ffffff"
+   bordercolor="#666666"
+   inkscape:document-rotation="0"
+   borderopacity="1"
+   objecttolerance="10"
+   gridtolerance="10"
+   guidetolerance="10"
+   inkscape:pageopacity="0"
+   inkscape:pageshadow="2"
+   inkscape:window-width="1600"
+   inkscape:window-height="907"
+   id="namedview21"
+   showgrid="false"
+   inkscape:zoom="0.35"
+   inkscape:cx="400"
+   inkscape:cy="560"
+   inkscape:window-x="0"
+   inkscape:window-y="23"
+   inkscape:window-maximized="0"
+   inkscape:current-layer="svg2" />
+
+
+  <defs
+   id="defs6" />
+
+
+  <path
+   id="path30"
+   style="opacity:1;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.133333;stop-opacity:1"
+   d="M 528.21199,91.302685 H 342.69066 c -1.75334,0 -3.17067,1.418666 -3.17067,3.169333 v 58.912002 c 0,1.98266 1.60533,3.58933 3.58933,3.58933 h 25.436 c 10.288,0 18.63067,7.91333 19.524,17.96933 v 40.39067 22.50266 214.33067 1.51866 h -0.007 c 0.064,2.24534 -0.0253,4.45334 -0.244,6.628 -0.024,0.31734 -0.0667,0.63067 -0.10534,0.94534 -0.14666,1.27066 -0.30933,2.53466 -0.556,3.772 -0.13466,0.70533 -0.32533,1.392 -0.49466,2.08666 -0.228,0.924 -0.412,1.86267 -0.696,2.76667 -1.67734,5.36933 -4.32934,10.34933 -7.99734,14.73333 -0.13466,0.156 -0.30133,0.3 -0.43466,0.45467 -1.11867,1.296 -2.29334,2.55866 -3.59334,3.74133 -1.312,1.19333 -2.70133,2.30267 -4.16133,3.33333 -10.37867,7.352 -24.348,10.58667 -39.956,9.09334 -19.90133,-1.87067 -39.64533,-10.896 -55.604,-25.416 -15.956,-14.51867 -25.87733,-32.48267 -27.93066,-50.588 -1.84667,-16.19733 3.00666,-30.45067 13.656,-40.14 0.028,-0.0213 0.0533,-0.0413 0.0747,-0.064 0.412,-0.36933 0.86534,-0.69333 1.28934,-1.04933 7.62133,-6.38534 17.556,-10.25467 28.89333,-11.32134 0.128,-0.012 0.25067,-0.032 0.372,-0.0427 1.19333,-0.10534 2.40933,-0.15334 3.636,-0.19867 0.64133,-0.0213 1.27467,-0.0667 1.92533,-0.072 0.216,-0.003 0.42134,-0.0253 0.63734,-0.0253 0.38666,0 0.788,0.0507 1.17466,0.056 1.78667,0.028 3.58667,0.10133 5.42267,0.25866 0.232,0.0187 0.45333,0.0107 0.692,0.032 0.16933,0.0173 0.33733,0.0547 0.50667,0.072 10.4,1.04267 20.69733,4.148 30.46933,8.85334 0.204,0.009 0.44,0.072 0.73466,0.23466 2.97867,1.64534 3.54934,-0.12 3.63734,-1.28666 V 329.57734 291.868 c 0,-2.54 -1.76667,-4.78666 -4.244,-5.332 -52.63467,-11.584 -104.27733,0.47334 -140.71733,33.64534 -31.83333,28.95733 -47.232,70.74399 -42.24267,114.63866 4.452,39.09733 24.52134,76.65866 56.51733,105.77733 31.18534,28.372 70.892,46.11467 111.85067,49.97347 5.644,0.5224 11.31467,0.79173 16.848,0.79173 39.11733,0 75.41466,-13.41307 102.20533,-37.78387 25.37867,-23.10666 40.58,-54.836 42.81066,-89.35466 l 0.20667,-226.388 h 0.0227 v -60.52933 h 0.008 v -1.056 c 0.22933,-10.68266 8.94,-19.27733 19.68133,-19.27733 h 25.436 c 1.98133,0 3.58933,-1.60667 3.58933,-3.58933 V 94.472018 c 0,-1.750667 -1.41733,-3.169333 -3.17066,-3.169333"
+   inkscape:connector-curvature="0" />
+
+
+</svg>

BUILD.md

@@ -1,61 +1,87 @@
-# General information
+ [![Travis Build Status](https://travis-ci.org/laurent22/joplin.svg?branch=master)](https://travis-ci.org/laurent22/joplin) [![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/github/laurent22/joplin?branch=master&passingText=master%20-%20OK&svg=true)](https://ci.appveyor.com/project/laurent22/joplin)
 
-- All the applications share the same library, which, for historical reasons, is in ReactNativeClient/lib. This library is copied to the relevant directories when building each app.
-- The translations are built by running CliClient/build-translation.sh. You normally don't need to run this if you haven't updated the translation since the compiled files are on the repository.
+# Building the applications
 
-## macOS dependencies
+Note that all the applications share the same library, which, for historical reasons, is in `ReactNativeClient/lib`. This library is copied to the relevant directories when building each app.
 
-	brew install yarn node
-	echo 'export PATH="/usr/local/opt/gettext/bin:$PATH"' >> ~/.bash_profile
-	source ~/.bash_profile
-     
-If you get a node-gyp related error you might need to manually install it: `npm install -g node-gyp`
-
-## Linux and Windows (WSL) dependencies
+## Required dependencies
 
 - Install yarn - https://yarnpkg.com/lang/en/docs/install/
-- Install node v8.x (check with `node --version`) - https://nodejs.org/en/
-- If you get a node-gyp related error you might need to manually install it: `npm install -g node-gyp`
+- Install node - https://nodejs.org/en/
 
-# Building the tools
+## Building
 
-Before building any of the applications, you need to build the tools:
+Before doing anything else, from the root of the project, run:
 
-```
-cd Tools
-npm install
+	npm install
+
+Then you can test the various applications:
+
+## Testing the desktop application
+
+	cd ElectronClient
+	npm start
+
+## Testing the Terminal application
+
+	cd CliClient
+	npm start
+
+## Testing the Mobile application
+
+First you need to setup React Native to build projects with native code. For this, follow the instructions on the [Get Started](https://facebook.github.io/react-native/docs/getting-started.html) tutorial, in the "React Native CLI Quickstart" tab.
+
+Then:
+
+	cd ReactNativeClient
+	npm run start-android
+	# Or: npm run start-ios
+
+To run the iOS application, it might be easier to open the file `ios/Joplin.xcworkspace` on XCode and run the app from there.
+
+Normally the bundler should start automatically with the application. If it doesn't, run `npm start`.
+
+## Building the clipper
+
+	cd Clipper/popup
+	npm install
+	npm run watch # To watch for changes
+
+To test the extension please refer to the relevant pages for each browser: [Firefox](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Your_first_WebExtension#Trying_it_out) / [Chrome](https://developer.chrome.com/extensions/faq#faq-dev-01). Please note that the extension in dev mode will only connect to a dev instance of the desktop app (and vice-versa).
+
+## Watching files
+
+To make changes to the application, you'll need to rebuild any TypeScript file you've changed, and rebuild the lib. The simplest way to do all this is to watch for changes from the root of the project. Simply run this command, and it should take care of the rest:
+
+	npm run watch
+
+Running `npm run build` would have the same effect, but without watching.
+
+## Running an application with additional parameters
+
+You can specify additional parameters when running the desktop or CLI application. To do so, add `--` to the `npm start` command, followed by your flags. For example:
+
+	npm start -- --profile ~/MyTestProfile
+
+## TypeScript
+
+Most of the application is written in JavaScript, however new classes and files should generally be written in [TypeScript](https://www.typescriptlang.org/). All TypeScript files are generated next to the .ts or .tsx file. So for example, if there's a file "lib/MyClass.ts", there will be a generated "lib/MyClass.js" next to it. It is implemented that way as it requires minimal changes to integrate TypeScript in the existing JavaScript code base.
+
+## Hot reload
+
+If you'd like to auto-reload the desktop app on changes rather than having to quit and restart it manually each time, you can use [watchman-make](https://facebook.github.io/watchman/docs/watchman-make.html):
+
+```sh
+cd ElectronClient
+watchman-make -p '**/*.js' '**/*.jsx' --run "npm start"
 ```
 
-# Building the Electron application
+It still requires you to quit the application each time you want it to rebuild, but at least you don't have to re-run `"npm start"` each time. Here's what the workflow loop looks like in practice:
 
-```
-cd ElectronClient/app
-rsync --delete -a ../../ReactNativeClient/lib/ lib/
-npm install
-yarn dist
-```
+1. Edit and save files in your text editor.
+2. Switch to the Electron app and <kbd>cmd</kbd>+<kbd>Q</kbd> to quit it.
+3. `watchman` immediately restarts the app for you (whereas usually you'd have to switch back to the terminal, type `"npm start"`, and hit enter).
 
-If there's an error `while loading shared libraries: libgconf-2.so.4: cannot open shared object file: No such file or directory`, run `sudo apt-get install libgconf-2-4`
+# Troubleshooting
 
-For node-gyp to work, you might need to install the `windows-build-tools` using `npm install --global windows-build-tools`.
-
-That will create the executable file in the `dist` directory.
-
-From `/ElectronClient` you can also run `run.sh` to run the app for testing.
-
-# Building the Mobile application
-
-First you need to setup React Native to build projects with native code. For this, follow the instructions on the [Get Started](https://facebook.github.io/react-native/docs/getting-started.html) tutorial, in the "Building Projects with Native Code" tab.
-
-Then, from `/ReactNativeClient`, run `npm install`, then `react-native run-ios` or `react-native run-android`.
-
-# Building the Terminal application
-
-```
-cd CliClient
-npm install
-./build.sh
-rsync --delete -aP ../ReactNativeClient/locales/ build/locales/
-```
-
-Run `run.sh` to start the application for testing.
+Please read for the [Build Troubleshooting Document](https://github.com/laurent22/joplin/blob/master/readme/build_troubleshooting.md) for various tips on how to get the build working.

CONTRIBUTING.md

@@ -1,20 +1,91 @@
+# User support
+
+The [Joplin Forum](https://discourse.joplinapp.org/) is the community driven place for user support, general discussion about Joplin, problems with installation, new features and software development questions. It is possible to login with your GitHub account. Don't use the issue tracker for support questions.
+
 # Reporting a bug
 
-Please check first that it [has not already been reported](https://github.com/laurent22/joplin/issues?utf8=%E2%9C%93&q=is%3Aissue). Also consider [enabling debug mode](https://github.com/laurent22/joplin/blob/master/README_debugging.md) before reporting the issue so that you can provide as much details as possible to help fix it.
+File bugs in the [Github Issue Tracker](https://github.com/laurent22/joplin/issues?utf8=%E2%9C%93&q=is%3Aissue). Please follow these guidelines:
 
-If possible, **please provide a screenshot**. A screenshot showing the problem is often more useful than a paragraph describing it as it can make it immediately clear what the issue is.
+- Search existing issues first, make sure yours hasn't already been reported.
+- Please follow the template.
+- Consider [enabling debug mode](https://joplinapp.org/debugging/) so that you can provide as much details as possible when reporting the issue.
+- Stay on topic, but describe the issue in detail so that others can **reproduce** it.
+- **Provide a screenshot** if possible. A screenshot showing the problem is often more useful than a paragraph describing it.
+- For web clipper bugs, **please provide the URL causing the issue**. Sometimes the clipper works in one page but not in another so it is important to know what URL has a problem.
 
 # Feature requests
 
-Again, please check that it has not already been requested. If it has, simply **up-vote the issue** - the ones with the most up-votes are likely to be implemented. Adding a "+1" comment does nothing.
+Feature requests **must be opened and discussed on the [forum](https://discourse.joplinapp.org/c/features)**. After they have been accepted, they can be added to the GitHub tracker.
 
-# Adding new features
+Please check that your request has not already been posted on the forum or the [Github Issue Tracker](https://github.com/laurent22/joplin/issues?utf8=%E2%9C%93&q=is%3Aissue). If it has, **up-voting the issue or topic** increases the chances it'll be noticed and implemented in the future. "+1" comments are not tracked.
 
-If you want to add a new feature, consider asking about it before implementing it to make sure it is within the scope of the project. Of course you are free to create the pull request directly but it is not guaranteed it is going to be accepted.
+Avoid listing multiple requests in one topic. One topic per request makes it easier to track and discuss it.
+
+Finally, when submitting a pull request, don't forget to [test your code](#unit-tests).
+
+# Contributing to Joplin's translation
+
+Joplin is available in multiple languages thanks to the help of its users. You can help translate Joplin to your language or keep it up to date. Please read the documentation about [Localisation](https://joplinapp.org/#localisation).
+
+# Contributing to Joplin's code
+
+If you want to start contributing to the project's code, please follow these guidelines before creating a pull request: 
+
+- Bug fixes are always welcome. Start by reviewing the [list of bugs](https://github.com/laurent22/joplin/issues?q=is%3Aissue+is%3Aopen+label%3Abug)
+- A good way to easily start contributing is to pick and work on a [good first issue](https://github.com/laurent22/joplin/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22). We try to make these issues as clear as possible and provide basic info on how the code should be changed, and if something is unclear feel free to ask for more information on the issue.
+- Before adding a new feature, ask about it in the [Github Issue Tracker](https://github.com/laurent22/joplin/issues?utf8=%E2%9C%93&q=is%3Aissue) or the [Joplin Forum](https://discourse.joplinapp.org/), or check if existing discussions exist to make sure the new functionality is desired.
+- **Changes that will consist in more than 50 lines of code should be discussed the [Joplin Forum](https://discourse.joplinapp.org/)**, so that you don't spend too much time implementing something that might not be accepted.
+- All the applications share the same backend (database, synchronisation, settings, models, business logic, etc.) so if you change something in the backend in one app, makes sure it still work in the other apps. Usually it does, but keep this in mind.
 
 Building the apps is relatively easy - please [see the build instructions](https://github.com/laurent22/joplin/blob/master/BUILD.md) for more details.
 
-# Coding style
+## Coding style
 
-- Only use tabs for indentation, not spaces.
-- Do not remove or add optional characters from other lines (such as colons or new line characters) as it can make the commit needlessly big, and create conflicts with other changes.
+Coding style is enforced by a pre-commit hook that runs eslint. This hook is installed whenever running `npm install` on any of the application directory. If for some reason the pre-commit hook didn't get installed, you can manually install it by running `npm install` at the root of the repository.
+
+For new React components, please use [React Hooks](https://reactjs.org/docs/hooks-intro.html). For new code in general, please use TypeScript (unless you are modifying a file that was originally in JavaScript).
+
+For changes made to the Desktop client that affect the user interface, refer to `ElectronClient/app/theme.js` for all styling information. The goal is to create a consistent user interface to allow for easy navigation of Joplin's various features and improve the overall user experience.
+
+## Automated tests
+
+When submitting a pull request for a new feature or bug fixes, please add automated tests for your code whenever possible. Tests in Joplin are divided in **unit tests** and **feature tests**.
+
+* **Unit tests** are used to tests models, services or utility classes - they are relatively low level. Unit tests should be prefixed with the type of class that is being tested - for example "models_Folder" or "services_SearchEngine".
+
+* **Feature tests** on the other hand are to test higher level functionalities such as interactions with the GUI and how they affect the underlying model. Often these tests would dispatch Redux actions, and inspect how the application state has been changed. The feature tests should be prefixed with "feature_", for example "feature_TagList". There's a good explanation on what qualifies as a feature test in [this post](https://github.com/laurent22/joplin/pull/2819#issuecomment-603502230).
+
+The tests are under CliClient/tests. To get them running, you first need to build the CLI app:
+
+```sh
+npm install
+cd CliClient
+```
+
+To run all the test units:
+
+```sh
+npm test
+```
+
+To run just one particular file:
+
+```sh
+npm test -- --filter=markdownUtils # Don't add the .js extension
+```
+
+To filter tests. For example, to run all the test units that contain "should handle conflict" in their description:
+
+```sh
+npm test -- --filter="should handle conflict"
+```
+
+## About abandoned pull requests
+
+It happens that a pull request is started but not finished and despite our attempts to contact the contributor, we don't hear from them again.
+
+In that case we will not merge the pull request, even if only small changes are missing. Our policy is simply to close the pull request. Why? Because an unfinished pull request essentially means giving us work and moving on. We would rather not encourage this behaviour.
+
+Also, please note that since we have spent time reviewing the pull request and proposing solutions, we reserve the right to re-use that knowledge to create a new pull request, potentially based on your changes.
+
+We'd much prefer that you complete the pull request though, so we'll be sure to ping you a few times before that!

CliClient/.eslintrc.js

@@ -0,0 +1,13 @@
+module.exports = {
+	"overrides": [
+		{
+			"files": ["tests/**/*.js"],
+			'rules': {
+				// Ignore all unused function arguments, because in some
+				// case they are kept to indicate the function signature.
+				"no-unused-vars": ["error", { "argsIgnorePattern": ".*" }],
+				"@typescript-eslint/no-unused-vars": 0,
+			}
+		},
+	],
+};

CliClient/.gitignore

@@ -1,4 +1,3 @@
-build/
 node_modules/
 app/src
 tests-build/
@@ -13,9 +12,12 @@ tests/fuzzing.*
 tests/fuzzing -*
 tests/logs/*
 tests/cli-integration/
+tests/tmp/
 *.mo
 *.*~
 tests/sync
 out.txt
 linkToLocal.sh
-yarn-error.log
+yarn-error.log
+tests/support/dropbox-auth.txt
+build/

CliClient/app/ResourceServer.js

@@ -1,14 +1,11 @@
-const { _ } = require('lib/locale.js');
 const { Logger } = require('lib/logger.js');
-const Resource = require('lib/models/Resource.js');
 const { netUtils } = require('lib/net-utils.js');
 
-const http = require("http");
-const urlParser = require("url");
+const http = require('http');
+const urlParser = require('url');
 const enableServerDestroy = require('server-destroy');
 
 class ResourceServer {
-
 	constructor() {
 		this.server_ = null;
 		this.logger_ = new Logger();
@@ -31,7 +28,7 @@ class ResourceServer {
 
 	baseUrl() {
 		if (!this.port_) return '';
-		return 'http://127.0.0.1:' + this.port_;
+		return `http://127.0.0.1:${this.port_}`;
 	}
 
 	setLinkHandler(handler) {
@@ -40,7 +37,7 @@ class ResourceServer {
 
 	async start() {
 		this.port_ = await netUtils.findAvailablePort([9167, 9267, 8167, 8267]);
-		if (!this.port_) {	
+		if (!this.port_) {
 			this.logger().error('Could not find available port to start resource server. Please report the error at https://github.com/laurent22/joplin');
 			return;
 		}
@@ -48,16 +45,15 @@ class ResourceServer {
 		this.server_ = http.createServer();
 
 		this.server_.on('request', async (request, response) => {
-
-			const writeResponse = (message) => {
+			const writeResponse = message => {
 				response.write(message);
 				response.end();
-			}
+			};
 
 			const url = urlParser.parse(request.url, true);
 			let resourceId = url.pathname.split('/');
 			if (resourceId.length < 2) {
-				writeResponse('Error: could not get resource ID from path name: ' + url.pathname);
+				writeResponse(`Error: could not get resource ID from path name: ${url.pathname}`);
 				return;
 			}
 			resourceId = resourceId[1];
@@ -66,9 +62,10 @@ class ResourceServer {
 
 			try {
 				const done = await this.linkHandler_(resourceId, response);
-				if (!done) throw new Error('Unhandled resource: ' + resourceId);
+				if (!done) throw new Error(`Unhandled resource: ${resourceId}`);
 			} catch (error) {
 				response.setHeader('Content-Type', 'text/plain');
+				// eslint-disable-next-line require-atomic-updates
 				response.statusCode = 400;
 				response.write(error.message);
 			}
@@ -76,7 +73,7 @@ class ResourceServer {
 			response.end();
 		});
 
-		this.server_.on('error', (error) => {
+		this.server_.on('error', error => {
 			this.logger().error('Resource server:', error);
 		});
 
@@ -91,7 +88,6 @@ class ResourceServer {
 		if (this.server_) this.server_.destroy();
 		this.server_ = null;
 	}
-
 }
 
-module.exports = ResourceServer;
+module.exports = ResourceServer;

CliClient/app/app-gui.js

@@ -1,14 +1,16 @@
 const { Logger } = require('lib/logger.js');
 const Folder = require('lib/models/Folder.js');
+const BaseItem = require('lib/models/BaseItem.js');
 const Tag = require('lib/models/Tag.js');
 const BaseModel = require('lib/BaseModel.js');
 const Note = require('lib/models/Note.js');
 const Resource = require('lib/models/Resource.js');
-const { cliUtils } = require('./cli-utils.js');
 const { reducer, defaultState } = require('lib/reducer.js');
 const { splitCommandString } = require('lib/string-utils.js');
 const { reg } = require('lib/registry.js');
 const { _ } = require('lib/locale.js');
+const Entities = require('html-entities').AllHtmlEntities;
+const htmlentities = new Entities().encode;
 
 const chalk = require('chalk');
 const tk = require('terminal-kit');
@@ -17,12 +19,10 @@ const Renderer = require('tkwidgets/framework/Renderer.js');
 const DecryptionWorker = require('lib/services/DecryptionWorker');
 
 const BaseWidget = require('tkwidgets/BaseWidget.js');
-const ListWidget = require('tkwidgets/ListWidget.js');
 const TextWidget = require('tkwidgets/TextWidget.js');
 const HLayoutWidget = require('tkwidgets/HLayoutWidget.js');
 const VLayoutWidget = require('tkwidgets/VLayoutWidget.js');
 const ReduxRootWidget = require('tkwidgets/ReduxRootWidget.js');
-const RootWidget = require('tkwidgets/RootWidget.js');
 const WindowWidget = require('tkwidgets/WindowWidget.js');
 
 const NoteWidget = require('./gui/NoteWidget.js');
@@ -34,39 +34,55 @@ const StatusBarWidget = require('./gui/StatusBarWidget.js');
 const ConsoleWidget = require('./gui/ConsoleWidget.js');
 
 class AppGui {
+	constructor(app, store, keymap) {
+		try {
+			this.app_ = app;
+			this.store_ = store;
 
-	constructor(app, store) {
-		this.app_ = app;
-		this.store_ = store;
+			BaseWidget.setLogger(app.logger());
 
-		BaseWidget.setLogger(app.logger());
+			this.term_ = new TermWrapper(tk.terminal);
 
-		this.term_ = new TermWrapper(tk.terminal);
+			// Some keys are directly handled by the tkwidget framework
+			// so they need to be remapped in a different way.
+			this.tkWidgetKeys_ = {
+				focus_next: 'TAB',
+				focus_previous: 'SHIFT_TAB',
+				move_up: 'UP',
+				move_down: 'DOWN',
+				page_down: 'PAGE_DOWN',
+				page_up: 'PAGE_UP',
+			};
 
-		this.renderer_ = null;
-		this.logger_ = new Logger();
-		this.buildUi();
+			this.renderer_ = null;
+			this.logger_ = new Logger();
+			this.buildUi();
 
-		this.renderer_ = new Renderer(this.term(), this.rootWidget_);
+			this.renderer_ = new Renderer(this.term(), this.rootWidget_);
 
-		this.app_.on('modelAction', async (event) => {
-			await this.handleModelAction(event.action);
-		});
+			this.app_.on('modelAction', async event => {
+				await this.handleModelAction(event.action);
+			});
 
-		this.shortcuts_ = this.setupShortcuts();
+			this.keymap_ = this.setupKeymap(keymap);
 
-		this.inputMode_ = AppGui.INPUT_MODE_NORMAL;
+			this.inputMode_ = AppGui.INPUT_MODE_NORMAL;
 
-		this.commandCancelCalled_ = false;
+			this.commandCancelCalled_ = false;
 
-		this.currentShortcutKeys_ = [];
-		this.lastShortcutKeyTime_ = 0;
+			this.currentShortcutKeys_ = [];
+			this.lastShortcutKeyTime_ = 0;
 
-		// Recurrent sync is setup only when the GUI is started. In
-		// a regular command it's not necessary since the process
-		// exits right away.
-		reg.setupRecurrentSync();
-		DecryptionWorker.instance().scheduleStart();
+			// Recurrent sync is setup only when the GUI is started. In
+			// a regular command it's not necessary since the process
+			// exits right away.
+			reg.setupRecurrentSync();
+			DecryptionWorker.instance().scheduleStart();
+		} catch (error) {
+			if (this.term_) { this.fullScreen(false); }
+			console.error(error);
+			process.exit(1);
+		}
 	}
 
 	store() {
@@ -105,6 +121,7 @@ class AppGui {
 	buildUi() {
 		this.rootWidget_ = new ReduxRootWidget(this.store_);
 		this.rootWidget_.name = 'root';
+		this.rootWidget_.autoShortcutsEnabled = false;
 
 		const folderList = new FolderListWidget();
 		folderList.style = {
@@ -113,11 +130,11 @@ class AppGui {
 		};
 		folderList.name = 'folderList';
 		folderList.vStretch = true;
-		folderList.on('currentItemChange', async (event) => {
+		folderList.on('currentItemChange', async event => {
 			const item = folderList.currentItem;
 
 			if (item === '-') {
-				let newIndex = event.currentIndex + (event.previousIndex < event.currentIndex ? +1 : -1);
+				const newIndex = event.currentIndex + (event.previousIndex < event.currentIndex ? +1 : -1);
 				let nextItem = folderList.itemAt(newIndex);
 				if (!nextItem) nextItem = folderList.itemAt(event.previousIndex);
 
@@ -148,7 +165,7 @@ class AppGui {
 				});
 			}
 		});
-		this.rootWidget_.connect(folderList, (state) => {
+		this.rootWidget_.connect(folderList, state => {
 			return {
 				selectedFolderId: state.selectedFolderId,
 				selectedTagId: state.selectedTagId,
@@ -169,13 +186,13 @@ class AppGui {
 			borderRightWidth: 1,
 		};
 		noteList.on('currentItemChange', async () => {
-			let note = noteList.currentItem;
+			const note = noteList.currentItem;
 			this.store_.dispatch({
 				type: 'NOTE_SELECT',
 				id: note ? note.id : null,
 			});
 		});
-		this.rootWidget_.connect(noteList, (state) => {
+		this.rootWidget_.connect(noteList, state => {
 			return {
 				selectedNoteId: state.selectedNoteIds.length ? state.selectedNoteIds[0] : null,
 				items: state.notes,
@@ -189,7 +206,7 @@ class AppGui {
 			borderBottomWidth: 1,
 			borderLeftWidth: 1,
 		};
-		this.rootWidget_.connect(noteText, (state) => {
+		this.rootWidget_.connect(noteText, state => {
 			return {
 				noteId: state.selectedNoteIds.length ? state.selectedNoteIds[0] : null,
 				notes: state.notes,
@@ -204,7 +221,7 @@ class AppGui {
 			borderLeftWidth: 1,
 			borderRightWidth: 1,
 		};
-		this.rootWidget_.connect(noteMetadata, (state) => {
+		this.rootWidget_.connect(noteMetadata, state => {
 			return { noteId: state.selectedNoteIds.length ? state.selectedNoteIds[0] : null };
 		});
 		noteMetadata.hide();
@@ -269,155 +286,31 @@ class AppGui {
 
 	addCommandToConsole(cmd) {
 		if (!cmd) return;
-		this.stdout(chalk.cyan.bold('> ' + cmd));	
+		const isConfigPassword = cmd.indexOf('config ') >= 0 && cmd.indexOf('password') >= 0;
+		if (isConfigPassword) return;
+		this.stdout(chalk.cyan.bold(`> ${cmd}`));
 	}
 
-	setupShortcuts() {
-		const shortcuts = {};
+	setupKeymap(keymap) {
+		const output = [];
 
-		shortcuts['TAB'] = {
-			friendlyName: 'Tab',
-			description: () => _('Give focus to next pane'),
-			isDocOnly: true,
-		}
+		for (let i = 0; i < keymap.length; i++) {
+			const item = Object.assign({}, keymap[i]);
 
-		shortcuts['SHIFT_TAB'] = {
-			friendlyName: 'Shift+Tab',
-			description: () => _('Give focus to previous pane'),
-			isDocOnly: true,
-		}
+			if (!item.command) throw new Error(`Missing command for keymap item: ${JSON.stringify(item)}`);
 
-		shortcuts[':'] = {
-			description: () => _('Enter command line mode'),
-			action: async () => {
-				const cmd = await this.widget('statusBar').prompt();
-				if (!cmd) return;
-				this.addCommandToConsole(cmd);
-				await this.processCommand(cmd);
-			},
-		};
+			if (!('type' in item)) item.type = 'exec';
 
-		shortcuts['ESC'] = { // Built into terminal-kit inputField
-			description: () => _('Exit command line mode'),
-			isDocOnly: true,
-		};
-
-		shortcuts['ENTER'] = {
-			description: () => _('Edit the selected note'),
-			action: () => {
-				const w = this.widget('mainWindow').focusedWidget;
-				if (w.name === 'folderList') {
-					this.widget('noteList').focus();
-				} else if (w.name === 'noteList' || w.name === 'noteText') {
-					this.processCommand('edit $n');
-				}
-			},
-		}
-
-		shortcuts['CTRL_C'] = {
-			description: () => _('Cancel the current command.'),
-			friendlyName: 'Ctrl+C',
-			isDocOnly: true,
-		}
-
-		shortcuts['CTRL_D'] = {
-			description: () => _('Exit the application.'),
-			friendlyName: 'Ctrl+D',
-			isDocOnly: true,
-		}
-
-		shortcuts['DELETE'] = {
-			description: () => _('Delete the currently selected note or notebook.'),
-			action: async () => {
-				if (this.widget('folderList').hasFocus) {
-					const item = this.widget('folderList').selectedJoplinItem;
-
-					if (!item) return;
-
-					if (item.type_ === BaseModel.TYPE_FOLDER) {
-						await this.processCommand('rmbook ' + item.id);
-					} else if (item.type_ === BaseModel.TYPE_TAG) {
-						this.stdout(_('To delete a tag, untag the associated notes.'));
-					} else if (item.type_ === BaseModel.TYPE_SEARCH) {
-						this.store().dispatch({
-							type: 'SEARCH_DELETE',
-							id: item.id,
-						});
-					}
-				} else if (this.widget('noteList').hasFocus) {
-					await this.processCommand('rmnote $n');
-				} else {
-					this.stdout(_('Please select the note or notebook to be deleted first.'));
-				}
+			if (item.command in this.tkWidgetKeys_) {
+				item.type = 'tkwidgets';
 			}
-		};
 
-		shortcuts['BACKSPACE'] = {
-			alias: 'DELETE',
-		};
+			item.canRunAlongOtherCommands = item.type === 'function' && ['toggle_metadata', 'toggle_console'].indexOf(item.command) >= 0;
 
-		shortcuts[' '] = {
-			friendlyName: 'SPACE',
-			description: () => _('Set a to-do as completed / not completed'),
-			action: 'todo toggle $n',
+			output.push(item);
 		}
 
-		shortcuts['tc'] = {
-			description: () => _('[t]oggle [c]onsole between maximized/minimized/hidden/visible.'),
-			action: () => {
-				if (!this.consoleIsShown()) {
-					this.showConsole();
-					this.minimizeConsole();
-				} else {
-					if (this.consoleIsMaximized()) {
-						this.hideConsole();
-					} else {
-						this.maximizeConsole();
-					}
-				}
-			},
-			canRunAlongOtherCommands: true,
-		}
-
-		shortcuts['/'] = {
-			description: () => _('Search'),
-			action: { type: 'prompt', initialText: 'search ""', cursorPosition: -2 },
-		};
-
-		shortcuts['tm'] = {
-			description: () => _('[t]oggle note [m]etadata.'),
-			action: () => {
-				this.toggleNoteMetadata();
-			},
-			canRunAlongOtherCommands: true,
-		}
-
-		shortcuts['mn'] = {
-			description: () => _('[M]ake a new [n]ote'),
-			action: { type: 'prompt', initialText: 'mknote ""', cursorPosition: -2 },
-		}
-
-		shortcuts['mt'] = {
-			description: () => _('[M]ake a new [t]odo'),
-			action: { type: 'prompt', initialText: 'mktodo ""', cursorPosition: -2 },
-		}
-
-		shortcuts['mb'] = {
-			description: () => _('[M]ake a new note[b]ook'),
-			action: { type: 'prompt', initialText: 'mkbook ""', cursorPosition: -2 },
-		}
-
-		shortcuts['yn'] = {
-			description: () => _('Copy ([Y]ank) the [n]ote to a notebook.'),
-			action: { type: 'prompt', initialText: 'cp $n ""', cursorPosition: -2 },
-		}
-
-		shortcuts['dn'] = {
-			description: () => _('Move the note to a notebook.'),
-			action: { type: 'prompt', initialText: 'mv $n ""', cursorPosition: -2 },
-		}
-
-		return shortcuts;
+		return output;
 	}
 
 	toggleConsole() {
@@ -445,7 +338,7 @@ class AppGui {
 
 		if (consoleWidget.isMaximized__ === doMaximize) return;
 
-		let constraints = {
+		const constraints = {
 			type: 'stretch',
 			factor: !doMaximize ? 1 : 4,
 		};
@@ -492,8 +385,16 @@ class AppGui {
 		return this.logger_;
 	}
 
-	shortcuts() {
-		return this.shortcuts_;
+	keymap() {
+		return this.keymap_;
+	}
+
+	keymapItemByKey(key) {
+		for (let i = 0; i < this.keymap_.length; i++) {
+			const item = this.keymap_[i];
+			if (item.keys.indexOf(key) >= 0) return item;
+		}
+		return null;
 	}
 
 	term() {
@@ -503,7 +404,7 @@ class AppGui {
 	activeListItem() {
 		const widget = this.widget('mainWindow').focusedWidget;
 		if (!widget) return null;
-		
+
 		if (widget.name == 'noteList' || widget.name == 'folderList') {
 			return widget.currentItem;
 		}
@@ -514,39 +415,86 @@ class AppGui {
 	async handleModelAction(action) {
 		this.logger().info('Action:', action);
 
-		let state = Object.assign({}, defaultState);
+		const state = Object.assign({}, defaultState);
 		state.notes = this.widget('noteList').items;
 
-		let newState = reducer(state, action);
+		const newState = reducer(state, action);
 
 		if (newState !== state) {
 			this.widget('noteList').items = newState.notes;
 		}
 	}
 
-	async processCommand(cmd) {
+	async processFunctionCommand(cmd) {
+		if (cmd === 'activate') {
+			const w = this.widget('mainWindow').focusedWidget;
+			if (w.name === 'folderList') {
+				this.widget('noteList').focus();
+			} else if (w.name === 'noteList' || w.name === 'noteText') {
+				this.processPromptCommand('edit $n');
+			}
+		} else if (cmd === 'delete') {
+			if (this.widget('folderList').hasFocus) {
+				const item = this.widget('folderList').selectedJoplinItem;
+
+				if (!item) return;
+
+				if (item.type_ === BaseModel.TYPE_FOLDER) {
+					await this.processPromptCommand(`rmbook ${item.id}`);
+				} else if (item.type_ === BaseModel.TYPE_TAG) {
+					this.stdout(_('To delete a tag, untag the associated notes.'));
+				} else if (item.type_ === BaseModel.TYPE_SEARCH) {
+					this.store().dispatch({
+						type: 'SEARCH_DELETE',
+						id: item.id,
+					});
+				}
+			} else if (this.widget('noteList').hasFocus) {
+				await this.processPromptCommand('rmnote $n');
+			} else {
+				this.stdout(_('Please select the note or notebook to be deleted first.'));
+			}
+		} else if (cmd === 'toggle_console') {
+			if (!this.consoleIsShown()) {
+				this.showConsole();
+				this.minimizeConsole();
+			} else {
+				if (this.consoleIsMaximized()) {
+					this.hideConsole();
+				} else {
+					this.maximizeConsole();
+				}
+			}
+		} else if (cmd === 'toggle_metadata') {
+			this.toggleNoteMetadata();
+		} else if (cmd === 'enter_command_line_mode') {
+			const cmd = await this.widget('statusBar').prompt();
+			if (!cmd) return;
+			this.addCommandToConsole(cmd);
+			await this.processPromptCommand(cmd);
+		} else {
+			throw new Error(`Unknown command: ${cmd}`);
+		}
+	}
+
+	async processPromptCommand(cmd) {
 		if (!cmd) return;
 		cmd = cmd.trim();
 		if (!cmd.length) return;
 
-		this.logger().info('Got command: ' + cmd);
+		// this.logger().debug('Got command: ' + cmd);
 
-		if (cmd === 'q' || cmd === 'wq' || cmd === 'qa') { // Vim bonus
-			await this.app().exit();
-			return;
-		}	
-
-		try {			
-			let note = this.widget('noteList').currentItem;
-			let folder = this.widget('folderList').currentItem;
-			let args = splitCommandString(cmd);
+		try {
+			const note = this.widget('noteList').currentItem;
+			const folder = this.widget('folderList').currentItem;
+			const args = splitCommandString(cmd);
 
 			for (let i = 0; i < args.length; i++) {
 				if (args[i] == '$n') {
 					args[i] = note ? note.id : '';
 				} else if (args[i] == '$b') {
 					args[i] = folder ? folder.id : '';
-				} else  if (args[i] == '$c') {
+				} else if (args[i] == '$c') {
 					const item = this.activeListItem();
 					args[i] = item ? item.id : '';
 				}
@@ -558,7 +506,7 @@ class AppGui {
 		}
 
 		this.widget('console').scrollBottom();
-		
+
 		// Invalidate so that the screen is redrawn in case inputting a command has moved
 		// the GUI up (in particular due to autocompletion), it's moved back to the right position.
 		this.widget('root').invalidate();
@@ -600,7 +548,7 @@ class AppGui {
 	stdout(text) {
 		if (text === null || text === undefined) return;
 
-		let lines = text.split('\n');
+		const lines = text.split('\n');
 		for (let i = 0; i < lines.length; i++) {
 			const v = typeof lines[i] === 'object' ? JSON.stringify(lines[i]) : lines[i];
 			this.widget('console').addLine(v);
@@ -638,17 +586,17 @@ class AppGui {
 	async setupResourceServer() {
 		const linkStyle = chalk.blue.underline;
 		const noteTextWidget = this.widget('noteText');
-		const resourceIdRegex = /^:\/[a-f0-9]+$/i
+		const resourceIdRegex = /^:\/[a-f0-9]+$/i;
 		const noteLinks = {};
 
 		const hasProtocol = function(s, protocols) {
 			if (!s) return false;
 			s = s.trim().toLowerCase();
 			for (let i = 0; i < protocols.length; i++) {
-				if (s.indexOf(protocols[i] + '://') === 0) return true;
+				if (s.indexOf(`${protocols[i]}://`) === 0) return true;
 			}
 			return false;
-		}
+		};
 
 		// By default, before the server is started, only the regular
 		// URLs appear in blue.
@@ -672,16 +620,33 @@ class AppGui {
 			const link = noteLinks[path];
 
 			if (link.type === 'url') {
-				response.writeHead(302, { 'Location': link.url });
+				response.writeHead(302, { Location: link.url });
 				return true;
 			}
 
-			if (link.type === 'resource') {
-				const resourceId = link.id;
-				let resource = await Resource.load(resourceId);
-				if (!resource) throw new Error('No resource with ID ' + resourceId); // Should be nearly impossible
-				if (resource.mime) response.setHeader('Content-Type', resource.mime);
-				response.write(await Resource.content(resource));
+			if (link.type === 'item') {
+				const itemId = link.id;
+				const item = await BaseItem.loadItemById(itemId);
+				if (!item) throw new Error(`No item with ID ${itemId}`); // Should be nearly impossible
+
+				if (item.type_ === BaseModel.TYPE_RESOURCE) {
+					if (item.mime) response.setHeader('Content-Type', item.mime);
+					response.write(await Resource.content(item));
+				} else if (item.type_ === BaseModel.TYPE_NOTE) {
+					const html = [
+						`
+						<!DOCTYPE html>
+						<html class="client-nojs" lang="en" dir="ltr">
+						<head><meta charset="UTF-8"/></head><body>
+					`,
+					];
+					html.push(`<pre>${htmlentities(item.title)}\n\n${htmlentities(item.body)}</pre>`);
+					html.push('</body></html>');
+					response.write(html.join(''));
+				} else {
+					throw new Error(`Unsupported item type: ${item.type_}`);
+				}
+
 				return true;
 			}
 
@@ -697,9 +662,9 @@ class AppGui {
 
 				if (resourceIdRegex.test(url)) {
 					noteLinks[index] = {
-						type: 'resource',
+						type: 'item',
 						id: url.substr(2),
-					};					
+					};
 				} else if (hasProtocol(url, ['http', 'https', 'file', 'ftp'])) {
 					noteLinks[index] = {
 						type: 'url',
@@ -711,7 +676,7 @@ class AppGui {
 					return url;
 				}
 
-				return linkStyle(this.resourceServer_.baseUrl() + '/' + index);
+				return linkStyle(`${this.resourceServer_.baseUrl()}/${index}`);
 			},
 		};
 	}
@@ -730,8 +695,7 @@ class AppGui {
 
 			term.grabInput();
 
-			term.on('key', async (name, matches, data) => {
-
+			term.on('key', async (name) => {
 				// -------------------------------------------------------------------------
 				// Handle special shortcuts
 				// -------------------------------------------------------------------------
@@ -749,13 +713,13 @@ class AppGui {
 					return;
 				}
 
-				if (name === 'CTRL_C' ) {
+				if (name === 'CTRL_C') {
 					const cmd = this.app().currentCommand();
 					if (!cmd || !cmd.cancellable() || this.commandCancelCalled_) {
 						this.stdout(_('Press Ctrl+D or type "exit" to exit the application'));
 					} else {
 						this.commandCancelCalled_ = true;
-						await cmd.cancel()
+						await cmd.cancel();
 						this.commandCancelCalled_ = false;
 					}
 					return;
@@ -764,8 +728,8 @@ class AppGui {
 				// -------------------------------------------------------------------------
 				// Build up current shortcut
 				// -------------------------------------------------------------------------
-				
-				const now = (new Date()).getTime();
+
+				const now = new Date().getTime();
 
 				if (now - this.lastShortcutKeyTime_ > 800 || this.isSpecialKey(name)) {
 					this.currentShortcutKeys_ = [name];
@@ -786,35 +750,34 @@ class AppGui {
 				// -------------------------------------------------------------------------
 
 				const shortcutKey = this.currentShortcutKeys_.join('');
-				let cmd = shortcutKey in this.shortcuts_ ? this.shortcuts_[shortcutKey] : null;
+				const keymapItem = this.keymapItemByKey(shortcutKey);
 
 				// If this command is an alias to another command, resolve to the actual command
-				if (cmd && cmd.alias) cmd = this.shortcuts_[cmd.alias];
 
-				let processShortcutKeys = !this.app().currentCommand() && cmd;
-				if (cmd && cmd.canRunAlongOtherCommands) processShortcutKeys = true;
+				let processShortcutKeys = !this.app().currentCommand() && keymapItem;
+				if (keymapItem && keymapItem.canRunAlongOtherCommands) processShortcutKeys = true;
 				if (statusBar.promptActive) processShortcutKeys = false;
-				if (cmd && cmd.isDocOnly) processShortcutKeys = false;
 
 				if (processShortcutKeys) {
-					this.logger().info('Shortcut:', shortcutKey, cmd.description());
+					this.logger().debug('Shortcut:', shortcutKey, keymapItem);
 
 					this.currentShortcutKeys_ = [];
-					if (typeof cmd.action === 'function') {
-						await cmd.action();
-					} else if (typeof cmd.action === 'object') {
-						if (cmd.action.type === 'prompt') {
-							let promptOptions = {};
-							if ('cursorPosition' in cmd.action) promptOptions.cursorPosition = cmd.action.cursorPosition;
-							const commandString = await statusBar.prompt(cmd.action.initialText ? cmd.action.initialText : '', null, promptOptions);
-							this.addCommandToConsole(commandString);
-							await this.processCommand(commandString);
-						} else {
-							throw new Error('Unknown command: ' + JSON.stringify(cmd.action));
-						}
-					} else { // String
-						this.stdout(cmd.action);
-						await this.processCommand(cmd.action);
+
+					if (keymapItem.type === 'function') {
+						this.processFunctionCommand(keymapItem.command);
+					} else if (keymapItem.type === 'prompt') {
+						const promptOptions = {};
+						if ('cursorPosition' in keymapItem) promptOptions.cursorPosition = keymapItem.cursorPosition;
+						const commandString = await statusBar.prompt(keymapItem.command ? keymapItem.command : '', null, promptOptions);
+						this.addCommandToConsole(commandString);
+						await this.processPromptCommand(commandString);
+					} else if (keymapItem.type === 'exec') {
+						this.stdout(keymapItem.command);
+						await this.processPromptCommand(keymapItem.command);
+					} else if (keymapItem.type === 'tkwidgets') {
+						this.widget('root').handleKey(this.tkWidgetKeys_[keymapItem.command]);
+					} else {
+						throw new Error(`Unknown command type: ${JSON.stringify(keymapItem)}`);
 					}
 				}
 
@@ -834,7 +797,6 @@ class AppGui {
 			process.exit(1);
 		});
 	}
-
 }
 
 AppGui.INPUT_MODE_NORMAL = 1;

CliClient/app/app.js

@@ -1,30 +1,21 @@
 const { BaseApplication } = require('lib/BaseApplication');
-const { createStore, applyMiddleware } = require('redux');
-const { reducer, defaultState } = require('lib/reducer.js');
-const { JoplinDatabase } = require('lib/joplin-database.js');
-const { Database } = require('lib/database.js');
 const { FoldersScreenUtils } = require('lib/folders-screen-utils.js');
-const { DatabaseDriverNode } = require('lib/database-driver-node.js');
+const ResourceService = require('lib/services/ResourceService');
 const BaseModel = require('lib/BaseModel.js');
 const Folder = require('lib/models/Folder.js');
 const BaseItem = require('lib/models/BaseItem.js');
 const Note = require('lib/models/Note.js');
 const Tag = require('lib/models/Tag.js');
 const Setting = require('lib/models/Setting.js');
-const { Logger } = require('lib/logger.js');
-const { sprintf } = require('sprintf-js');
 const { reg } = require('lib/registry.js');
 const { fileExtension } = require('lib/path-utils.js');
-const { shim } = require('lib/shim.js');
-const { _, setLocale, defaultLocale, closestSupportedLocale } = require('lib/locale.js');
-const os = require('os');
+const { _ } = require('lib/locale.js');
 const fs = require('fs-extra');
 const { cliUtils } = require('./cli-utils.js');
-const EventEmitter = require('events');
 const Cache = require('lib/Cache');
+const RevisionService = require('lib/services/RevisionService');
 
 class Application extends BaseApplication {
-
 	constructor() {
 		super();
 
@@ -56,7 +47,7 @@ class Application extends BaseApplication {
 	}
 
 	async loadItem(type, pattern, options = null) {
-		let output = await this.loadItems(type, pattern, options);
+		const output = await this.loadItems(type, pattern, options);
 
 		if (output.length > 1) {
 			// output.sort((a, b) => { return a.user_updated_time < b.user_updated_time ? +1 : -1; });
@@ -73,7 +64,7 @@ class Application extends BaseApplication {
 			// const response = await cliUtils.promptMcq(msg, answers);
 			// if (!response) return null;
 
-			return output[response - 1];
+			// return output[response - 1];
 		} else {
 			return output.length ? output[0] : null;
 		}
@@ -95,10 +86,12 @@ class Application extends BaseApplication {
 		const parent = options.parent ? options.parent : app().currentFolder();
 		const ItemClass = BaseItem.itemClass(type);
 
-		if (type == BaseModel.TYPE_NOTE && pattern.indexOf('*') >= 0) { // Handle it as pattern
+		if (type == BaseModel.TYPE_NOTE && pattern.indexOf('*') >= 0) {
+			// Handle it as pattern
 			if (!parent) throw new Error(_('No notebook selected.'));
 			return await Note.previews(parent.id, { titlePattern: pattern });
-		} else { // Single item
+		} else {
+			// Single item
 			let item = null;
 			if (type == BaseModel.TYPE_NOTE) {
 				if (!parent) throw new Error(_('No notebook has been specified.'));
@@ -124,15 +117,15 @@ class Application extends BaseApplication {
 	}
 
 	setupCommand(cmd) {
-		cmd.setStdout((text) => {
+		cmd.setStdout(text => {
 			return this.stdout(text);
 		});
 
-		cmd.setDispatcher((action) => {
+		cmd.setDispatcher(action => {
 			if (this.store()) {
 				return this.store().dispatch(action);
 			} else {
-				return (action) => {};
+				return () => {};
 			}
 		});
 
@@ -143,15 +136,15 @@ class Application extends BaseApplication {
 			if (!options.answers) options.answers = options.booleanAnswerDefault === 'y' ? [_('Y'), _('n')] : [_('N'), _('y')];
 
 			if (options.type == 'boolean') {
-				message += ' (' + options.answers.join('/') + ')';
+				message += ` (${options.answers.join('/')})`;
 			}
 
-			let answer = await this.gui().prompt('', message + ' ', options);
+			let answer = await this.gui().prompt('', `${message} `, options);
 
 			if (options.type === 'boolean') {
 				if (answer === null) return false; // Pressed ESCAPE
 				if (!answer) answer = options.answers[0];
-				let positiveIndex = options.booleanAnswerDefault == 'y' ? 0 : 1;
+				const positiveIndex = options.booleanAnswerDefault == 'y' ? 0 : 1;
 				return answer.toLowerCase() === options.answers[positiveIndex].toLowerCase();
 			} else {
 				return answer;
@@ -183,12 +176,12 @@ class Application extends BaseApplication {
 
 	commands(uiType = null) {
 		if (!this.allCommandsLoaded_) {
-			fs.readdirSync(__dirname).forEach((path) => {
+			fs.readdirSync(__dirname).forEach(path => {
 				if (path.indexOf('command-') !== 0) return;
-				const ext = fileExtension(path)
+				const ext = fileExtension(path);
 				if (ext != 'js') return;
 
-				let CommandClass = require('./' + path);
+				const CommandClass = require(`./${path}`);
 				let cmd = new CommandClass();
 				if (!cmd.enabled()) return;
 				cmd = this.setupCommand(cmd);
@@ -199,8 +192,8 @@ class Application extends BaseApplication {
 		}
 
 		if (uiType !== null) {
-			let temp = [];
-			for (let n in this.commands_) {
+			const temp = [];
+			for (const n in this.commands_) {
 				if (!this.commands_.hasOwnProperty(n)) continue;
 				const c = this.commands_[n];
 				if (!c.supportsUi(uiType)) continue;
@@ -214,8 +207,8 @@ class Application extends BaseApplication {
 
 	async commandNames() {
 		const metadata = await this.commandMetadata();
-		let output = [];
-		for (let n in metadata) {
+		const output = [];
+		for (const n in metadata) {
 			if (!metadata.hasOwnProperty(n)) continue;
 			output.push(n);
 		}
@@ -234,7 +227,7 @@ class Application extends BaseApplication {
 		const commands = this.commands();
 
 		output = {};
-		for (let n in commands) {
+		for (const n in commands) {
 			if (!commands.hasOwnProperty(n)) continue;
 			const cmd = commands[n];
 			output[n] = cmd.metadata();
@@ -255,10 +248,10 @@ class Application extends BaseApplication {
 
 		let CommandClass = null;
 		try {
-			CommandClass = require(__dirname + '/command-' + name + '.js');
+			CommandClass = require(`${__dirname}/command-${name}.js`);
 		} catch (error) {
 			if (error.message && error.message.indexOf('Cannot find module') >= 0) {
-				let e = new Error(_('No such command: %s', name));
+				const e = new Error(_('No such command: %s', name));
 				e.type = 'notFound';
 				throw e;
 			} else {
@@ -274,31 +267,39 @@ class Application extends BaseApplication {
 
 	dummyGui() {
 		return {
-			isDummy: () => { return true; },
-			prompt: (initialText = '', promptString = '', options = null) => { return cliUtils.prompt(initialText, promptString, options); },
+			isDummy: () => {
+				return true;
+			},
+			prompt: (initialText = '', promptString = '', options = null) => {
+				return cliUtils.prompt(initialText, promptString, options);
+			},
 			showConsole: () => {},
 			maximizeConsole: () => {},
-			stdout: (text) => { console.info(text); },
-			fullScreen: (b=true) => {},
+			stdout: text => {
+				console.info(text);
+			},
+			fullScreen: () => {},
 			exit: () => {},
-			showModalOverlay: (text) => {},
+			showModalOverlay: () => {},
 			hideModalOverlay: () => {},
-			stdoutMaxWidth: () => { return 78; },
+			stdoutMaxWidth: () => {
+				return 100;
+			},
 			forceRender: () => {},
 			termSaveState: () => {},
-			termRestoreState: (state) => {},
+			termRestoreState: () => {},
 		};
 	}
 
 	async execCommand(argv) {
 		if (!argv.length) return this.execCommand(['help']);
-		reg.logger().info('execCommand()', argv);
+		// reg.logger().debug('execCommand()', argv);
 		const commandName = argv[0];
 		this.activeCommand_ = this.findCommandByName(commandName);
 
 		let outException = null;
 		try {
-			if (this.gui().isDummy() && !this.activeCommand_.supportsUi('cli')) throw new Error(_('The command "%s" is only available in GUI mode', this.activeCommand_.name()));			
+			if (this.gui().isDummy() && !this.activeCommand_.supportsUi('cli')) throw new Error(_('The command "%s" is only available in GUI mode', this.activeCommand_.name()));
 			const cmdArgs = cliUtils.makeCommandArgs(this.activeCommand_, argv);
 			await this.activeCommand_.action(cmdArgs);
 		} catch (error) {
@@ -312,10 +313,79 @@ class Application extends BaseApplication {
 		return this.activeCommand_;
 	}
 
+	async loadKeymaps() {
+		const defaultKeyMap = [
+			{ keys: [':'], type: 'function', command: 'enter_command_line_mode' },
+			{ keys: ['TAB'], type: 'function', command: 'focus_next' },
+			{ keys: ['SHIFT_TAB'], type: 'function', command: 'focus_previous' },
+			{ keys: ['UP'], type: 'function', command: 'move_up' },
+			{ keys: ['DOWN'], type: 'function', command: 'move_down' },
+			{ keys: ['PAGE_UP'], type: 'function', command: 'page_up' },
+			{ keys: ['PAGE_DOWN'], type: 'function', command: 'page_down' },
+			{ keys: ['ENTER'], type: 'function', command: 'activate' },
+			{ keys: ['DELETE', 'BACKSPACE'], type: 'function', command: 'delete' },
+			{ keys: [' '], command: 'todo toggle $n' },
+			{ keys: ['tc'], type: 'function', command: 'toggle_console' },
+			{ keys: ['tm'], type: 'function', command: 'toggle_metadata' },
+			{ keys: ['/'], type: 'prompt', command: 'search ""', cursorPosition: -2 },
+			{ keys: ['mn'], type: 'prompt', command: 'mknote ""', cursorPosition: -2 },
+			{ keys: ['mt'], type: 'prompt', command: 'mktodo ""', cursorPosition: -2 },
+			{ keys: ['mb'], type: 'prompt', command: 'mkbook ""', cursorPosition: -2 },
+			{ keys: ['yn'], type: 'prompt', command: 'cp $n ""', cursorPosition: -2 },
+			{ keys: ['dn'], type: 'prompt', command: 'mv $n ""', cursorPosition: -2 },
+		];
+
+		// Filter the keymap item by command so that items in keymap.json can override
+		// the default ones.
+		const itemsByCommand = {};
+
+		for (let i = 0; i < defaultKeyMap.length; i++) {
+			itemsByCommand[defaultKeyMap[i].command] = defaultKeyMap[i];
+		}
+
+		const filePath = `${Setting.value('profileDir')}/keymap.json`;
+		if (await fs.pathExists(filePath)) {
+			try {
+				let configString = await fs.readFile(filePath, 'utf-8');
+				configString = configString.replace(/^\s*\/\/.*/, ''); // Strip off comments
+				const keymap = JSON.parse(configString);
+				for (let keymapIndex = 0; keymapIndex < keymap.length; keymapIndex++) {
+					const item = keymap[keymapIndex];
+					itemsByCommand[item.command] = item;
+				}
+			} catch (error) {
+				let msg = error.message ? error.message : '';
+				msg = `Could not load keymap ${filePath}\n${msg}`;
+				error.message = msg;
+				throw error;
+			}
+		}
+
+		const output = [];
+		for (const n in itemsByCommand) {
+			if (!itemsByCommand.hasOwnProperty(n)) continue;
+			output.push(itemsByCommand[n]);
+		}
+
+		// Map reserved shortcuts to their equivalent key
+		// https://github.com/cronvel/terminal-kit/issues/101
+		for (let i = 0; i < output.length; i++) {
+			const newKeys = output[i].keys.map(k => {
+				k = k.replace(/CTRL_H/g, 'BACKSPACE');
+				k = k.replace(/CTRL_I/g, 'TAB');
+				k = k.replace(/CTRL_M/g, 'ENTER');
+				return k;
+			});
+			output[i].keys = newKeys;
+		}
+
+		return output;
+	}
+
 	async start(argv) {
 		argv = await super.start(argv);
 
-		cliUtils.setStdout((object) => {
+		cliUtils.setStdout(object => {
 			return this.stdout(object);
 		});
 
@@ -326,20 +396,32 @@ class Application extends BaseApplication {
 
 			this.currentFolder_ = await Folder.load(Setting.value('activeFolderId'));
 
+			await this.applySettingsSideEffects();
+
 			try {
 				await this.execCommand(argv);
 			} catch (error) {
 				if (this.showStackTraces_) {
-					console.info(error);
+					console.error(error);
 				} else {
 					console.info(error.message);
 				}
+				process.exit(1);
 			}
-		} else { // Otherwise open the GUI
+
+			await Setting.saveAll();
+
+			// Need to call exit() explicitly, otherwise Node wait for any timeout to complete
+			// https://stackoverflow.com/questions/18050095
+			process.exit(0);
+		} else {
+			// Otherwise open the GUI
 			this.initRedux();
 
+			const keymap = await this.loadKeymaps();
+
 			const AppGui = require('./app-gui.js');
-			this.gui_ = new AppGui(this, this.store());
+			this.gui_ = new AppGui(this, this.store(), keymap);
 			this.gui_.setLogger(this.logger_);
 			await this.gui_.start();
 
@@ -352,6 +434,10 @@ class Application extends BaseApplication {
 
 			const tags = await Tag.allWithNotes();
 
+			ResourceService.runInBackground();
+
+			RevisionService.instance().runInBackground();
+
 			this.dispatch({
 				type: 'TAG_UPDATE_ALL',
 				items: tags,
@@ -363,7 +449,6 @@ class Application extends BaseApplication {
 			});
 		}
 	}
-
 }
 
 let application_ = null;
@@ -374,4 +459,4 @@ function app() {
 	return application_;
 }
 
-module.exports = { app };
+module.exports = { app };

CliClient/app/autocompletion.js

@@ -1,51 +1,56 @@
-var { app } = require('./app.js');
-var Note = require('lib/models/Note.js');
-var Folder = require('lib/models/Folder.js');
-var Tag = require('lib/models/Tag.js');
-var { cliUtils } = require('./cli-utils.js');
-var yargParser = require('yargs-parser');
-var fs = require('fs-extra');
+const { app } = require('./app.js');
+const Note = require('lib/models/Note.js');
+const Folder = require('lib/models/Folder.js');
+const Tag = require('lib/models/Tag.js');
+const { cliUtils } = require('./cli-utils.js');
+const yargParser = require('yargs-parser');
+const fs = require('fs-extra');
 
 async function handleAutocompletionPromise(line) {
 	// Auto-complete the command name
 	const names = await app().commandNames();
-	let words = getArguments(line);
-	//If there is only one word and it is not already a command name then you
-	//should look for commmands it could be
+	const words = getArguments(line);
+	// If there is only one word and it is not already a command name then you
+	// should look for commands it could be
 	if (words.length == 1) {
 		if (names.indexOf(words[0]) === -1) {
-			let x = names.filter((n) => n.indexOf(words[0]) === 0);
+			const x = names.filter(n => n.indexOf(words[0]) === 0);
 			if (x.length === 1) {
-				return x[0] + ' ';
+				return `${x[0]} `;
 			}
-			return x.length > 0 ? x.map((a) => a + ' ') : line;
+			return x.length > 0 ? x.map(a => `${a} `) : line;
 		} else {
 			return line;
 		}
 	}
-	//There is more than one word and it is a command
+	// There is more than one word and it is a command
 	const metadata = (await app().commandMetadata())[words[0]];
-	//If for some reason this command does not have any associated metadata
-	//just don't autocomplete. However, this should not happen.
+	// If for some reason this command does not have any associated metadata
+	// just don't autocomplete. However, this should not happen.
 	if (metadata === undefined) {
 		return line;
 	}
-	//complete an option
-	let next = words.length > 1 ? words[words.length - 1] : '';
-	let l = [];
+
+	if (words[0] === 'tag' && words[1] === 'notetags') {
+		metadata.usage = 'tag <tag-command> <note>';
+	}
+
+	// complete an option
+	const next = words.length > 1 ? words[words.length - 1] : '';
+	const l = [];
 	if (next[0] === '-') {
-		for (let i = 0; i<metadata.options.length; i++) {
+		for (let i = 0; i < metadata.options.length; i++) {
 			const options = metadata.options[i][0].split(' ');
-		//if there are multiple options then they will be seperated by comma and
-			//space. The comma should be removed
+			// if there are multiple options then they will be separated by comma and
+			// space. The comma should be removed
 			if (options[0][options[0].length - 1] === ',') {
 				options[0] = options[0].slice(0, -1);
 			}
 			if (words.includes(options[0]) || words.includes(options[1])) {
 				continue;
 			}
-			//First two elements are the flag and the third is the description
-			//Only autocomplete long
+			// First two elements are the flag and the third is the description
+			// Only autocomplete long
 			if (options.length > 1 && options[1].indexOf(next) === 0) {
 				l.push(options[1]);
 			} else if (options[0].indexOf(next) === 0) {
@@ -55,70 +60,68 @@ async function handleAutocompletionPromise(line) {
 		if (l.length === 0) {
 			return line;
 		}
-		let ret = l.map(a=>toCommandLine(a));
-		ret.prefix = toCommandLine(words.slice(0, -1)) + ' ';
+		const ret = l.map(a => toCommandLine(a));
+		ret.prefix = `${toCommandLine(words.slice(0, -1))} `;
 		return ret;
 	}
-	//Complete an argument
-	//Determine the number of positional arguments by counting the number of
-	//words that don't start with a - less one for the command name
-	const positionalArgs = words.filter((a)=>a.indexOf('-') !== 0).length - 1;
+	// Complete an argument
+	// Determine the number of positional arguments by counting the number of
+	// words that don't start with a - less one for the command name
+	const positionalArgs = words.filter(a => a.indexOf('-') !== 0).length - 1;
 
-	let cmdUsage = yargParser(metadata.usage)['_'];
+	const cmdUsage = yargParser(metadata.usage)['_'];
 	cmdUsage.splice(0, 1);
 
 	if (cmdUsage.length >= positionalArgs) {
-
 		let argName = cmdUsage[positionalArgs - 1];
 		argName = cliUtils.parseCommandArg(argName).name;
 
 		const currentFolder = app().currentFolder();
 
 		if (argName == 'note' || argName == 'note-pattern') {
-			const notes = currentFolder ? await Note.previews(currentFolder.id, { titlePattern: next + '*' }) : [];
-			l.push(...notes.map((n) => n.title));
+			const notes = currentFolder ? await Note.previews(currentFolder.id, { titlePattern: `${next}*` }) : [];
+			l.push(...notes.map(n => n.title));
 		}
 
 		if (argName == 'notebook') {
-			const folders = await Folder.search({ titlePattern: next + '*' });
-			l.push(...folders.map((n) => n.title));
+			const folders = await Folder.search({ titlePattern: `${next}*` });
+			l.push(...folders.map(n => n.title));
 		}
 
 		if (argName == 'item') {
-			const notes = currentFolder ? await Note.previews(currentFolder.id, { titlePattern: next + '*' }) : [];
-			const folders = await Folder.search({ titlePattern: next + '*' });
-			l.push(...notes.map((n) => n.title), folders.map((n) => n.title));
+			const notes = currentFolder ? await Note.previews(currentFolder.id, { titlePattern: `${next}*` }) : [];
+			const folders = await Folder.search({ titlePattern: `${next}*` });
+			l.push(...notes.map(n => n.title), folders.map(n => n.title));
 		}
 
 		if (argName == 'tag') {
-			let tags = await Tag.search({ titlePattern: next + '*' });
-			l.push(...tags.map((n) => n.title));
+			const tags = await Tag.search({ titlePattern: `${next}*` });
+			l.push(...tags.map(n => n.title));
 		}
 
 		if (argName == 'file') {
-			let files = await fs.readdir('.');
+			const files = await fs.readdir('.');
 			l.push(...files);
 		}
 
 		if (argName == 'tag-command') {
-			let c = filterList(['add', 'remove', 'list'], next);
+			const c = filterList(['add', 'remove', 'list', 'notetags'], next);
 			l.push(...c);
 		}
 
 		if (argName == 'todo-command') {
-			let c = filterList(['toggle', 'clear'], next);
+			const c = filterList(['toggle', 'clear'], next);
 			l.push(...c);
 		}
 	}
 	if (l.length === 1) {
 		return toCommandLine([...words.slice(0, -1), l[0]]);
 	} else if (l.length > 1) {
-		let ret = l.map(a=>toCommandLine(a));
-		ret.prefix = toCommandLine(words.slice(0, -1)) + ' ';
+		const ret = l.map(a => toCommandLine(a));
+		ret.prefix = `${toCommandLine(words.slice(0, -1))} `;
 		return ret;
 	}
 	return line;
-
 }
 function handleAutocompletion(str, callback) {
 	handleAutocompletionPromise(str).then(function(res) {
@@ -127,22 +130,24 @@ function handleAutocompletion(str, callback) {
 }
 function toCommandLine(args) {
 	if (Array.isArray(args)) {
-		return args.map(function(a) {
-			if(a.indexOf('"') !== -1 || a.indexOf(' ') !== -1) {
-				return "'" + a + "'";
-			} else if (a.indexOf("'") !== -1) {
-				return '"' + a + '"';
-			} else {
-				return a;
-			}
-		}).join(' ');
+		return args
+			.map(function(a) {
+				if (a.indexOf('"') !== -1 || a.indexOf(' ') !== -1) {
+					return `'${a}'`;
+				} else if (a.indexOf('\'') !== -1) {
+					return `"${a}"`;
+				} else {
+					return a;
+				}
+			})
+			.join(' ');
 	} else {
-		if(args.indexOf('"') !== -1 || args.indexOf(' ') !== -1) {
-			return "'" + args + "' ";
-		} else if (args.indexOf("'") !== -1) {
-			return '"' + args + '" ';
+		if (args.indexOf('"') !== -1 || args.indexOf(' ') !== -1) {
+			return `'${args}' `;
+		} else if (args.indexOf('\'') !== -1) {
+			return `"${args}" `;
 		} else {
-			return args + ' ';
+			return `${args} `;
 		}
 	}
 }
@@ -150,28 +155,27 @@ function getArguments(line) {
 	let inSingleQuotes = false;
 	let inDoubleQuotes = false;
 	let currentWord = '';
-	let parsed = [];
-	for(let i = 0; i<line.length; i++) {
-		if(line[i] === '"') {
-			if(inDoubleQuotes) {
+	const parsed = [];
+	for (let i = 0; i < line.length; i++) {
+		if (line[i] === '"') {
+			if (inDoubleQuotes) {
 				inDoubleQuotes = false;
-				//maybe push word to parsed?
-				//currentWord += '"';
+				// maybe push word to parsed?
+				// currentWord += '"';
 			} else {
 				inDoubleQuotes = true;
-				//currentWord += '"';
+				// currentWord += '"';
 			}
-		} else if(line[i] === "'") {
-			if(inSingleQuotes) {
+		} else if (line[i] === '\'') {
+			if (inSingleQuotes) {
 				inSingleQuotes = false;
-				//maybe push word to parsed?
-				//currentWord += "'";
+				// maybe push word to parsed?
+				// currentWord += "'";
 			} else {
 				inSingleQuotes = true;
-				//currentWord += "'";
+				// currentWord += "'";
 			}
-		} else if (/\s/.test(line[i]) &&
-			!(inDoubleQuotes || inSingleQuotes)) {
+		} else if (/\s/.test(line[i]) && !(inDoubleQuotes || inSingleQuotes)) {
 			if (currentWord !== '') {
 				parsed.push(currentWord);
 				currentWord = '';
@@ -188,7 +192,7 @@ function getArguments(line) {
 	return parsed;
 }
 function filterList(list, next) {
-	let output = [];
+	const output = [];
 	for (let i = 0; i < list.length; i++) {
 		if (list[i].indexOf(next) !== 0) continue;
 		output.push(list[i]);

CliClient/app/base-command.js

@@ -2,7 +2,6 @@ const { _ } = require('lib/locale.js');
 const { reg } = require('lib/registry.js');
 
 class BaseCommand {
-
 	constructor() {
 		this.stdout_ = null;
 		this.prompt_ = null;
@@ -20,7 +19,7 @@ class BaseCommand {
 		throw new Error('Description not defined');
 	}
 
-	async action(args) {
+	async action() {
 		throw new Error('Action not defined');
 	}
 
@@ -32,10 +31,6 @@ class BaseCommand {
 		return this.compatibleUis().indexOf(ui) >= 0;
 	}
 
-	aliases() {
-		return [];
-	}
-
 	options() {
 		return [];
 	}
@@ -55,7 +50,7 @@ class BaseCommand {
 	async cancel() {}
 
 	name() {
-		let r = this.usage().split(' ');
+		const r = this.usage().split(' ');
 		return r[0];
 	}
 
@@ -97,7 +92,6 @@ class BaseCommand {
 	logger() {
 		return reg.logger();
 	}
-
 }
 
-module.exports = { BaseCommand };
+module.exports = { BaseCommand };

CliClient/app/build-doc.js

@@ -1,7 +1,7 @@
 const fs = require('fs-extra');
-const { fileExtension, basename, dirname } = require('lib/path-utils.js');
+const { fileExtension, dirname } = require('lib/path-utils.js');
 const wrap_ = require('word-wrap');
-const { _, setLocale, languageCode } = require('lib/locale.js');
+const { languageCode } = require('lib/locale.js');
 
 const rootDir = dirname(dirname(__dirname));
 const MAX_WIDTH = 78;
@@ -15,25 +15,25 @@ function wrap(text, indent) {
 }
 
 function renderOptions(options) {
-	let output = [];
+	const output = [];
 	const optionColWidth = getOptionColWidth(options);
 
 	for (let i = 0; i < options.length; i++) {
-		let option = options[i];
+		const option = options[i];
 		const flag = option[0];
 		const indent = INDENT + INDENT + ' '.repeat(optionColWidth + 2);
-		
+
 		let r = wrap(option[1], indent);
 		r = r.substr(flag.length + (INDENT + INDENT).length);
 		r = INDENT + INDENT + flag + r;
 		output.push(r);
 	}
 
-	return output.join("\n");
+	return output.join('\n');
 }
 
 function renderCommand(cmd) {
-	let output = [];
+	const output = [];
 	output.push(INDENT + cmd.usage());
 	output.push('');
 	output.push(wrap(cmd.description(), INDENT + INDENT));
@@ -44,18 +44,18 @@ function renderCommand(cmd) {
 		output.push('');
 		output.push(optionString);
 	}
-	return output.join("\n");
+	return output.join('\n');
 }
 
 function getCommands() {
-	let output = [];
-	fs.readdirSync(__dirname).forEach((path) => {
+	const output = [];
+	fs.readdirSync(__dirname).forEach(path => {
 		if (path.indexOf('command-') !== 0) return;
-		const ext = fileExtension(path)
+		const ext = fileExtension(path);
 		if (ext != 'js') return;
 
-		let CommandClass = require('./' + path);
-		let cmd = new CommandClass();
+		const CommandClass = require(`./${path}`);
+		const cmd = new CommandClass();
 		if (!cmd.enabled()) return;
 		if (cmd.hidden()) return;
 		output.push(cmd);
@@ -73,7 +73,7 @@ function getOptionColWidth(options) {
 }
 
 function getHeader() {
-	let output = [];
+	const output = [];
 
 	output.push('NAME');
 	output.push('');
@@ -84,56 +84,56 @@ function getHeader() {
 	output.push('DESCRIPTION');
 	output.push('');
 
-	let description = [];
+	const description = [];
 	description.push('Joplin is a note taking and to-do application, which can handle a large number of notes organised into notebooks.');
 	description.push('The notes are searchable, can be copied, tagged and modified with your own text editor.');
-	description.push("\n\n");
+	description.push('\n\n');
 	description.push('The notes can be synchronised with various target including the file system (for example with a network directory) or with Microsoft OneDrive.');
-	description.push("\n\n");
+	description.push('\n\n');
 	description.push('Notes exported from Evenotes via .enex files can be imported into Joplin, including the formatted content, resources (images, attachments, etc.) and complete metadata (geolocation, updated time, created time, etc.).');
 
 	output.push(wrap(description.join(''), INDENT));
 
-	return output.join("\n");
+	return output.join('\n');
 }
 
 function getFooter() {
-	let output = [];
+	const output = [];
 
 	output.push('WEBSITE');
 	output.push('');
-	output.push(INDENT + 'http://joplin.cozic.net');
+	output.push(`${INDENT}https://joplinapp.org`);
 
 	output.push('');
 
 	output.push('LICENSE');
 	output.push('');
-	let filePath = rootDir + '/LICENSE_' + languageCode();
-	if (!fs.existsSync(filePath)) filePath = rootDir + '/LICENSE';
+	let filePath = `${rootDir}/LICENSE_${languageCode()}`;
+	if (!fs.existsSync(filePath)) filePath = `${rootDir}/LICENSE`;
 	const licenseText = fs.readFileSync(filePath, 'utf8');
 	output.push(wrap(licenseText, INDENT));
 
-	return output.join("\n");
+	return output.join('\n');
 }
 
 async function main() {
 	// setLocale('fr_FR');
 
 	const commands = getCommands();
-	let commandBlocks = [];
+	const commandBlocks = [];
 
 	for (let i = 0; i < commands.length; i++) {
-		let cmd = commands[i];
+		const cmd = commands[i];
 		commandBlocks.push(renderCommand(cmd));
 	}
 
 	const headerText = getHeader();
-	const commandsText = commandBlocks.join("\n\n");
+	const commandsText = commandBlocks.join('\n\n');
 	const footerText = getFooter();
 
-	console.info(headerText + "\n\n" + 'USAGE' + "\n\n" + commandsText + "\n\n" + footerText);
+	console.info(`${headerText}\n\n` + 'USAGE' + `\n\n${commandsText}\n\n${footerText}`);
 }
 
-main().catch((error) => {
+main().catch(error => {
 	console.error(error);
-});
+});

CliClient/app/cli-integration-tests.js

@@ -1,4 +1,4 @@
-"use strict"
+'use strict';
 
 const fs = require('fs-extra');
 const { Logger } = require('lib/logger.js');
@@ -10,14 +10,14 @@ const Folder = require('lib/models/Folder.js');
 const Note = require('lib/models/Note.js');
 const Setting = require('lib/models/Setting.js');
 const { sprintf } = require('sprintf-js');
-const exec = require('child_process').exec
+const exec = require('child_process').exec;
 
 process.on('unhandledRejection', (reason, p) => {
 	console.error('Unhandled promise rejection', p, 'reason:', reason);
 });
 
-const baseDir = dirname(__dirname) + '/tests/cli-integration';
-const joplinAppPath = __dirname + '/main.js';
+const baseDir = `${dirname(__dirname)}/tests/cli-integration`;
+const joplinAppPath = `${__dirname}/main.js`;
 
 const logger = new Logger();
 logger.addTarget('console');
@@ -32,17 +32,17 @@ db.setLogger(dbLogger);
 
 function createClient(id) {
 	return {
-		'id': id,
-		'profileDir': baseDir + '/client' + id,
+		id: id,
+		profileDir: `${baseDir}/client${id}`,
 	};
 }
 
 const client = createClient(1);
 
-function execCommand(client, command, options = {}) {
-	let exePath = 'node ' + joplinAppPath;
-	let cmd = exePath + ' --update-geolocation-disabled --env dev --profile ' + client.profileDir + ' ' + command;
-	logger.info(client.id + ': ' + command);
+function execCommand(client, command) {
+	const exePath = `node ${joplinAppPath}`;
+	const cmd = `${exePath} --update-geolocation-disabled --env dev --profile ${client.profileDir} ${command}`;
+	logger.info(`${client.id}: ${command}`);
 
 	return new Promise((resolve, reject) => {
 		exec(cmd, (error, stdout, stderr) => {
@@ -72,14 +72,7 @@ function assertEquals(expected, real) {
 }
 
 async function clearDatabase() {
-	await db.transactionExecBatch([
-		'DELETE FROM folders',
-		'DELETE FROM notes',
-		'DELETE FROM tags',
-		'DELETE FROM note_tags',
-		'DELETE FROM resources',
-		'DELETE FROM deleted_items',
-	]);
+	await db.transactionExecBatch(['DELETE FROM folders', 'DELETE FROM notes', 'DELETE FROM tags', 'DELETE FROM note_tags', 'DELETE FROM resources', 'DELETE FROM deleted_items']);
 }
 
 const testUnits = {};
@@ -101,7 +94,7 @@ testUnits.testFolders = async () => {
 
 	folders = await Folder.all();
 	assertEquals(0, folders.length);
-}
+};
 
 testUnits.testNotes = async () => {
 	await execCommand(client, 'mkbook nb1');
@@ -121,23 +114,23 @@ testUnits.testNotes = async () => {
 	notes = await Note.all();
 	assertEquals(2, notes.length);
 
-	await execCommand(client, "rm -f 'blabla*'");
+	await execCommand(client, 'rm -f \'blabla*\'');
 
 	notes = await Note.all();
 	assertEquals(2, notes.length);
 
-	await execCommand(client, "rm -f 'n*'");
+	await execCommand(client, 'rm -f \'n*\'');
 
 	notes = await Note.all();
 	assertEquals(0, notes.length);
-}
+};
 
 testUnits.testCat = async () => {
 	await execCommand(client, 'mkbook nb1');
 	await execCommand(client, 'mknote mynote');
 
-	let folder = await Folder.loadByTitle('nb1');
-	let note = await Note.loadFolderNoteByField(folder.id, 'title', 'mynote');
+	const folder = await Folder.loadByTitle('nb1');
+	const note = await Note.loadFolderNoteByField(folder.id, 'title', 'mynote');
 
 	let r = await execCommand(client, 'cat mynote');
 	assertTrue(r.indexOf('mynote') >= 0);
@@ -145,7 +138,7 @@ testUnits.testCat = async () => {
 
 	r = await execCommand(client, 'cat -v mynote');
 	assertTrue(r.indexOf(note.id) >= 0);
-}
+};
 
 testUnits.testConfig = async () => {
 	await execCommand(client, 'config editor vim');
@@ -156,10 +149,10 @@ testUnits.testConfig = async () => {
 	await Setting.load();
 	assertEquals('subl', Setting.value('editor'));
 
-	let r = await execCommand(client, 'config');
+	const r = await execCommand(client, 'config');
 	assertTrue(r.indexOf('editor') >= 0);
 	assertTrue(r.indexOf('subl') >= 0);
-}
+};
 
 testUnits.testCp = async () => {
 	await execCommand(client, 'mkbook nb2');
@@ -168,29 +161,29 @@ testUnits.testCp = async () => {
 
 	await execCommand(client, 'cp n1');
 
-	let f1 = await Folder.loadByTitle('nb1');
-	let f2 = await Folder.loadByTitle('nb2');
+	const f1 = await Folder.loadByTitle('nb1');
+	const f2 = await Folder.loadByTitle('nb2');
 	let notes = await Note.previews(f1.id);
 
 	assertEquals(2, notes.length);
 
 	await execCommand(client, 'cp n1 nb2');
-	let notesF1 = await Note.previews(f1.id);
+	const notesF1 = await Note.previews(f1.id);
 	assertEquals(2, notesF1.length);
 	notes = await Note.previews(f2.id);
 	assertEquals(1, notes.length);
 	assertEquals(notesF1[0].title, notes[0].title);
-}
+};
 
 testUnits.testLs = async () => {
 	await execCommand(client, 'mkbook nb1');
 	await execCommand(client, 'mknote note1');
 	await execCommand(client, 'mknote note2');
-	let r = await execCommand(client, 'ls');
+	const r = await execCommand(client, 'ls');
 
 	assertTrue(r.indexOf('note1') >= 0);
 	assertTrue(r.indexOf('note2') >= 0);
-}
+};
 
 testUnits.testMv = async () => {
 	await execCommand(client, 'mkbook nb2');
@@ -198,8 +191,8 @@ testUnits.testMv = async () => {
 	await execCommand(client, 'mknote n1');
 	await execCommand(client, 'mv n1 nb2');
 
-	let f1 = await Folder.loadByTitle('nb1');
-	let f2 = await Folder.loadByTitle('nb2');
+	const f1 = await Folder.loadByTitle('nb1');
+	const f2 = await Folder.loadByTitle('nb2');
 	let notes1 = await Note.previews(f1.id);
 	let notes2 = await Note.previews(f2.id);
 
@@ -210,40 +203,40 @@ testUnits.testMv = async () => {
 	await execCommand(client, 'mknote note2');
 	await execCommand(client, 'mknote note3');
 	await execCommand(client, 'mknote blabla');
-	await execCommand(client, "mv 'note*' nb2");
+	await execCommand(client, 'mv \'note*\' nb2');
 
 	notes1 = await Note.previews(f1.id);
 	notes2 = await Note.previews(f2.id);
 
 	assertEquals(1, notes1.length);
 	assertEquals(4, notes2.length);
-}
+};
 
-async function main(argv) {
+async function main() {
 	await fs.remove(baseDir);
 
 	logger.info(await execCommand(client, 'version'));
 
-	await db.open({ name: client.profileDir + '/database.sqlite' });
-	BaseModel.db_ = db;
+	await db.open({ name: `${client.profileDir}/database.sqlite` });
+	BaseModel.setDb(db);
 	await Setting.load();
 
 	let onlyThisTest = 'testMv';
 	onlyThisTest = '';
 
-	for (let n in testUnits) {
+	for (const n in testUnits) {
 		if (!testUnits.hasOwnProperty(n)) continue;
 		if (onlyThisTest && n != onlyThisTest) continue;
 
 		await clearDatabase();
-		let testName = n.substr(4).toLowerCase();
-		process.stdout.write(testName + ': ');
+		const testName = n.substr(4).toLowerCase();
+		process.stdout.write(`${testName}: `);
 		await testUnits[n]();
 		console.info('');
 	}
 }
 
-main(process.argv).catch((error) => {
+main(process.argv).catch(error => {
 	console.info('');
 	logger.error(error);
-});
+});

CliClient/app/cli-utils.js

@@ -5,42 +5,41 @@ const stringPadding = require('string-padding');
 
 const cliUtils = {};
 
-cliUtils.printArray = function(logFunction, rows, headers = null) {
+cliUtils.printArray = function(logFunction, rows) {
 	if (!rows.length) return '';
 
 	const ALIGN_LEFT = 0;
 	const ALIGN_RIGHT = 1;
 
-	let colWidths = [];
-	let colAligns = [];
+	const colWidths = [];
+	const colAligns = [];
 
 	for (let i = 0; i < rows.length; i++) {
-		let row = rows[i];
-		
+		const row = rows[i];
+
 		for (let j = 0; j < row.length; j++) {
-			let item = row[j];
-			let width = item ? item.toString().length : 0;
-			let align = typeof item == 'number' ? ALIGN_RIGHT : ALIGN_LEFT;
+			const item = row[j];
+			const width = item ? item.toString().length : 0;
+			const align = typeof item == 'number' ? ALIGN_RIGHT : ALIGN_LEFT;
 			if (!colWidths[j] || colWidths[j] < width) colWidths[j] = width;
 			if (colAligns.length <= j) colAligns[j] = align;
 		}
 	}
 
-	let lines = [];
 	for (let row = 0; row < rows.length; row++) {
-		let line = [];
+		const line = [];
 		for (let col = 0; col < colWidths.length; col++) {
-			let item = rows[row][col];
-			let width = colWidths[col];
-			let dir = colAligns[col] == ALIGN_LEFT ? stringPadding.RIGHT : stringPadding.LEFT;
+			const item = rows[row][col];
+			const width = colWidths[col];
+			const dir = colAligns[col] == ALIGN_LEFT ? stringPadding.RIGHT : stringPadding.LEFT;
 			line.push(stringPadding(item, width, ' ', dir));
 		}
 		logFunction(line.join(' '));
 	}
-}
+};
 
 cliUtils.parseFlags = function(flags) {
-	let output = {};
+	const output = {};
 	flags = flags.split(',');
 	for (let i = 0; i < flags.length; i++) {
 		let f = flags[i].trim();
@@ -56,10 +55,10 @@ cliUtils.parseFlags = function(flags) {
 		}
 	}
 	return output;
-}
+};
 
 cliUtils.parseCommandArg = function(arg) {
-	if (arg.length <= 2) throw new Error('Invalid command arg: ' + arg);
+	if (arg.length <= 2) throw new Error(`Invalid command arg: ${arg}`);
 
 	const c1 = arg[0];
 	const c2 = arg[arg.length - 1];
@@ -70,22 +69,21 @@ cliUtils.parseCommandArg = function(arg) {
 	} else if (c1 == '[' && c2 == ']') {
 		return { required: false, name: name };
 	} else {
-		throw new Error('Invalid command arg: ' + arg);
+		throw new Error(`Invalid command arg: ${arg}`);
 	}
-}
+};
 
 cliUtils.makeCommandArgs = function(cmd, argv) {
 	let cmdUsage = cmd.usage();
 	cmdUsage = yargParser(cmdUsage);
-	let output = {};
+	const output = {};
 
-	let options = cmd.options();
-	let booleanFlags = [];
-	let aliases = {};
+	const options = cmd.options();
+	const booleanFlags = [];
+	const aliases = {};
 	for (let i = 0; i < options.length; i++) {
-		if (options[i].length != 2) throw new Error('Invalid options: ' + options[i]);
+		if (options[i].length != 2) throw new Error(`Invalid options: ${options[i]}`);
 		let flags = options[i][0];
-		let text = options[i][1];
 
 		flags = cliUtils.parseFlags(flags);
 
@@ -99,7 +97,7 @@ cliUtils.makeCommandArgs = function(cmd, argv) {
 		}
 	}
 
-	let args = yargParser(argv, {
+	const args = yargParser(argv, {
 		boolean: booleanFlags,
 		alias: aliases,
 		string: ['_'],
@@ -115,8 +113,8 @@ cliUtils.makeCommandArgs = function(cmd, argv) {
 		}
 	}
 
-	let argOptions = {};
-	for (let key in args) {
+	const argOptions = {};
+	for (const key in args) {
 		if (!args.hasOwnProperty(key)) continue;
 		if (key == '_') continue;
 		argOptions[key] = args[key];
@@ -125,27 +123,27 @@ cliUtils.makeCommandArgs = function(cmd, argv) {
 	output.options = argOptions;
 
 	return output;
-}
+};
 
 cliUtils.promptMcq = function(message, answers) {
 	const readline = require('readline');
 
 	const rl = readline.createInterface({
 		input: process.stdin,
-		output: process.stdout
+		output: process.stdout,
 	});
 
-	message += "\n\n";
-	for (let n in answers) {
+	message += '\n\n';
+	for (const n in answers) {
 		if (!answers.hasOwnProperty(n)) continue;
-		message += _('%s: %s', n, answers[n]) + "\n";
+		message += `${_('%s: %s', n, answers[n])}\n`;
 	}
 
-	message += "\n";
+	message += '\n';
 	message += _('Your choice: ');
 
 	return new Promise((resolve, reject) => {
-		rl.question(message, (answer) => {
+		rl.question(message, answer => {
 			rl.close();
 
 			if (!(answer in answers)) {
@@ -156,7 +154,7 @@ cliUtils.promptMcq = function(message, answers) {
 			resolve(answer);
 		});
 	});
-}
+};
 
 cliUtils.promptConfirm = function(message, answers = null) {
 	if (!answers) answers = [_('Y'), _('n')];
@@ -164,23 +162,24 @@ cliUtils.promptConfirm = function(message, answers = null) {
 
 	const rl = readline.createInterface({
 		input: process.stdin,
-		output: process.stdout
+		output: process.stdout,
 	});
 
-	message += ' (' + answers.join('/') + ')';
+	message += ` (${answers.join('/')})`;
 
-	return new Promise((resolve, reject) => {
-		rl.question(message + ' ', (answer) => {
+	return new Promise((resolve) => {
+		rl.question(`${message} `, answer => {
 			const ok = !answer || answer.toLowerCase() == answers[0].toLowerCase();
 			rl.close();
 			resolve(ok);
 		});
 	});
-}
+};
 
 // Note: initialText is there to have the same signature as statusBar.prompt() so that
 // it can be a drop-in replacement, however initialText is not used (and cannot be
 // with readline.question?).
+// eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars
 cliUtils.prompt = function(initialText = '', promptString = ':', options = null) {
 	if (!options) options = {};
 
@@ -189,10 +188,9 @@ cliUtils.prompt = function(initialText = '', promptString = ':', options = null)
 
 	const mutableStdout = new Writable({
 		write: function(chunk, encoding, callback) {
-			if (!this.muted)
-			process.stdout.write(chunk, encoding);
+			if (!this.muted) process.stdout.write(chunk, encoding);
 			callback();
-		}
+		},
 	});
 
 	const rl = readline.createInterface({
@@ -201,18 +199,18 @@ cliUtils.prompt = function(initialText = '', promptString = ':', options = null)
 		terminal: true,
 	});
 
-	return new Promise((resolve, reject) => {
+	return new Promise((resolve) => {
 		mutableStdout.muted = false;
 
-		rl.question(promptString, (answer) => {
+		rl.question(promptString, answer => {
 			rl.close();
-			if (!!options.secure) this.stdout_('');
+			if (options.secure) this.stdout_('');
 			resolve(answer);
 		});
 
 		mutableStdout.muted = !!options.secure;
 	});
-}
+};
 
 let redrawStarted_ = false;
 let redrawLastLog_ = null;
@@ -220,7 +218,7 @@ let redrawLastUpdateTime_ = 0;
 
 cliUtils.setStdout = function(v) {
 	this.stdout_ = v;
-}
+};
 
 cliUtils.redraw = function(s) {
 	const now = time.unixMs();
@@ -233,8 +231,8 @@ cliUtils.redraw = function(s) {
 		redrawLastLog_ = s;
 	}
 
-   redrawStarted_ = true;
-}
+	redrawStarted_ = true;
+};
 
 cliUtils.redrawDone = function() {
 	if (!redrawStarted_) return;
@@ -245,6 +243,6 @@ cliUtils.redrawDone = function() {
 
 	redrawLastLog_ = null;
 	redrawStarted_ = false;
-}
+};
 
-module.exports = { cliUtils };
+module.exports = { cliUtils };

CliClient/app/command-apidoc.js

@@ -0,0 +1,321 @@
+const { BaseCommand } = require('./base-command.js');
+const BaseItem = require('lib/models/BaseItem');
+const BaseModel = require('lib/BaseModel');
+const { toTitleCase } = require('lib/string-utils.js');
+const { reg } = require('lib/registry.js');
+const markdownUtils = require('lib/markdownUtils');
+const { Database } = require('lib/database.js');
+
+class Command extends BaseCommand {
+	usage() {
+		return 'apidoc';
+	}
+
+	description() {
+		return 'Build the API doc';
+	}
+
+	enabled() {
+		return false;
+	}
+
+	createPropertiesTable(tableFields) {
+		const headers = [
+			{ name: 'name', label: 'Name' },
+			{
+				name: 'type',
+				label: 'Type',
+				filter: value => {
+					return Database.enumName('fieldType', value);
+				},
+			},
+			{ name: 'description', label: 'Description' },
+		];
+
+		return markdownUtils.createMarkdownTable(headers, tableFields);
+	}
+
+	async action() {
+		const models = [
+			{
+				type: BaseModel.TYPE_NOTE,
+			},
+			{
+				type: BaseModel.TYPE_FOLDER,
+			},
+			{
+				type: BaseModel.TYPE_RESOURCE,
+			},
+			{
+				type: BaseModel.TYPE_TAG,
+			},
+		];
+
+		const lines = [];
+
+		lines.push('# Joplin API');
+		lines.push('');
+
+		lines.push('');
+		lines.push('In order to use it, you\'ll first need to find on which port the service is running. To do so, open the Web Clipper Options in Joplin and if the service is running it should tell you on which port. Normally it runs on port **41184**. If you want to find it programmatically, you may follow this kind of algorithm:');
+		lines.push('');
+		lines.push('```javascript');
+		lines.push('let port = null;');
+		lines.push('for (let portToTest = 41184; portToTest <= 41194; portToTest++) {');
+		lines.push('    const result = pingPort(portToTest); // Call GET /ping');
+		lines.push('    if (result == \'JoplinClipperServer\') {');
+		lines.push('        port = portToTest; // Found the port');
+		lines.push('        break;');
+		lines.push('    }');
+		lines.push('}');
+		lines.push('```');
+		lines.push('');
+
+		lines.push('# Authorisation');
+		lines.push('');
+		lines.push('To prevent unauthorised applications from accessing the API, the calls must be authentified. To do so, you must provide a token as a query parameter for each API call. You can get this token from the Joplin desktop application, on the Web Clipper Options screen.');
+		lines.push('');
+		lines.push('This would be an example of valid cURL call using a token:');
+		lines.push('');
+		lines.push('\tcurl http://localhost:41184/notes?token=ABCD123ABCD123ABCD123ABCD123ABCD123');
+		lines.push('');
+		lines.push('In the documentation below, the token will not be specified every time however you will need to include it.');
+		lines.push('');
+
+		lines.push('# Using the API');
+		lines.push('');
+		lines.push('All the calls, unless noted otherwise, receives and send **JSON data**. For example to create a new note:');
+		lines.push('');
+		lines.push('\tcurl --data \'{ "title": "My note", "body": "Some note in **Markdown**"}\' http://localhost:41184/notes');
+		lines.push('');
+		lines.push('In the documentation below, the calls may include special parameters such as :id or :note_id. You would replace this with the item ID or note ID.');
+		lines.push('');
+		lines.push('For example, for the endpoint `DELETE /tags/:id/notes/:note_id`, to remove the tag with ID "ABCD1234" from the note with ID "EFGH789", you would run for example:');
+		lines.push('');
+		lines.push('\tcurl -X DELETE http://localhost:41184/tags/ABCD1234/notes/EFGH789');
+		lines.push('');
+		lines.push('The four verbs supported by the API are the following ones:');
+		lines.push('');
+		lines.push('* **GET**: To retrieve items (notes, notebooks, etc.).');
+		lines.push('* **POST**: To create new items. In general most item properties are optional. If you omit any, a default value will be used.');
+		lines.push('* **PUT**: To update an item. Note in a REST API, traditionally PUT is used to completely replace an item, however in this API it will only replace the properties that are provided. For example if you PUT {"title": "my new title"}, only the "title" property will be changed. The other properties will be left untouched (they won\'t be cleared nor changed).');
+		lines.push('* **DELETE**: To delete items.');
+		lines.push('');
+
+		lines.push('# Filtering data');
+		lines.push('');
+		lines.push('You can change the fields that will be returned by the API using the `fields=` query parameter, which takes a list of comma separated fields. For example, to get the longitude and latitude of a note, use this:');
+		lines.push('');
+		lines.push('\tcurl http://localhost:41184/notes/ABCD123?fields=longitude,latitude');
+		lines.push('');
+		lines.push('To get the IDs only of all the tags:');
+		lines.push('');
+		lines.push('\tcurl http://localhost:41184/tags?fields=id');
+		lines.push('');
+
+		lines.push('# Error handling');
+		lines.push('');
+		lines.push('In case of an error, an HTTP status code >= 400 will be returned along with a JSON object that provides more info about the error. The JSON object is in the format `{ "error": "description of error" }`.');
+		lines.push('');
+
+		lines.push('# About the property types');
+		lines.push('');
+		lines.push('* Text is UTF-8.');
+		lines.push('* All date/time are Unix timestamps in milliseconds.');
+		lines.push('* Booleans are integer values 0 or 1.');
+		lines.push('');
+
+		lines.push('# Testing if the service is available');
+		lines.push('');
+		lines.push('Call **GET /ping** to check if the service is available. It should return "JoplinClipperServer" if it works.');
+		lines.push('');
+
+		lines.push('# Searching');
+		lines.push('');
+		lines.push('Call **GET /search?query=YOUR_QUERY** to search for notes. This end-point supports the `field` parameter which is recommended to use so that you only get the data that you need. The query syntax is as described in the main documentation: https://joplinapp.org/#searching');
+		lines.push('');
+		lines.push('To retrieve non-notes items, such as notebooks or tags, add a `type` parameter and set it to the required [item type name](#item-type-id). In that case, full text search will not be used - instead it will be a simple case-insensitive search. You can also use `*` as a wildcard. This is convenient for example to retrieve notebooks or tags by title.');
+		lines.push('');
+		lines.push('For example, to retrieve the notebook named `recipes`: **GET /search?query=recipes&type=folder**');
+		lines.push('');
+		lines.push('To retrieve all the tags that start with `project-`: **GET /search?query=project-*&type=tag**');
+		lines.push('');
+
+		lines.push('# Item type IDs');
+		lines.push('');
+		lines.push('Item type IDs might be refered to in certain object you will retrieve from the API. This is the correspondance between name and ID:');
+		lines.push('');
+		lines.push('Name | Value');
+		lines.push('---- | -----');
+		for (const t of BaseModel.typeEnum_) {
+			const value = t[1];
+			lines.push(`${BaseModel.modelTypeToName(value)} | ${value}   `);
+		}
+		lines.push('');
+
+		for (let i = 0; i < models.length; i++) {
+			const model = models[i];
+			const ModelClass = BaseItem.getClassByItemType(model.type);
+			const tableName = ModelClass.tableName();
+			let tableFields = reg.db().tableFields(tableName, { includeDescription: true });
+			const singular = tableName.substr(0, tableName.length - 1);
+
+			if (model.type === BaseModel.TYPE_NOTE) {
+				tableFields = tableFields.slice();
+				tableFields.push({
+					name: 'body_html',
+					type: Database.enumId('fieldType', 'text'),
+					description: 'Note body, in HTML format',
+				});
+				tableFields.push({
+					name: 'base_url',
+					type: Database.enumId('fieldType', 'text'),
+					description: 'If `body_html` is provided and contains relative URLs, provide the `base_url` parameter too so that all the URLs can be converted to absolute ones. The base URL is basically where the HTML was fetched from, minus the query (everything after the \'?\'). For example if the original page was `https://stackoverflow.com/search?q=%5Bjava%5D+test`, the base URL is `https://stackoverflow.com/search`.',
+				});
+				tableFields.push({
+					name: 'image_data_url',
+					type: Database.enumId('fieldType', 'text'),
+					description: 'An image to attach to the note, in [Data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs) format.',
+				});
+				tableFields.push({
+					name: 'crop_rect',
+					type: Database.enumId('fieldType', 'text'),
+					description: 'If an image is provided, you can also specify an optional rectangle that will be used to crop the image. In format `{ x: x, y: y, width: width, height: height }`',
+				});
+				// tableFields.push({
+				// 	name: 'tags',
+				// 	type: Database.enumId('fieldType', 'text'),
+				// 	description: 'Comma-separated list of tags. eg. `tag1,tag2`.',
+				// });
+			}
+
+			lines.push(`# ${toTitleCase(tableName)}`);
+			lines.push('');
+
+			if (model.type === BaseModel.TYPE_FOLDER) {
+				lines.push('This is actually a notebook. Internally notebooks are called "folders".');
+				lines.push('');
+			}
+
+			lines.push('## Properties');
+			lines.push('');
+			lines.push(this.createPropertiesTable(tableFields));
+			lines.push('');
+
+			lines.push(`## GET /${tableName}`);
+			lines.push('');
+			lines.push(`Gets all ${tableName}`);
+			lines.push('');
+
+			if (model.type === BaseModel.TYPE_FOLDER) {
+				lines.push('The folders are returned as a tree. The sub-notebooks of a notebook, if any, are under the `children` key.');
+				lines.push('');
+			}
+
+			lines.push(`## GET /${tableName}/:id`);
+			lines.push('');
+			lines.push(`Gets ${singular} with ID :id`);
+			lines.push('');
+
+			if (model.type === BaseModel.TYPE_TAG) {
+				lines.push('## GET /tags/:id/notes');
+				lines.push('');
+				lines.push('Gets all the notes with this tag.');
+				lines.push('');
+			}
+
+			if (model.type === BaseModel.TYPE_NOTE) {
+				lines.push('## GET /notes/:id/tags');
+				lines.push('');
+				lines.push('Gets all the tags attached to this note.');
+				lines.push('');
+
+				lines.push('## GET /notes/:id/resources');
+				lines.push('');
+				lines.push('Gets all the resources attached to this note.');
+				lines.push('');
+			}
+
+			if (model.type === BaseModel.TYPE_FOLDER) {
+				lines.push('## GET /folders/:id/notes');
+				lines.push('');
+				lines.push('Gets all the notes inside this folder.');
+				lines.push('');
+			}
+
+			if (model.type === BaseModel.TYPE_RESOURCE) {
+				lines.push('## GET /resources/:id/file');
+				lines.push('');
+				lines.push('Gets the actual file associated with this resource.');
+				lines.push('');
+			}
+
+			lines.push(`## POST /${tableName}`);
+			lines.push('');
+			lines.push(`Creates a new ${singular}`);
+			lines.push('');
+
+			if (model.type === BaseModel.TYPE_RESOURCE) {
+				lines.push('Creating a new resource is special because you also need to upload the file. Unlike other API calls, this one must have the "multipart/form-data" Content-Type. The file data must be passed to the "data" form field, and the other properties to the "props" form field. An example of a valid call with cURL would be:');
+				lines.push('');
+				lines.push('\tcurl -F \'data=@/path/to/file.jpg\' -F \'props={"title":"my resource title"}\' http://localhost:41184/resources');
+				lines.push('');
+				lines.push('The "data" field is required, while the "props" one is not. If not specified, default values will be used.');
+				lines.push('');
+			}
+
+			if (model.type === BaseModel.TYPE_TAG) {
+				lines.push('## POST /tags/:id/notes');
+				lines.push('');
+				lines.push('Post a note to this endpoint to add the tag to the note. The note data must at least contain an ID property (all other properties will be ignored).');
+				lines.push('');
+			}
+
+			if (model.type === BaseModel.TYPE_NOTE) {
+				lines.push('You can either specify the note body as Markdown by setting the `body` parameter, or in HTML by setting the `body_html`.');
+				lines.push('');
+				lines.push('Examples:');
+				lines.push('');
+				lines.push('* Create a note from some Markdown text');
+				lines.push('');
+				lines.push('      curl --data \'{ "title": "My note", "body": "Some note in **Markdown**"}\' http://127.0.0.1:41184/notes');
+				lines.push('');
+				lines.push('* Create a note from some HTML');
+				lines.push('');
+				lines.push('      curl --data \'{ "title": "My note", "body_html": "Some note in <b>HTML</b>"}\' http://127.0.0.1:41184/notes');
+				lines.push('');
+				lines.push('* Create a note and attach an image to it:');
+				lines.push('');
+				lines.push('      curl --data \'{ "title": "Image test", "body": "Here is Joplin icon:", "image_data_url": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAgAAAAICAIAAABLbSncAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAANZJREFUeNoAyAA3/wFwtO3K6gUB/vz2+Prw9fj/+/r+/wBZKAAExOgF4/MC9ff+MRH6Ui4E+/0Bqc/zutj6AgT+/Pz7+vv7++nu82c4DlMqCvLs8goA/gL8/fz09fb59vXa6vzZ6vjT5fbn6voD/fwC8vX4UiT9Zi//APHyAP8ACgUBAPv5APz7BPj2+DIaC2o3E+3o6ywaC5fT6gD6/QD9/QEVf9kD+/dcLQgJA/7v8vqfwOf18wA1IAIEVycAyt//v9XvAPv7APz8LhoIAPz9Ri4OAgwARgx4W/6fVeEAAAAASUVORK5CYII="}\' http://127.0.0.1:41184/notes');
+				lines.push('');
+				lines.push('### Creating a note with a specific ID');
+				lines.push('');
+				lines.push('When a new note is created, it is automatically assigned a new unique ID so **normally you do not need to set the ID**. However, if for some reason you want to set it, you can supply it as the `id` property. It needs to be a 32 characters long hexadecimal string. **Make sure it is unique**, for example by generating it using whatever GUID function is available in your programming language.');
+				lines.push('');
+				lines.push('      curl --data \'{ "id": "00a87474082744c1a8515da6aa5792d2", "title": "My note with custom ID"}\' http://127.0.0.1:41184/notes');
+				lines.push('');
+			}
+
+			lines.push(`## PUT /${tableName}/:id`);
+			lines.push('');
+			lines.push(`Sets the properties of the ${singular} with ID :id`);
+			lines.push('');
+
+			lines.push(`## DELETE /${tableName}/:id`);
+			lines.push('');
+			lines.push(`Deletes the ${singular} with ID :id`);
+			lines.push('');
+
+			if (model.type === BaseModel.TYPE_TAG) {
+				lines.push('## DELETE /tags/:id/notes/:note_id');
+				lines.push('');
+				lines.push('Remove the tag from the note.');
+				lines.push('');
+			}
+		}
+
+		this.stdout(lines.join('\n'));
+	}
+}
+
+module.exports = Command;

CliClient/app/command-attach.js

@@ -3,10 +3,8 @@ const { app } = require('./app.js');
 const { _ } = require('lib/locale.js');
 const BaseModel = require('lib/BaseModel.js');
 const { shim } = require('lib/shim.js');
-const fs = require('fs-extra');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'attach <note> <file>';
 	}
@@ -16,9 +14,9 @@ class Command extends BaseCommand {
 	}
 
 	async action(args) {
-		let title = args['note'];
+		const title = args['note'];
 
-		let note = await app().loadItem(BaseModel.TYPE_NOTE, title, { parent: app().currentFolder() });
+		const note = await app().loadItem(BaseModel.TYPE_NOTE, title, { parent: app().currentFolder() });
 		this.encryptionCheck(note);
 		if (!note) throw new Error(_('Cannot find "%s".', title));
 
@@ -26,7 +24,6 @@ class Command extends BaseCommand {
 
 		await shim.attachFileToNote(note, localFilePath);
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-cat.js

@@ -2,11 +2,9 @@ const { BaseCommand } = require('./base-command.js');
 const { app } = require('./app.js');
 const { _ } = require('lib/locale.js');
 const BaseModel = require('lib/BaseModel.js');
-const Folder = require('lib/models/Folder.js');
 const Note = require('lib/models/Note.js');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'cat <note>';
 	}
@@ -16,24 +14,25 @@ class Command extends BaseCommand {
 	}
 
 	options() {
-		return [
-			['-v, --verbose', _('Displays the complete information about note.')],
-		];
+		return [['-v, --verbose', _('Displays the complete information about note.')]];
 	}
 
 	async action(args) {
-		let title = args['note'];
+		const title = args['note'];
 
-		let item = await app().loadItem(BaseModel.TYPE_NOTE, title, { parent: app().currentFolder() });
+		const item = await app().loadItem(BaseModel.TYPE_NOTE, title, { parent: app().currentFolder() });
 		if (!item) throw new Error(_('Cannot find "%s".', title));
 
 		const content = args.options.verbose ? await Note.serialize(item) : await Note.serializeForEdit(item);
 		this.stdout(content);
 
-		app().gui().showConsole();
-		app().gui().maximizeConsole();
+		app()
+			.gui()
+			.showConsole();
+		app()
+			.gui()
+			.maximizeConsole();
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-config.js

@@ -1,61 +1,126 @@
 const { BaseCommand } = require('./base-command.js');
 const { _, setLocale } = require('lib/locale.js');
 const { app } = require('./app.js');
+const fs = require('fs-extra');
 const Setting = require('lib/models/Setting.js');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'config [name] [value]';
 	}
 
 	description() {
-		return _("Gets or sets a config value. If [value] is not provided, it will show the value of [name]. If neither [name] nor [value] is provided, it will list the current configuration.");
+		return _('Gets or sets a config value. If [value] is not provided, it will show the value of [name]. If neither [name] nor [value] is provided, it will list the current configuration.');
 	}
 
 	options() {
 		return [
 			['-v, --verbose', _('Also displays unset and hidden config variables.')],
+			['--export', 'Writes all settings to STDOUT as JSON including secure variables.'],
+			['--import', 'Reads in JSON formatted settings from STDIN.'],
+			['--import-file <file>', 'Reads in settings from <file>. <file> must contain valid JSON.'],
 		];
 	}
+	async __importSettings(inputStream) {
+		return new Promise((resolve, reject) => {
+			// being defensive and not attempting to settle twice
+			let isSettled = false;
+			const chunks = [];
 
+			inputStream.on('readable', () => {
+				let chunk;
+				while ((chunk = inputStream.read()) !== null) {
+					chunks.push(chunk);
+				}
+			});
+
+			inputStream.on('end', () => {
+				const json = chunks.join('');
+				let settingsObj;
+				try {
+					settingsObj = JSON.parse(json);
+				} catch (err) {
+					isSettled = true;
+					return reject(new Error(`Invalid JSON passed to config --import: \n${err.message}.`));
+				}
+				if (settingsObj) {
+					Object.entries(settingsObj)
+						.forEach(([key, value]) => {
+							Setting.setValue(key, value);
+						});
+				}
+				if (!isSettled) {
+					isSettled = true;
+					resolve();
+				}
+			});
+
+			inputStream.on('error', (error) => {
+				if (!isSettled) {
+					isSettled = true;
+					reject(error);
+				}
+			});
+		});
+	}
 	async action(args) {
 		const verbose = args.options.verbose;
+		const isExport = args.options.export;
+		const isImport = args.options.import || args.options.importFile;
+		const importFile = args.options.importFile;
 
-		const renderKeyValue = (name) => {
+		const renderKeyValue = name => {
 			const md = Setting.settingMetadata(name);
 			let value = Setting.value(name);
 			if (typeof value === 'object' || Array.isArray(value)) value = JSON.stringify(value);
-			if (md.secure) value = '********';
+			if (md.secure && value) value = '********';
 
 			if (Setting.isEnum(name)) {
 				return _('%s = %s (%s)', name, value, Setting.enumOptionsDoc(name));
 			} else {
 				return _('%s = %s', name, value);
 			}
-		}
+		};
 
-		if (!args.name && !args.value) {
-			let keys = Setting.keys(!verbose, 'cli');
+		if (isExport || (!isImport && !args.value)) {
+			const keys = Setting.keys(!verbose, 'cli');
 			keys.sort();
-			for (let i = 0; i < keys.length; i++) {
-				const value = Setting.value(keys[i]);
-				if (!verbose && !value) continue;
-				this.stdout(renderKeyValue(keys[i]));
+
+			if (isExport) {
+				const resultObj = keys.reduce((acc, key) => {
+					const value = Setting.value(key);
+					if (!verbose && !value) return acc;
+					acc[key] = value;
+					return acc;
+				}, {});
+				// Printing the object in "pretty" format so it's easy to read/edit
+				this.stdout(JSON.stringify(resultObj, null, 2));
+			} else if (!args.name) {
+				for (let i = 0; i < keys.length; i++) {
+					const value = Setting.value(keys[i]);
+					if (!verbose && !value) continue;
+					this.stdout(renderKeyValue(keys[i]));
+				}
+			} else {
+				this.stdout(renderKeyValue(args.name));
 			}
+
 			app().gui().showConsole();
 			app().gui().maximizeConsole();
+
 			return;
 		}
 
-		if (args.name && !args.value) {
-			this.stdout(renderKeyValue(args.name));
-			app().gui().showConsole();
-			app().gui().maximizeConsole();
-			return;
+		if (isImport) {
+			let fileStream = process.stdin;
+			if (importFile) {
+				fileStream = fs.createReadStream(importFile, { autoClose: true });
+			}
+			await this.__importSettings(fileStream);
+		} else {
+			Setting.setValue(args.name, args.value);
 		}
 
-		Setting.setValue(args.name, args.value);
 
 		if (args.name == 'locale') {
 			setLocale(Setting.value('locale'));
@@ -64,7 +129,6 @@ class Command extends BaseCommand {
 
 		await Setting.saveAll();
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-cp.js

@@ -2,11 +2,9 @@ const { BaseCommand } = require('./base-command.js');
 const { app } = require('./app.js');
 const { _ } = require('lib/locale.js');
 const BaseModel = require('lib/BaseModel.js');
-const Folder = require('lib/models/Folder.js');
 const Note = require('lib/models/Note.js');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'cp <note> [notebook]';
 	}
@@ -33,7 +31,6 @@ class Command extends BaseCommand {
 			Note.updateGeolocation(newNote.id);
 		}
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-done.js

@@ -2,12 +2,10 @@ const { BaseCommand } = require('./base-command.js');
 const { app } = require('./app.js');
 const { _ } = require('lib/locale.js');
 const BaseModel = require('lib/BaseModel.js');
-const Folder = require('lib/models/Folder.js');
 const Note = require('lib/models/Note.js');
 const { time } = require('lib/time-utils.js');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'done <note>';
 	}
@@ -35,7 +33,6 @@ class Command extends BaseCommand {
 	async action(args) {
 		await Command.handleAction(this, args, true);
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-dump.js

@@ -1,12 +1,9 @@
 const { BaseCommand } = require('./base-command.js');
-const { app } = require('./app.js');
-const { _ } = require('lib/locale.js');
 const Folder = require('lib/models/Folder.js');
 const Note = require('lib/models/Note.js');
 const Tag = require('lib/models/Tag.js');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'dump';
 	}
@@ -19,26 +16,25 @@ class Command extends BaseCommand {
 		return true;
 	}
 
-	async action(args) {
+	async action() {
 		let items = [];
-		let folders = await Folder.all();
+		const folders = await Folder.all();
 		for (let i = 0; i < folders.length; i++) {
-			let folder = folders[i];
-			let notes = await Note.previews(folder.id);
+			const folder = folders[i];
+			const notes = await Note.previews(folder.id);
 			items.push(folder);
 			items = items.concat(notes);
 		}
 
-		let tags = await Tag.all();
+		const tags = await Tag.all();
 		for (let i = 0; i < tags.length; i++) {
 			tags[i].notes_ = await Tag.noteIds(tags[i].id);
 		}
 
 		items = items.concat(tags);
-		
+
 		this.stdout(JSON.stringify(items));
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-e2ee.js

@@ -1,20 +1,21 @@
 const { BaseCommand } = require('./base-command.js');
 const { _ } = require('lib/locale.js');
-const { cliUtils } = require('./cli-utils.js');
 const EncryptionService = require('lib/services/EncryptionService');
 const DecryptionWorker = require('lib/services/DecryptionWorker');
-const MasterKey = require('lib/models/MasterKey');
 const BaseItem = require('lib/models/BaseItem');
 const Setting = require('lib/models/Setting.js');
+const { shim } = require('lib/shim');
+const pathUtils = require('lib/path-utils.js');
+const imageType = require('image-type');
+const readChunk = require('read-chunk');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'e2ee <command> [path]';
 	}
 
 	description() {
-		return _('Manages E2EE configuration. Commands are `enable`, `disable`, `decrypt`, `status` and `target-status`.');
+		return _('Manages E2EE configuration. Commands are `enable`, `disable`, `decrypt`, `status`, `decrypt-file` and `target-status`.');
 	}
 
 	options() {
@@ -22,21 +23,62 @@ class Command extends BaseCommand {
 			// This is here mostly for testing - shouldn't be used
 			['-p, --password <password>', 'Use this password as master password (For security reasons, it is not recommended to use this option).'],
 			['-v, --verbose', 'More verbose output for the `target-status` command'],
+			['-o, --output <directory>', 'Output directory'],
+			['--retry-failed-items', 'Applies to `decrypt` command - retries decrypting items that previously could not be decrypted.'],
 		];
 	}
 
 	async action(args) {
-		// change-password
-
 		const options = args.options;
 
+		const askForMasterKey = async error => {
+			const masterKeyId = error.masterKeyId;
+			const password = await this.prompt(_('Enter master password:'), { type: 'string', secure: true });
+			if (!password) {
+				this.stdout(_('Operation cancelled'));
+				return false;
+			}
+			Setting.setObjectKey('encryption.passwordCache', masterKeyId, password);
+			await EncryptionService.instance().loadMasterKeysFromSettings();
+			return true;
+		};
+
+		const startDecryption = async () => {
+			this.stdout(_('Starting decryption... Please wait as it may take several minutes depending on how much there is to decrypt.'));
+
+			while (true) {
+				try {
+					await DecryptionWorker.instance().start();
+					break;
+				} catch (error) {
+					if (error.code === 'masterKeyNotLoaded') {
+						const ok = await askForMasterKey(error);
+						if (!ok) return;
+						continue;
+					}
+
+					throw error;
+				}
+			}
+
+			this.stdout(_('Completed decryption.'));
+		};
+
 		if (args.command === 'enable') {
 			const password = options.password ? options.password.toString() : await this.prompt(_('Enter master password:'), { type: 'string', secure: true });
 			if (!password) {
 				this.stdout(_('Operation cancelled'));
 				return;
 			}
-
+			const password2 = await this.prompt(_('Confirm password:'), { type: 'string', secure: true });
+			if (!password2) {
+				this.stdout(_('Operation cancelled'));
+				return;
+			}
+			if (password !== password2) {
+				this.stdout(_('Passwords do not match!'));
+				return;
+			}
 			await EncryptionService.instance().generateMasterKeyAndEnableEncryption(password);
 			return;
 		}
@@ -47,31 +89,14 @@ class Command extends BaseCommand {
 		}
 
 		if (args.command === 'decrypt') {
-			this.stdout(_('Starting decryption... Please wait as it may take several minutes depending on how much there is to decrypt.'));
-
-			while (true) {
-				try {
-					await DecryptionWorker.instance().start();
-					break;
-				} catch (error) {
-					if (error.code === 'masterKeyNotLoaded') {
-						const masterKeyId = error.masterKeyId;
-						const password = await this.prompt(_('Enter master password:'), { type: 'string', secure: true });
-						if (!password) {
-							this.stdout(_('Operation cancelled'));
-							return;
-						}
-						Setting.setObjectKey('encryption.passwordCache', masterKeyId, password);
-						await EncryptionService.instance().loadMasterKeysFromSettings();
-						continue;
-					}
-
-					throw error;
-				}
+			if (args.path) {
+				const plainText = await EncryptionService.instance().decryptString(args.path);
+				this.stdout(plainText);
+			} else {
+				if (args.options['retry-failed-items']) await DecryptionWorker.instance().clearDisabledItems();
+				await startDecryption();
 			}
 
-			this.stdout(_('Completed decryption.'));
-
 			return;
 		}
 
@@ -80,21 +105,49 @@ class Command extends BaseCommand {
 			return;
 		}
 
+		if (args.command === 'decrypt-file') {
+			while (true) {
+				try {
+					const outputDir = options.output ? options.output : require('os').tmpdir();
+					let outFile = `${outputDir}/${pathUtils.filename(args.path)}.${Date.now()}.bin`;
+					await EncryptionService.instance().decryptFile(args.path, outFile);
+					const buffer = await readChunk(outFile, 0, 64);
+					const detectedType = imageType(buffer);
+
+					if (detectedType) {
+						const newOutFile = `${outFile}.${detectedType.ext}`;
+						await shim.fsDriver().move(outFile, newOutFile);
+						outFile = newOutFile;
+					}
+
+					this.stdout(outFile);
+					break;
+				} catch (error) {
+					if (error.code === 'masterKeyNotLoaded') {
+						const ok = await askForMasterKey(error);
+						if (!ok) return;
+						continue;
+					}
+
+					throw error;
+				}
+			}
+			return;
+		}
+
 		if (args.command === 'target-status') {
 			const fs = require('fs-extra');
-			const pathUtils = require('lib/path-utils.js');
-			const fsDriver = new (require('lib/fs-driver-node.js').FsDriverNode)();
 
 			const targetPath = args.path;
 			if (!targetPath) throw new Error('Please specify the sync target path.');
 
 			const dirPaths = function(targetPath) {
-				let paths = [];
-				fs.readdirSync(targetPath).forEach((path) => {
+				const paths = [];
+				fs.readdirSync(targetPath).forEach(path => {
 					paths.push(path);
 				});
 				return paths;
-			}
+			};
 
 			let itemCount = 0;
 			let resourceCount = 0;
@@ -102,24 +155,24 @@ class Command extends BaseCommand {
 			let encryptedResourceCount = 0;
 			let otherItemCount = 0;
 
-			let encryptedPaths = [];
-			let decryptedPaths = [];
+			const encryptedPaths = [];
+			const decryptedPaths = [];
 
-			let paths = dirPaths(targetPath);
+			const paths = dirPaths(targetPath);
 
 			for (let i = 0; i < paths.length; i++) {
 				const path = paths[i];
-				const fullPath = targetPath + '/' + path;
+				const fullPath = `${targetPath}/${path}`;
 				const stat = await fs.stat(fullPath);
 
 				// this.stdout(fullPath);
 
 				if (path === '.resource') {
-					let resourcePaths = dirPaths(fullPath);
+					const resourcePaths = dirPaths(fullPath);
 					for (let j = 0; j < resourcePaths.length; j++) {
 						const resourcePath = resourcePaths[j];
 						resourceCount++;
-						const fullResourcePath = fullPath + '/' + resourcePath;
+						const fullResourcePath = `${fullPath}/${resourcePath}`;
 						const isEncrypted = await EncryptionService.instance().fileIsEncrypted(fullResourcePath);
 						if (isEncrypted) {
 							encryptedResourceCount++;
@@ -153,9 +206,9 @@ class Command extends BaseCommand {
 				}
 			}
 
-			this.stdout('Encrypted items: ' + encryptedItemCount + '/' + itemCount);
-			this.stdout('Encrypted resources: ' + encryptedResourceCount + '/' + resourceCount);
-			this.stdout('Other items (never encrypted): ' + otherItemCount);
+			this.stdout(`Encrypted items: ${encryptedItemCount}/${itemCount}`);
+			this.stdout(`Encrypted resources: ${encryptedResourceCount}/${resourceCount}`);
+			this.stdout(`Other items (never encrypted): ${otherItemCount}`);
 
 			if (options.verbose) {
 				this.stdout('');
@@ -178,7 +231,6 @@ class Command extends BaseCommand {
 			return;
 		}
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-edit.js

@@ -1,17 +1,14 @@
 const fs = require('fs-extra');
 const { BaseCommand } = require('./base-command.js');
+const { splitCommandString } = require('lib/string-utils.js');
 const { uuid } = require('lib/uuid.js');
 const { app } = require('./app.js');
 const { _ } = require('lib/locale.js');
-const Folder = require('lib/models/Folder.js');
 const Note = require('lib/models/Note.js');
 const Setting = require('lib/models/Setting.js');
 const BaseModel = require('lib/BaseModel.js');
-const { cliUtils } = require('./cli-utils.js');
-const { time } = require('lib/time-utils.js');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'edit <note>';
 	}
@@ -21,25 +18,24 @@ class Command extends BaseCommand {
 	}
 
 	async action(args) {
-		let watcher = null;
 		let tempFilePath = null;
 
 		const onFinishedEditing = async () => {
 			if (tempFilePath) fs.removeSync(tempFilePath);
-		}
+		};
 
 		const textEditorPath = () => {
 			if (Setting.value('editor')) return Setting.value('editor');
 			if (process.env.EDITOR) return process.env.EDITOR;
 			throw new Error(_('No text editor is defined. Please set it using `config editor <editor-path>`'));
-		}
+		};
 
-		try {		
+		try {
 			// -------------------------------------------------------------------------
 			// Load note or create it if it doesn't exist
 			// -------------------------------------------------------------------------
 
-			let title = args['note'];
+			const title = args['note'];
 
 			if (!app().currentFolder()) throw new Error(_('No active notebook.'));
 			let note = await app().loadItem(BaseModel.TYPE_NOTE, title);
@@ -58,14 +54,14 @@ class Command extends BaseCommand {
 			// -------------------------------------------------------------------------
 
 			let editorPath = textEditorPath();
-			let editorArgs = editorPath.split(' ');
+			let editorArgs = splitCommandString(editorPath);
 
 			editorPath = editorArgs[0];
 			editorArgs = editorArgs.splice(1);
 
 			const originalContent = await Note.serializeForEdit(note);
 
-			tempFilePath = Setting.value('tempDir') + '/' + uuid.create() + '.md';
+			tempFilePath = `${Setting.value('tempDir')}/${uuid.create()}.md`;
 			editorArgs.push(tempFilePath);
 
 			await fs.writeFile(tempFilePath, originalContent);
@@ -80,7 +76,7 @@ class Command extends BaseCommand {
 			await app().gui().forceRender();
 			const termState = app().gui().termSaveState();
 
-			const spawnSync	= require('child_process').spawnSync;
+			const spawnSync = require('child_process').spawnSync;
 			const result = spawnSync(editorPath, editorArgs, { stdio: 'inherit' });
 
 			if (result.error) this.stdout(_('Error opening note in editor: %s', result.error.message));
@@ -95,7 +91,7 @@ class Command extends BaseCommand {
 
 			const updatedContent = await fs.readFile(tempFilePath, 'utf8');
 			if (updatedContent !== originalContent) {
-				let updatedNote = await Note.unserializeForEdit(updatedContent);
+				const updatedNote = await Note.unserializeForEdit(updatedContent);
 				updatedNote.id = note.id;
 				await Note.save(updatedNote);
 				this.stdout(_('Note has been saved.'));
@@ -107,13 +103,11 @@ class Command extends BaseCommand {
 			});
 
 			await onFinishedEditing();
-
-		} catch(error) {
+		} catch (error) {
 			await onFinishedEditing();
 			throw error;
 		}
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-exit.js

@@ -3,7 +3,6 @@ const { app } = require('./app.js');
 const { _ } = require('lib/locale.js');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'exit';
 	}
@@ -16,10 +15,9 @@ class Command extends BaseCommand {
 		return ['gui'];
 	}
 
-	async action(args) {
+	async action() {
 		await app().exit();
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-export-sync-status.js

@@ -1,13 +1,10 @@
 const { BaseCommand } = require('./base-command.js');
-const { Database } = require('lib/database.js');
 const { app } = require('./app.js');
 const Setting = require('lib/models/Setting.js');
-const { _ } = require('lib/locale.js');
 const { ReportService } = require('lib/services/report.js');
 const fs = require('fs-extra');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'export-sync-status';
 	}
@@ -20,17 +17,20 @@ class Command extends BaseCommand {
 		return true;
 	}
 
-	async action(args) {
+	async action() {
 		const service = new ReportService();
 		const csv = await service.basicItemList({ format: 'csv' });
-		const filePath = Setting.value('profileDir') + '/syncReport-' + (new Date()).getTime() + '.csv';
+		const filePath = `${Setting.value('profileDir')}/syncReport-${new Date().getTime()}.csv`;
 		await fs.writeFileSync(filePath, csv);
-		this.stdout('Sync status exported to ' + filePath);
+		this.stdout(`Sync status exported to ${filePath}`);
 
-		app().gui().showConsole();
-		app().gui().maximizeConsole();
+		app()
+			.gui()
+			.showConsole();
+		app()
+			.gui()
+			.maximizeConsole();
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-export.js

@@ -1,59 +1,49 @@
 const { BaseCommand } = require('./base-command.js');
-const { Exporter } = require('lib/services/exporter.js');
+const InteropService = require('lib/services/InteropService.js');
 const BaseModel = require('lib/BaseModel.js');
-const Note = require('lib/models/Note.js');
-const { reg } = require('lib/registry.js');
 const { app } = require('./app.js');
 const { _ } = require('lib/locale.js');
-const fs = require('fs-extra');
 
 class Command extends BaseCommand {
-
 	usage() {
-		return 'export <directory>';
+		return 'export <path>';
 	}
 
 	description() {
-		return _('Exports Joplin data to the given directory. By default, it will export the complete database including notebooks, notes, tags and resources.');
+		return _('Exports Joplin data to the given path. By default, it will export the complete database including notebooks, notes, tags and resources.');
 	}
 
 	options() {
-		return [
-			['--note <note>', _('Exports only the given note.')],
-			['--notebook <notebook>', _('Exports only the given notebook.')],
-		];
+		const service = new InteropService();
+		const formats = service
+			.modules()
+			.filter(m => m.type === 'exporter')
+			.map(m => m.format + (m.description ? ` (${m.description})` : ''));
+
+		return [['--format <format>', _('Destination format: %s', formats.join(', '))], ['--note <note>', _('Exports only the given note.')], ['--notebook <notebook>', _('Exports only the given notebook.')]];
 	}
-	
+
 	async action(args) {
-		let exportOptions = {};
-		exportOptions.destDir = args.directory;
-		exportOptions.writeFile = (filePath, data) => {
-			return fs.writeFile(filePath, data);
-		};
-		exportOptions.copyFile = (source, dest) => {
-			return fs.copy(source, dest, { overwrite: true });
-		};
+		const exportOptions = {};
+		exportOptions.path = args.path;
+
+		exportOptions.format = args.options.format ? args.options.format : 'jex';
 
 		if (args.options.note) {
-
 			const notes = await app().loadItems(BaseModel.TYPE_NOTE, args.options.note, { parent: app().currentFolder() });
 			if (!notes.length) throw new Error(_('Cannot find "%s".', args.options.note));
-			exportOptions.sourceNoteIds = notes.map((n) => n.id);
-
+			exportOptions.sourceNoteIds = notes.map(n => n.id);
 		} else if (args.options.notebook) {
-
 			const folders = await app().loadItems(BaseModel.TYPE_FOLDER, args.options.notebook);
 			if (!folders.length) throw new Error(_('Cannot find "%s".', args.options.notebook));
-			exportOptions.sourceFolderIds = folders.map((n) => n.id);
-
+			exportOptions.sourceFolderIds = folders.map(n => n.id);
 		}
 
-		const exporter = new Exporter();
-		const result = await exporter.export(exportOptions);
+		const service = new InteropService();
+		const result = await service.export(exportOptions);
 
-		reg.logger().info('Export result: ', result);
+		result.warnings.map(w => this.stdout(w));
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-geoloc.js

@@ -2,11 +2,9 @@ const { BaseCommand } = require('./base-command.js');
 const { app } = require('./app.js');
 const { _ } = require('lib/locale.js');
 const BaseModel = require('lib/BaseModel.js');
-const Folder = require('lib/models/Folder.js');
 const Note = require('lib/models/Note.js');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'geoloc <note>';
 	}
@@ -16,16 +14,17 @@ class Command extends BaseCommand {
 	}
 
 	async action(args) {
-		let title = args['note'];
+		const title = args['note'];
 
-		let item = await app().loadItem(BaseModel.TYPE_NOTE, title, { parent: app().currentFolder() });
+		const item = await app().loadItem(BaseModel.TYPE_NOTE, title, { parent: app().currentFolder() });
 		if (!item) throw new Error(_('Cannot find "%s".', title));
 		const url = Note.geolocationUrl(item);
 		this.stdout(url);
 
-		app().gui().showConsole();
+		app()
+			.gui()
+			.showConsole();
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-help.js

@@ -1,14 +1,10 @@
 const { BaseCommand } = require('./base-command.js');
 const { app } = require('./app.js');
 const { renderCommandHelp } = require('./help-utils.js');
-const { Database } = require('lib/database.js');
-const Setting = require('lib/models/Setting.js');
-const { wrap } = require('lib/string-utils.js');
 const { _ } = require('lib/locale.js');
 const { cliUtils } = require('./cli-utils.js');
 
 class Command extends BaseCommand {
-
 	usage() {
 		return 'help [command]';
 	}
@@ -19,8 +15,8 @@ class Command extends BaseCommand {
 
 	allCommands() {
 		const commands = app().commands(app().uiType());
-		let output = [];
-		for (let n in commands) {
+		const output = [];
+		for (const n in commands) {
 			if (!commands.hasOwnProperty(n)) continue;
 			const command = commands[n];
 			if (command.hidden()) continue;
@@ -28,7 +24,7 @@ class Command extends BaseCommand {
 			output.push(command);
 		}
 
-		output.sort((a, b) => a.name() < b.name() ? -1 : +1);
+		output.sort((a, b) => (a.name() < b.name() ? -1 : +1));
 
 		return output;
 	}
@@ -36,34 +32,41 @@ class Command extends BaseCommand {
 	async action(args) {
 		const stdoutWidth = app().commandStdoutMaxWidth();
 
-		if (args.command === 'shortcuts') {
-			if (app().gui().isDummy()) {
+		if (args.command === 'shortcuts' || args.command === 'keymap') {
+			this.stdout(_('For information on how to customise the shortcuts please visit %s', 'https://joplinapp.org/terminal/#shortcuts'));
+			this.stdout('');
+
+			if (
+				app()
+					.gui()
+					.isDummy()
+			) {
 				throw new Error(_('Shortcuts are not available in CLI mode.'));
 			}
 
-			const shortcuts = app().gui().shortcuts();
+			const keymap = app()
+				.gui()
+				.keymap();
 
-			let rows = [];
+			const rows = [];
 
-			for (let n in shortcuts) {
-				if (!shortcuts.hasOwnProperty(n)) continue;
-				const shortcut = shortcuts[n];
-				if (!shortcut.description) continue;
-				n = shortcut.friendlyName ? shortcut.friendlyName : n;
-				rows.push([n, shortcut.description()]);
+			for (let i = 0; i < keymap.length; i++) {
+				const item = keymap[i];
+				const keys = item.keys.map(k => (k === ' ' ? '(SPACE)' : k));
+				rows.push([keys.join(', '), item.command]);
 			}
 
 			cliUtils.printArray(this.stdout.bind(this), rows);
 		} else if (args.command === 'all') {
 			const commands = this.allCommands();
-			const output = commands.map((c) => renderCommandHelp(c));
+			const output = commands.map(c => renderCommandHelp(c));
 			this.stdout(output.join('\n\n'));
 		} else if (args.command) {
 			const command = app().findCommandByName(args['command']);
 			if (!command) throw new Error(_('Cannot find "%s".', args.command));
 			this.stdout(renderCommandHelp(command, stdoutWidth));
 		} else {
-			const commandNames = this.allCommands().map((a) => a.name());
+			const commandNames = this.allCommands().map(a => a.name());
 
 			this.stdout(_('Type `help [command]` for more information about a command; or type `help all` for the complete usage information.'));
 			this.stdout('');
@@ -71,20 +74,23 @@ class Command extends BaseCommand {
 			this.stdout('');
 			this.stdout(commandNames.join(', '));
 			this.stdout('');
-			this.stdout(_('In any command, a note or notebook can be refered to by title or ID, or using the shortcuts `$n` or `$b` for, respectively, the currently selected note or notebook. `$c` can be used to refer to the currently selected item.'));
+			this.stdout(_('In any command, a note or notebook can be referred to by title or ID, or using the shortcuts `$n` or `$b` for, respectively, the currently selected note or notebook. `$c` can be used to refer to the currently selected item.'));
 			this.stdout('');
 			this.stdout(_('To move from one pane to another, press Tab or Shift+Tab.'));
 			this.stdout(_('Use the arrows and page up/down to scroll the lists and text areas (including this console).'));
-			this.stdout(_('To maximise/minimise the console, press "TC".'));
+			this.stdout(_('To maximise/minimise the console, press "tc".'));
 			this.stdout(_('To enter command line mode, press ":"'));
 			this.stdout(_('To exit command line mode, press ESCAPE'));
-			this.stdout(_('For the complete list of available keyboard shortcuts, type `help shortcuts`'));
+			this.stdout(_('For the list of keyboard shortcuts and config options, type `help keymap`'));
 		}
 
-		app().gui().showConsole();
-		app().gui().maximizeConsole();
+		app()
+			.gui()
+			.showConsole();
+		app()
+			.gui()
+			.maximizeConsole();
 	}
-
 }
 
-module.exports = Command;
+module.exports = Command;

CliClient/app/command-import-enex.js

@@ -1,68 +0,0 @@
-const { BaseCommand } = require('./base-command.js');
-const { app } = require('./app.js');
-const { _ } = require('lib/locale.js');
-const Folder = require('lib/models/Folder.js');
-const { importEnex } = require('lib/import-enex');
-const { filename, basename } = require('lib/path-utils.js');
-const { cliUtils } = require('./cli-utils.js');
-
-class Command extends BaseCommand {
-
-	usage() {
-		return 'import-enex <file> [notebook]';
-	}
-
-	description() {
-		return _('Imports an Evernote notebook file (.enex file).');
-	}
-
-	options() {
-		return [
-			['-f, --force', _('Do not ask for confirmation.')],
-		];
-	}
-
-	async action(args) {
-		let filePath = args.file;
-		let folder = null;
-		let folderTitle = args['notebook'];
-		let force = args.options.force === true;
-
-		if (!folderTitle) folderTitle = filename(filePath);
-		folder = await Folder.loadByField('title', folderTitle);
-		const msg = folder ? _('File "%s" will be imported into existing notebook "%s". Continue?', basename(filePath), folderTitle) : _('New notebook "%s" will be created and file "%s" will be imported into it. Continue?', folderTitle, basename(filePath));
-		const ok = force ? true : await this.prompt(msg);
-		if (!ok) return;
-
-		let lastProgress = '';
-
-		let options = {
-			onProgress: (progressState) => {
-				let line = [];
-				line.push(_('Found: %d.', progressState.loaded));
-				line.push(_('Created: %d.', progressState.created));
-				if (progressState.updated) line.push(_('Updated: %d.', progressState.updated));
-				if (progressState.skipped) line.push(_('Skipped: %d.', progressState.skipped));
-				if (progressState.resourcesCreated) line.push(_('Resources: %d.', progressState.resourcesCreated));
-				if (progressState.notesTagged) line.push(_('Tagged: %d.', progressState.notesTagged));
-				lastProgress = line.join(' ');
-				cliUtils.redraw(lastProgress);
-			},
-			onError: (error) => {
-				let s = error.trace ? error.trace : error.toString();
-				this.stdout(s);
-			},
-		}
-
-		folder = !folder ? await Folder.save({ title: folderTitle }) : folder;
-		
-		app().gui().showConsole();
-		this.stdout(_('Importing notes...'));
-		await importEnex(folder.id, filePath, options);
-		cliUtils.redrawDone();
-		this.stdout(_('The notes have been imported: %s', lastProgress));
-	}
-
-}
-
-module.exports = Command;

CliClient/app/command-import.js

@@ -0,0 +1,70 @@
+const { BaseCommand } = require('./base-command.js');
+const InteropService = require('lib/services/InteropService.js');
+const BaseModel = require('lib/BaseModel.js');
+const { cliUtils } = require('./cli-utils.js');
+const { app } = require('./app.js');
+const { _ } = require('lib/locale.js');
+
+class Command extends BaseCommand {
+	usage() {
+		return 'import <path> [notebook]';
+	}
+
+	description() {
+		return _('Imports data into Joplin.');
+	}
+
+	options() {
+		const service = new InteropService();
+		const formats = service
+			.modules()
+			.filter(m => m.type === 'importer')
+			.map(m => m.format);
+
+		return [['--format <format>', _('Source format: %s', ['auto'].concat(formats).join(', '))], ['-f, --force', _('Do not ask for confirmation.')]];
+	}
+
+	async action(args) {
+		const folder = await app().loadItem(BaseModel.TYPE_FOLDER, args.notebook);
+
+		if (args.notebook && !folder) throw new Error(_('Cannot find "%s".', args.notebook));
+
+		const importOptions = {};
+		importOptions.path = args.path;
+		importOptions.format = args.options.format ? args.options.format : 'auto';
+		importOptions.destinationFolderId = folder ? folder.id : null;
+
+		let lastProgress = '';
+
+		// onProgress/onError supported by Enex import only
+
+		importOptions.onProgress = progressState => {
+			const line = [];
+			line.push(_('Found: %d.', progressState.loaded));
+			line.push(_('Created: %d.', progressState.created));
+			if (progressState.updated) line.push(_('Updated: %d.', progressState.updated));
+			if (progressState.skipped) line.push(_('Skipped: %d.', progressState.skipped));
+			if (progressState.resourcesCreated) line.push(_('Resources: %d.', progressState.resourcesCreated));
+			if (progressState.notesTagged) line.push(_('Tagged: %d.', progressState.notesTagged));
+			lastProgress = line.join(' ');
+			cliUtils.redraw(lastProgress);
+		};
+
+		importOptions.onError = error => {
+			const s = error.trace ? error.trace : error.toString();
+			this.stdout(s);
+		};
+
+		app()
+			.gui()
+			.showConsole();
+		this.stdout(_('Importing notes...'));
+		const service = new InteropService();
+		const result = await service.import(importOptions);
+		result.warnings.map(w => this.stdout(w));
+		cliUtils.redrawDone();
+		if (lastProgress) this.stdout(_('The notes have been imported: %s', lastProgress));
+	}
+}
+
+module.exports = Command;