minor fixes

Update to add case insensitive sorting - https://discourse.joplinapp.org/t/a-feature-request/13486/5?u=daeraxa

.dockerignore

@@ -0,0 +1,9 @@
+**/node_modules
+Assets/
+.git/
+_releases/
+packages/app-desktop
+packages/app-cli
+packages/app-mobile
+packages/app-clipper
+packages/generator-joplin

.env-sample

@@ -0,0 +1,9 @@
+# Example of local config, for development:
+#
+# JOPLIN_BASE_URL=http://localhost:22300
+# JOPLIN_PORT=22300
+
+# Example of config for production:
+#
+# JOPLIN_BASE_URL=https://example.com/joplin
+# JOPLIN_PORT=22300

.eslintignore

@@ -6,6 +6,7 @@ _releases/
 **/node_modules/
 Assets/
 docs/
+packages/server/dist/
 highlight.pack.js
 Modules/TinyMCE/IconPack/postinstall.js
 Modules/TinyMCE/JoplinLists/
@@ -154,6 +155,9 @@ packages/app-cli/tests/support/plugins/content_script/api/types.js.map
 packages/app-cli/tests/support/plugins/content_script/src/index.d.ts
 packages/app-cli/tests/support/plugins/content_script/src/index.js
 packages/app-cli/tests/support/plugins/content_script/src/index.js.map
+packages/app-cli/tests/support/plugins/content_script/src/markdownItTestPlugin.d.ts
+packages/app-cli/tests/support/plugins/content_script/src/markdownItTestPlugin.js
+packages/app-cli/tests/support/plugins/content_script/src/markdownItTestPlugin.js.map
 packages/app-cli/tests/support/plugins/dialog/api/index.d.ts
 packages/app-cli/tests/support/plugins/dialog/api/index.js
 packages/app-cli/tests/support/plugins/dialog/api/index.js.map
@@ -802,6 +806,9 @@ packages/app-mobile/components/screens/Note.js.map
 packages/app-mobile/components/screens/UpgradeSyncTargetScreen.d.ts
 packages/app-mobile/components/screens/UpgradeSyncTargetScreen.js
 packages/app-mobile/components/screens/UpgradeSyncTargetScreen.js.map
+packages/app-mobile/root.d.ts
+packages/app-mobile/root.js
+packages/app-mobile/root.js.map
 packages/app-mobile/services/AlarmServiceDriver.android.d.ts
 packages/app-mobile/services/AlarmServiceDriver.android.js
 packages/app-mobile/services/AlarmServiceDriver.android.js.map
@@ -889,12 +896,18 @@ packages/lib/InMemoryCache.js.map
 packages/lib/JoplinServerApi.d.ts
 packages/lib/JoplinServerApi.js
 packages/lib/JoplinServerApi.js.map
+packages/lib/JoplinServerApi2.d.ts
+packages/lib/JoplinServerApi2.js
+packages/lib/JoplinServerApi2.js.map
 packages/lib/Logger.d.ts
 packages/lib/Logger.js
 packages/lib/Logger.js.map
 packages/lib/PoorManIntervals.d.ts
 packages/lib/PoorManIntervals.js
 packages/lib/PoorManIntervals.js.map
+packages/lib/SyncTargetJoplinServer.d.ts
+packages/lib/SyncTargetJoplinServer.js
+packages/lib/SyncTargetJoplinServer.js.map
 packages/lib/Synchronizer.d.ts
 packages/lib/Synchronizer.js
 packages/lib/Synchronizer.js.map
@@ -916,12 +929,18 @@ packages/lib/errorUtils.js.map
 packages/lib/eventManager.d.ts
 packages/lib/eventManager.js
 packages/lib/eventManager.js.map
+packages/lib/file-api-driver-joplinServer.d.ts
+packages/lib/file-api-driver-joplinServer.js
+packages/lib/file-api-driver-joplinServer.js.map
 packages/lib/fs-driver-base.d.ts
 packages/lib/fs-driver-base.js
 packages/lib/fs-driver-base.js.map
 packages/lib/fs-driver-node.d.ts
 packages/lib/fs-driver-node.js
 packages/lib/fs-driver-node.js.map
+packages/lib/import-enex-md-gen.d.ts
+packages/lib/import-enex-md-gen.js
+packages/lib/import-enex-md-gen.js.map
 packages/lib/locale.d.ts
 packages/lib/locale.js
 packages/lib/locale.js.map
@@ -1372,6 +1391,12 @@ packages/renderer/MdToHtml/rules/mermaid.js.map
 packages/renderer/MdToHtml/rules/sanitize_html.d.ts
 packages/renderer/MdToHtml/rules/sanitize_html.js
 packages/renderer/MdToHtml/rules/sanitize_html.js.map
+packages/renderer/MdToHtml/setupLinkify.d.ts
+packages/renderer/MdToHtml/setupLinkify.js
+packages/renderer/MdToHtml/setupLinkify.js.map
+packages/renderer/MdToHtml/validateLinks.d.ts
+packages/renderer/MdToHtml/validateLinks.js
+packages/renderer/MdToHtml/validateLinks.js.map
 packages/renderer/htmlUtils.d.ts
 packages/renderer/htmlUtils.js
 packages/renderer/htmlUtils.js.map
@@ -1387,4 +1412,238 @@ packages/renderer/pathUtils.js.map
 packages/renderer/utils.d.ts
 packages/renderer/utils.js
 packages/renderer/utils.js.map
+packages/server/src/app.d.ts
+packages/server/src/app.js
+packages/server/src/app.js.map
+packages/server/src/config-base.d.ts
+packages/server/src/config-base.js
+packages/server/src/config-base.js.map
+packages/server/src/config-buildTypes.d.ts
+packages/server/src/config-buildTypes.js
+packages/server/src/config-buildTypes.js.map
+packages/server/src/config-dev.d.ts
+packages/server/src/config-dev.js
+packages/server/src/config-dev.js.map
+packages/server/src/config-prod.d.ts
+packages/server/src/config-prod.js
+packages/server/src/config-prod.js.map
+packages/server/src/config-tests.d.ts
+packages/server/src/config-tests.js
+packages/server/src/config-tests.js.map
+packages/server/src/config.d.ts
+packages/server/src/config.js
+packages/server/src/config.js.map
+packages/server/src/controllers/BaseController.d.ts
+packages/server/src/controllers/BaseController.js
+packages/server/src/controllers/BaseController.js.map
+packages/server/src/controllers/api/FileController.d.ts
+packages/server/src/controllers/api/FileController.js
+packages/server/src/controllers/api/FileController.js.map
+packages/server/src/controllers/api/FileController.test.d.ts
+packages/server/src/controllers/api/FileController.test.js
+packages/server/src/controllers/api/FileController.test.js.map
+packages/server/src/controllers/api/OAuthController.d.ts
+packages/server/src/controllers/api/OAuthController.js
+packages/server/src/controllers/api/OAuthController.js.map
+packages/server/src/controllers/api/SessionController.d.ts
+packages/server/src/controllers/api/SessionController.js
+packages/server/src/controllers/api/SessionController.js.map
+packages/server/src/controllers/api/SessionController.test.d.ts
+packages/server/src/controllers/api/SessionController.test.js
+packages/server/src/controllers/api/SessionController.test.js.map
+packages/server/src/controllers/api/UserController.d.ts
+packages/server/src/controllers/api/UserController.js
+packages/server/src/controllers/api/UserController.js.map
+packages/server/src/controllers/api/UserController.test.d.ts
+packages/server/src/controllers/api/UserController.test.js
+packages/server/src/controllers/api/UserController.test.js.map
+packages/server/src/controllers/factory.d.ts
+packages/server/src/controllers/factory.js
+packages/server/src/controllers/factory.js.map
+packages/server/src/controllers/index/FileController.d.ts
+packages/server/src/controllers/index/FileController.js
+packages/server/src/controllers/index/FileController.js.map
+packages/server/src/controllers/index/HomeController.d.ts
+packages/server/src/controllers/index/HomeController.js
+packages/server/src/controllers/index/HomeController.js.map
+packages/server/src/controllers/index/LoginController.d.ts
+packages/server/src/controllers/index/LoginController.js
+packages/server/src/controllers/index/LoginController.js.map
+packages/server/src/controllers/index/NotificationController.d.ts
+packages/server/src/controllers/index/NotificationController.js
+packages/server/src/controllers/index/NotificationController.js.map
+packages/server/src/controllers/index/ProfileController.d.ts
+packages/server/src/controllers/index/ProfileController.js
+packages/server/src/controllers/index/ProfileController.js.map
+packages/server/src/controllers/index/UserController.d.ts
+packages/server/src/controllers/index/UserController.js
+packages/server/src/controllers/index/UserController.js.map
+packages/server/src/db.d.ts
+packages/server/src/db.js
+packages/server/src/db.js.map
+packages/server/src/middleware/notificationHandler.d.ts
+packages/server/src/middleware/notificationHandler.js
+packages/server/src/middleware/notificationHandler.js.map
+packages/server/src/middleware/ownerHandler.d.ts
+packages/server/src/middleware/ownerHandler.js
+packages/server/src/middleware/ownerHandler.js.map
+packages/server/src/middleware/routeHandler.d.ts
+packages/server/src/middleware/routeHandler.js
+packages/server/src/middleware/routeHandler.js.map
+packages/server/src/migrations/20190913171451_create.d.ts
+packages/server/src/migrations/20190913171451_create.js
+packages/server/src/migrations/20190913171451_create.js.map
+packages/server/src/migrations/20203012152842_notifications.d.ts
+packages/server/src/migrations/20203012152842_notifications.js
+packages/server/src/migrations/20203012152842_notifications.js.map
+packages/server/src/models/ApiClientModel.d.ts
+packages/server/src/models/ApiClientModel.js
+packages/server/src/models/ApiClientModel.js.map
+packages/server/src/models/BaseModel.d.ts
+packages/server/src/models/BaseModel.js
+packages/server/src/models/BaseModel.js.map
+packages/server/src/models/ChangeModel.d.ts
+packages/server/src/models/ChangeModel.js
+packages/server/src/models/ChangeModel.js.map
+packages/server/src/models/ChangeModel.test.d.ts
+packages/server/src/models/ChangeModel.test.js
+packages/server/src/models/ChangeModel.test.js.map
+packages/server/src/models/FileModel.d.ts
+packages/server/src/models/FileModel.js
+packages/server/src/models/FileModel.js.map
+packages/server/src/models/FileModel.test.d.ts
+packages/server/src/models/FileModel.test.js
+packages/server/src/models/FileModel.test.js.map
+packages/server/src/models/NotificationModel.d.ts
+packages/server/src/models/NotificationModel.js
+packages/server/src/models/NotificationModel.js.map
+packages/server/src/models/NotificationModel.test.d.ts
+packages/server/src/models/NotificationModel.test.js
+packages/server/src/models/NotificationModel.test.js.map
+packages/server/src/models/PermissionModel.d.ts
+packages/server/src/models/PermissionModel.js
+packages/server/src/models/PermissionModel.js.map
+packages/server/src/models/SessionModel.d.ts
+packages/server/src/models/SessionModel.js
+packages/server/src/models/SessionModel.js.map
+packages/server/src/models/UserModel.d.ts
+packages/server/src/models/UserModel.js
+packages/server/src/models/UserModel.js.map
+packages/server/src/models/factory.d.ts
+packages/server/src/models/factory.js
+packages/server/src/models/factory.js.map
+packages/server/src/models/utils/pagination.d.ts
+packages/server/src/models/utils/pagination.js
+packages/server/src/models/utils/pagination.js.map
+packages/server/src/models/utils/pagination.test.d.ts
+packages/server/src/models/utils/pagination.test.js
+packages/server/src/models/utils/pagination.test.js.map
+packages/server/src/routes/api/files.d.ts
+packages/server/src/routes/api/files.js
+packages/server/src/routes/api/files.js.map
+packages/server/src/routes/api/index.d.ts
+packages/server/src/routes/api/index.js
+packages/server/src/routes/api/index.js.map
+packages/server/src/routes/api/ping.d.ts
+packages/server/src/routes/api/ping.js
+packages/server/src/routes/api/ping.js.map
+packages/server/src/routes/api/sessions.d.ts
+packages/server/src/routes/api/sessions.js
+packages/server/src/routes/api/sessions.js.map
+packages/server/src/routes/default.d.ts
+packages/server/src/routes/default.js
+packages/server/src/routes/default.js.map
+packages/server/src/routes/index/files.d.ts
+packages/server/src/routes/index/files.js
+packages/server/src/routes/index/files.js.map
+packages/server/src/routes/index/home.d.ts
+packages/server/src/routes/index/home.js
+packages/server/src/routes/index/home.js.map
+packages/server/src/routes/index/login.d.ts
+packages/server/src/routes/index/login.js
+packages/server/src/routes/index/login.js.map
+packages/server/src/routes/index/logout.d.ts
+packages/server/src/routes/index/logout.js
+packages/server/src/routes/index/logout.js.map
+packages/server/src/routes/index/notifications.d.ts
+packages/server/src/routes/index/notifications.js
+packages/server/src/routes/index/notifications.js.map
+packages/server/src/routes/index/profile.d.ts
+packages/server/src/routes/index/profile.js
+packages/server/src/routes/index/profile.js.map
+packages/server/src/routes/index/user.d.ts
+packages/server/src/routes/index/user.js
+packages/server/src/routes/index/user.js.map
+packages/server/src/routes/index/users.d.ts
+packages/server/src/routes/index/users.js
+packages/server/src/routes/index/users.js.map
+packages/server/src/routes/oauth2/authorize.d.ts
+packages/server/src/routes/oauth2/authorize.js
+packages/server/src/routes/oauth2/authorize.js.map
+packages/server/src/routes/routes.d.ts
+packages/server/src/routes/routes.js
+packages/server/src/routes/routes.js.map
+packages/server/src/services/MustacheService.d.ts
+packages/server/src/services/MustacheService.js
+packages/server/src/services/MustacheService.js.map
+packages/server/src/tools/db-migrate.d.ts
+packages/server/src/tools/db-migrate.js
+packages/server/src/tools/db-migrate.js.map
+packages/server/src/tools/dbTools.d.ts
+packages/server/src/tools/dbTools.js
+packages/server/src/tools/dbTools.js.map
+packages/server/src/tools/generate-types.d.ts
+packages/server/src/tools/generate-types.js
+packages/server/src/tools/generate-types.js.map
+packages/server/src/utils/TransactionHandler.d.ts
+packages/server/src/utils/TransactionHandler.js
+packages/server/src/utils/TransactionHandler.js.map
+packages/server/src/utils/auth.d.ts
+packages/server/src/utils/auth.js
+packages/server/src/utils/auth.js.map
+packages/server/src/utils/base64.d.ts
+packages/server/src/utils/base64.js
+packages/server/src/utils/base64.js.map
+packages/server/src/utils/cache.d.ts
+packages/server/src/utils/cache.js
+packages/server/src/utils/cache.js.map
+packages/server/src/utils/defaultView.d.ts
+packages/server/src/utils/defaultView.js
+packages/server/src/utils/defaultView.js.map
+packages/server/src/utils/errors.d.ts
+packages/server/src/utils/errors.js
+packages/server/src/utils/errors.js.map
+packages/server/src/utils/htmlUtils.d.ts
+packages/server/src/utils/htmlUtils.js
+packages/server/src/utils/htmlUtils.js.map
+packages/server/src/utils/koaIf.d.ts
+packages/server/src/utils/koaIf.js
+packages/server/src/utils/koaIf.js.map
+packages/server/src/utils/requestUtils.d.ts
+packages/server/src/utils/requestUtils.js
+packages/server/src/utils/requestUtils.js.map
+packages/server/src/utils/routeUtils.d.ts
+packages/server/src/utils/routeUtils.js
+packages/server/src/utils/routeUtils.js.map
+packages/server/src/utils/routeUtils.test.d.ts
+packages/server/src/utils/routeUtils.test.js
+packages/server/src/utils/routeUtils.test.js.map
+packages/server/src/utils/testUtils.d.ts
+packages/server/src/utils/testUtils.js
+packages/server/src/utils/testUtils.js.map
+packages/server/src/utils/testing/testRouters.d.ts
+packages/server/src/utils/testing/testRouters.js
+packages/server/src/utils/testing/testRouters.js.map
+packages/server/src/utils/time.d.ts
+packages/server/src/utils/time.js
+packages/server/src/utils/time.js.map
+packages/server/src/utils/types.d.ts
+packages/server/src/utils/types.js
+packages/server/src/utils/types.js.map
+packages/server/src/utils/urlUtils.d.ts
+packages/server/src/utils/urlUtils.js
+packages/server/src/utils/urlUtils.js.map
+packages/server/src/utils/uuidgen.d.ts
+packages/server/src/utils/uuidgen.js
+packages/server/src/utils/uuidgen.js.map
 # AUTO-GENERATED - EXCLUDED TYPESCRIPT BUILD

.eslintrc.js

@@ -1,4 +1,5 @@
 module.exports = {
+	'root': true,
 	'env': {
 		'browser': true,
 		'es6': true,
@@ -34,6 +35,9 @@ module.exports = {
 		'chrome': 'readonly',
 		'browser': 'readonly',
 
+		// Server admin UI global variables
+		'onDocumentReady': 'readonly',
+
 		'tinymce': 'readonly',
 	},
 	'parserOptions': {
@@ -61,7 +65,12 @@ module.exports = {
 		'no-var': ['error'],
 		'no-new-func': ['error'],
 		'import/prefer-default-export': ['error'],
-		'import/first': ['error'],
+
+		// This rule should not be enabled since it matters in what order
+		// imports are done, in particular in relation to the shim.setReact
+		// call, which should be done first, but this rule might move it down.
+		// 'import/first': ['error'],
+
 		'no-array-constructor': ['error'],
 		'radix': ['error'],
 

.gitignore

@@ -48,6 +48,7 @@ TODO.md
 packages/tools/commit_hook.txt
 packages/tools/github_oauth_token.txt
 lerna-debug.log
+.env
 
 # AUTO-GENERATED - EXCLUDED TYPESCRIPT BUILD
 packages/app-cli/app/LinkSelector.d.ts
@@ -143,6 +144,9 @@ packages/app-cli/tests/support/plugins/content_script/api/types.js.map
 packages/app-cli/tests/support/plugins/content_script/src/index.d.ts
 packages/app-cli/tests/support/plugins/content_script/src/index.js
 packages/app-cli/tests/support/plugins/content_script/src/index.js.map
+packages/app-cli/tests/support/plugins/content_script/src/markdownItTestPlugin.d.ts
+packages/app-cli/tests/support/plugins/content_script/src/markdownItTestPlugin.js
+packages/app-cli/tests/support/plugins/content_script/src/markdownItTestPlugin.js.map
 packages/app-cli/tests/support/plugins/dialog/api/index.d.ts
 packages/app-cli/tests/support/plugins/dialog/api/index.js
 packages/app-cli/tests/support/plugins/dialog/api/index.js.map
@@ -791,6 +795,9 @@ packages/app-mobile/components/screens/Note.js.map
 packages/app-mobile/components/screens/UpgradeSyncTargetScreen.d.ts
 packages/app-mobile/components/screens/UpgradeSyncTargetScreen.js
 packages/app-mobile/components/screens/UpgradeSyncTargetScreen.js.map
+packages/app-mobile/root.d.ts
+packages/app-mobile/root.js
+packages/app-mobile/root.js.map
 packages/app-mobile/services/AlarmServiceDriver.android.d.ts
 packages/app-mobile/services/AlarmServiceDriver.android.js
 packages/app-mobile/services/AlarmServiceDriver.android.js.map
@@ -878,12 +885,18 @@ packages/lib/InMemoryCache.js.map
 packages/lib/JoplinServerApi.d.ts
 packages/lib/JoplinServerApi.js
 packages/lib/JoplinServerApi.js.map
+packages/lib/JoplinServerApi2.d.ts
+packages/lib/JoplinServerApi2.js
+packages/lib/JoplinServerApi2.js.map
 packages/lib/Logger.d.ts
 packages/lib/Logger.js
 packages/lib/Logger.js.map
 packages/lib/PoorManIntervals.d.ts
 packages/lib/PoorManIntervals.js
 packages/lib/PoorManIntervals.js.map
+packages/lib/SyncTargetJoplinServer.d.ts
+packages/lib/SyncTargetJoplinServer.js
+packages/lib/SyncTargetJoplinServer.js.map
 packages/lib/Synchronizer.d.ts
 packages/lib/Synchronizer.js
 packages/lib/Synchronizer.js.map
@@ -905,12 +918,18 @@ packages/lib/errorUtils.js.map
 packages/lib/eventManager.d.ts
 packages/lib/eventManager.js
 packages/lib/eventManager.js.map
+packages/lib/file-api-driver-joplinServer.d.ts
+packages/lib/file-api-driver-joplinServer.js
+packages/lib/file-api-driver-joplinServer.js.map
 packages/lib/fs-driver-base.d.ts
 packages/lib/fs-driver-base.js
 packages/lib/fs-driver-base.js.map
 packages/lib/fs-driver-node.d.ts
 packages/lib/fs-driver-node.js
 packages/lib/fs-driver-node.js.map
+packages/lib/import-enex-md-gen.d.ts
+packages/lib/import-enex-md-gen.js
+packages/lib/import-enex-md-gen.js.map
 packages/lib/locale.d.ts
 packages/lib/locale.js
 packages/lib/locale.js.map
@@ -1361,6 +1380,12 @@ packages/renderer/MdToHtml/rules/mermaid.js.map
 packages/renderer/MdToHtml/rules/sanitize_html.d.ts
 packages/renderer/MdToHtml/rules/sanitize_html.js
 packages/renderer/MdToHtml/rules/sanitize_html.js.map
+packages/renderer/MdToHtml/setupLinkify.d.ts
+packages/renderer/MdToHtml/setupLinkify.js
+packages/renderer/MdToHtml/setupLinkify.js.map
+packages/renderer/MdToHtml/validateLinks.d.ts
+packages/renderer/MdToHtml/validateLinks.js
+packages/renderer/MdToHtml/validateLinks.js.map
 packages/renderer/htmlUtils.d.ts
 packages/renderer/htmlUtils.js
 packages/renderer/htmlUtils.js.map
@@ -1376,4 +1401,238 @@ packages/renderer/pathUtils.js.map
 packages/renderer/utils.d.ts
 packages/renderer/utils.js
 packages/renderer/utils.js.map
+packages/server/src/app.d.ts
+packages/server/src/app.js
+packages/server/src/app.js.map
+packages/server/src/config-base.d.ts
+packages/server/src/config-base.js
+packages/server/src/config-base.js.map
+packages/server/src/config-buildTypes.d.ts
+packages/server/src/config-buildTypes.js
+packages/server/src/config-buildTypes.js.map
+packages/server/src/config-dev.d.ts
+packages/server/src/config-dev.js
+packages/server/src/config-dev.js.map
+packages/server/src/config-prod.d.ts
+packages/server/src/config-prod.js
+packages/server/src/config-prod.js.map
+packages/server/src/config-tests.d.ts
+packages/server/src/config-tests.js
+packages/server/src/config-tests.js.map
+packages/server/src/config.d.ts
+packages/server/src/config.js
+packages/server/src/config.js.map
+packages/server/src/controllers/BaseController.d.ts
+packages/server/src/controllers/BaseController.js
+packages/server/src/controllers/BaseController.js.map
+packages/server/src/controllers/api/FileController.d.ts
+packages/server/src/controllers/api/FileController.js
+packages/server/src/controllers/api/FileController.js.map
+packages/server/src/controllers/api/FileController.test.d.ts
+packages/server/src/controllers/api/FileController.test.js
+packages/server/src/controllers/api/FileController.test.js.map
+packages/server/src/controllers/api/OAuthController.d.ts
+packages/server/src/controllers/api/OAuthController.js
+packages/server/src/controllers/api/OAuthController.js.map
+packages/server/src/controllers/api/SessionController.d.ts
+packages/server/src/controllers/api/SessionController.js
+packages/server/src/controllers/api/SessionController.js.map
+packages/server/src/controllers/api/SessionController.test.d.ts
+packages/server/src/controllers/api/SessionController.test.js
+packages/server/src/controllers/api/SessionController.test.js.map
+packages/server/src/controllers/api/UserController.d.ts
+packages/server/src/controllers/api/UserController.js
+packages/server/src/controllers/api/UserController.js.map
+packages/server/src/controllers/api/UserController.test.d.ts
+packages/server/src/controllers/api/UserController.test.js
+packages/server/src/controllers/api/UserController.test.js.map
+packages/server/src/controllers/factory.d.ts
+packages/server/src/controllers/factory.js
+packages/server/src/controllers/factory.js.map
+packages/server/src/controllers/index/FileController.d.ts
+packages/server/src/controllers/index/FileController.js
+packages/server/src/controllers/index/FileController.js.map
+packages/server/src/controllers/index/HomeController.d.ts
+packages/server/src/controllers/index/HomeController.js
+packages/server/src/controllers/index/HomeController.js.map
+packages/server/src/controllers/index/LoginController.d.ts
+packages/server/src/controllers/index/LoginController.js
+packages/server/src/controllers/index/LoginController.js.map
+packages/server/src/controllers/index/NotificationController.d.ts
+packages/server/src/controllers/index/NotificationController.js
+packages/server/src/controllers/index/NotificationController.js.map
+packages/server/src/controllers/index/ProfileController.d.ts
+packages/server/src/controllers/index/ProfileController.js
+packages/server/src/controllers/index/ProfileController.js.map
+packages/server/src/controllers/index/UserController.d.ts
+packages/server/src/controllers/index/UserController.js
+packages/server/src/controllers/index/UserController.js.map
+packages/server/src/db.d.ts
+packages/server/src/db.js
+packages/server/src/db.js.map
+packages/server/src/middleware/notificationHandler.d.ts
+packages/server/src/middleware/notificationHandler.js
+packages/server/src/middleware/notificationHandler.js.map
+packages/server/src/middleware/ownerHandler.d.ts
+packages/server/src/middleware/ownerHandler.js
+packages/server/src/middleware/ownerHandler.js.map
+packages/server/src/middleware/routeHandler.d.ts
+packages/server/src/middleware/routeHandler.js
+packages/server/src/middleware/routeHandler.js.map
+packages/server/src/migrations/20190913171451_create.d.ts
+packages/server/src/migrations/20190913171451_create.js
+packages/server/src/migrations/20190913171451_create.js.map
+packages/server/src/migrations/20203012152842_notifications.d.ts
+packages/server/src/migrations/20203012152842_notifications.js
+packages/server/src/migrations/20203012152842_notifications.js.map
+packages/server/src/models/ApiClientModel.d.ts
+packages/server/src/models/ApiClientModel.js
+packages/server/src/models/ApiClientModel.js.map
+packages/server/src/models/BaseModel.d.ts
+packages/server/src/models/BaseModel.js
+packages/server/src/models/BaseModel.js.map
+packages/server/src/models/ChangeModel.d.ts
+packages/server/src/models/ChangeModel.js
+packages/server/src/models/ChangeModel.js.map
+packages/server/src/models/ChangeModel.test.d.ts
+packages/server/src/models/ChangeModel.test.js
+packages/server/src/models/ChangeModel.test.js.map
+packages/server/src/models/FileModel.d.ts
+packages/server/src/models/FileModel.js
+packages/server/src/models/FileModel.js.map
+packages/server/src/models/FileModel.test.d.ts
+packages/server/src/models/FileModel.test.js
+packages/server/src/models/FileModel.test.js.map
+packages/server/src/models/NotificationModel.d.ts
+packages/server/src/models/NotificationModel.js
+packages/server/src/models/NotificationModel.js.map
+packages/server/src/models/NotificationModel.test.d.ts
+packages/server/src/models/NotificationModel.test.js
+packages/server/src/models/NotificationModel.test.js.map
+packages/server/src/models/PermissionModel.d.ts
+packages/server/src/models/PermissionModel.js
+packages/server/src/models/PermissionModel.js.map
+packages/server/src/models/SessionModel.d.ts
+packages/server/src/models/SessionModel.js
+packages/server/src/models/SessionModel.js.map
+packages/server/src/models/UserModel.d.ts
+packages/server/src/models/UserModel.js
+packages/server/src/models/UserModel.js.map
+packages/server/src/models/factory.d.ts
+packages/server/src/models/factory.js
+packages/server/src/models/factory.js.map
+packages/server/src/models/utils/pagination.d.ts
+packages/server/src/models/utils/pagination.js
+packages/server/src/models/utils/pagination.js.map
+packages/server/src/models/utils/pagination.test.d.ts
+packages/server/src/models/utils/pagination.test.js
+packages/server/src/models/utils/pagination.test.js.map
+packages/server/src/routes/api/files.d.ts
+packages/server/src/routes/api/files.js
+packages/server/src/routes/api/files.js.map
+packages/server/src/routes/api/index.d.ts
+packages/server/src/routes/api/index.js
+packages/server/src/routes/api/index.js.map
+packages/server/src/routes/api/ping.d.ts
+packages/server/src/routes/api/ping.js
+packages/server/src/routes/api/ping.js.map
+packages/server/src/routes/api/sessions.d.ts
+packages/server/src/routes/api/sessions.js
+packages/server/src/routes/api/sessions.js.map
+packages/server/src/routes/default.d.ts
+packages/server/src/routes/default.js
+packages/server/src/routes/default.js.map
+packages/server/src/routes/index/files.d.ts
+packages/server/src/routes/index/files.js
+packages/server/src/routes/index/files.js.map
+packages/server/src/routes/index/home.d.ts
+packages/server/src/routes/index/home.js
+packages/server/src/routes/index/home.js.map
+packages/server/src/routes/index/login.d.ts
+packages/server/src/routes/index/login.js
+packages/server/src/routes/index/login.js.map
+packages/server/src/routes/index/logout.d.ts
+packages/server/src/routes/index/logout.js
+packages/server/src/routes/index/logout.js.map
+packages/server/src/routes/index/notifications.d.ts
+packages/server/src/routes/index/notifications.js
+packages/server/src/routes/index/notifications.js.map
+packages/server/src/routes/index/profile.d.ts
+packages/server/src/routes/index/profile.js
+packages/server/src/routes/index/profile.js.map
+packages/server/src/routes/index/user.d.ts
+packages/server/src/routes/index/user.js
+packages/server/src/routes/index/user.js.map
+packages/server/src/routes/index/users.d.ts
+packages/server/src/routes/index/users.js
+packages/server/src/routes/index/users.js.map
+packages/server/src/routes/oauth2/authorize.d.ts
+packages/server/src/routes/oauth2/authorize.js
+packages/server/src/routes/oauth2/authorize.js.map
+packages/server/src/routes/routes.d.ts
+packages/server/src/routes/routes.js
+packages/server/src/routes/routes.js.map
+packages/server/src/services/MustacheService.d.ts
+packages/server/src/services/MustacheService.js
+packages/server/src/services/MustacheService.js.map
+packages/server/src/tools/db-migrate.d.ts
+packages/server/src/tools/db-migrate.js
+packages/server/src/tools/db-migrate.js.map
+packages/server/src/tools/dbTools.d.ts
+packages/server/src/tools/dbTools.js
+packages/server/src/tools/dbTools.js.map
+packages/server/src/tools/generate-types.d.ts
+packages/server/src/tools/generate-types.js
+packages/server/src/tools/generate-types.js.map
+packages/server/src/utils/TransactionHandler.d.ts
+packages/server/src/utils/TransactionHandler.js
+packages/server/src/utils/TransactionHandler.js.map
+packages/server/src/utils/auth.d.ts
+packages/server/src/utils/auth.js
+packages/server/src/utils/auth.js.map
+packages/server/src/utils/base64.d.ts
+packages/server/src/utils/base64.js
+packages/server/src/utils/base64.js.map
+packages/server/src/utils/cache.d.ts
+packages/server/src/utils/cache.js
+packages/server/src/utils/cache.js.map
+packages/server/src/utils/defaultView.d.ts
+packages/server/src/utils/defaultView.js
+packages/server/src/utils/defaultView.js.map
+packages/server/src/utils/errors.d.ts
+packages/server/src/utils/errors.js
+packages/server/src/utils/errors.js.map
+packages/server/src/utils/htmlUtils.d.ts
+packages/server/src/utils/htmlUtils.js
+packages/server/src/utils/htmlUtils.js.map
+packages/server/src/utils/koaIf.d.ts
+packages/server/src/utils/koaIf.js
+packages/server/src/utils/koaIf.js.map
+packages/server/src/utils/requestUtils.d.ts
+packages/server/src/utils/requestUtils.js
+packages/server/src/utils/requestUtils.js.map
+packages/server/src/utils/routeUtils.d.ts
+packages/server/src/utils/routeUtils.js
+packages/server/src/utils/routeUtils.js.map
+packages/server/src/utils/routeUtils.test.d.ts
+packages/server/src/utils/routeUtils.test.js
+packages/server/src/utils/routeUtils.test.js.map
+packages/server/src/utils/testUtils.d.ts
+packages/server/src/utils/testUtils.js
+packages/server/src/utils/testUtils.js.map
+packages/server/src/utils/testing/testRouters.d.ts
+packages/server/src/utils/testing/testRouters.js
+packages/server/src/utils/testing/testRouters.js.map
+packages/server/src/utils/time.d.ts
+packages/server/src/utils/time.js
+packages/server/src/utils/time.js.map
+packages/server/src/utils/types.d.ts
+packages/server/src/utils/types.js
+packages/server/src/utils/types.js.map
+packages/server/src/utils/urlUtils.d.ts
+packages/server/src/utils/urlUtils.js
+packages/server/src/utils/urlUtils.js.map
+packages/server/src/utils/uuidgen.d.ts
+packages/server/src/utils/uuidgen.js
+packages/server/src/utils/uuidgen.js.map
 # AUTO-GENERATED - EXCLUDED TYPESCRIPT BUILD

Dockerfile.db

@@ -0,0 +1,3 @@
+FROM postgres:13.1
+
+EXPOSE 5432

Dockerfile.server

@@ -0,0 +1,71 @@
+# https://versatile.nl/blog/deploying-lerna-web-apps-with-docker
+
+FROM node:12
+
+RUN apt-get update
+RUN apt-get --yes install vim
+
+ARG user=joplin
+
+RUN useradd --create-home --shell /bin/bash $user
+USER $user
+
+ENV NODE_ENV development
+
+WORKDIR /home/$user
+
+RUN mkdir /home/$user/logs
+
+# To take advantage of the Docker cache, we first copy all the package.json
+# and package-lock.json files, as they rarely change? and then bootstrap
+# all the packages.
+#
+# Note that bootstrapping the packages will run all the postinstall
+# scripts, which means that for packages that have such scripts, we need to
+# copy all the files.
+#
+# We can't run boostrap with "--ignore-scripts" because that would
+# prevent certain sub-packages, such as sqlite3, from being built
+
+COPY --chown=$user:$user package*.json ./
+
+# Install the root scripts but don't run postinstall (which would bootstrap
+# and build TypeScript files, but we don't have the TypeScript files at
+# this point)
+
+RUN npm install --ignore-scripts
+
+COPY --chown=$user:$user packages/fork-sax/package*.json ./packages/fork-sax/
+COPY --chown=$user:$user packages/lib/package*.json ./packages/lib/
+COPY --chown=$user:$user packages/renderer/package*.json ./packages/renderer/
+COPY --chown=$user:$user packages/tools/package*.json ./packages/tools/
+COPY --chown=$user:$user packages/server/package*.json ./packages/server/
+COPY --chown=$user:$user lerna.json .
+COPY --chown=$user:$user tsconfig.json .
+
+# The following have postinstall scripts so we need to copy all the files.
+# Since they should rarely change this is not an issue
+
+COPY --chown=$user:$user packages/turndown ./packages/turndown
+COPY --chown=$user:$user packages/turndown-plugin-gfm ./packages/turndown-plugin-gfm
+COPY --chown=$user:$user packages/fork-htmlparser2 ./packages/fork-htmlparser2
+
+RUN ls -la /home/$user
+
+# Then bootstrap only, without compiling the TypeScript files
+
+RUN npm run bootstrap
+
+COPY --chown=$user:$user packages/fork-sax ./packages/fork-sax
+COPY --chown=$user:$user packages/lib ./packages/lib
+COPY --chown=$user:$user packages/renderer ./packages/renderer
+COPY --chown=$user:$user packages/tools ./packages/tools
+COPY --chown=$user:$user packages/server ./packages/server
+
+# Finally build everything, in particular the TypeScript files.
+
+RUN npm run build
+
+EXPOSE ${JOPLIN_PORT}
+
+CMD [ "npm", "--prefix", "packages/server", "start" ]

README.md

@@ -20,9 +20,9 @@ Three types of applications are available: for the **desktop** (Windows, macOS a
 
 Operating System | Download | Alternative
 ---|---|---
-Windows (32 and 64-bit) | <a href='https://github.com/laurent22/joplin/releases/download/v1.4.19/Joplin-Setup-1.4.19.exe'><img alt='Get it on Windows' width="134px" src='https://joplinapp.org/images/BadgeWindows.png'/></a> | Or get the <a href='https://github.com/laurent22/joplin/releases/download/v1.4.19/JoplinPortable.exe'>Portable version</a><br><br>The [portable application](https://en.wikipedia.org/wiki/Portable_application) allows installing the software on a portable device such as a USB key. Simply copy the file JoplinPortable.exe in any directory on that USB key ; the application will then create a directory called "JoplinProfile" next to the executable file.
-macOS | <a href='https://github.com/laurent22/joplin/releases/download/v1.4.19/Joplin-1.4.19.dmg'><img alt='Get it on macOS' width="134px" src='https://joplinapp.org/images/BadgeMacOS.png'/></a> | -
-Linux | <a href='https://github.com/laurent22/joplin/releases/download/v1.4.19/Joplin-1.4.19.AppImage'><img alt='Get it on Linux' width="134px" src='https://joplinapp.org/images/BadgeLinux.png'/></a> | The recommended way is to use the following installation script as it will handle the desktop icon too:<br><br> `wget -O - https://raw.githubusercontent.com/laurent22/joplin/dev/Joplin_install_and_update.sh \| bash`
+Windows (32 and 64-bit) | <a href='https://github.com/laurent22/joplin/releases/download/v1.5.11/Joplin-Setup-1.5.11.exe'><img alt='Get it on Windows' width="134px" src='https://joplinapp.org/images/BadgeWindows.png'/></a> | Or get the <a href='https://github.com/laurent22/joplin/releases/download/v1.5.11/JoplinPortable.exe'>Portable version</a><br><br>The [portable application](https://en.wikipedia.org/wiki/Portable_application) allows installing the software on a portable device such as a USB key. Simply copy the file JoplinPortable.exe in any directory on that USB key ; the application will then create a directory called "JoplinProfile" next to the executable file.
+macOS | <a href='https://github.com/laurent22/joplin/releases/download/v1.5.11/Joplin-1.5.11.dmg'><img alt='Get it on macOS' width="134px" src='https://joplinapp.org/images/BadgeMacOS.png'/></a> | -
+Linux | <a href='https://github.com/laurent22/joplin/releases/download/v1.5.11/Joplin-1.5.11.AppImage'><img alt='Get it on Linux' width="134px" src='https://joplinapp.org/images/BadgeLinux.png'/></a> | The recommended way is to use the following installation script as it will handle the desktop icon too:<br><br> `wget -O - https://raw.githubusercontent.com/laurent22/joplin/dev/Joplin_install_and_update.sh \| bash`
 
 ## Mobile applications
 
@@ -109,6 +109,8 @@ The Web Clipper is a browser extension that allows you to save web pages and scr
 	- [Sync Lock spec](https://github.com/laurent22/joplin/blob/dev/readme/spec/sync_lock.md)
 	- [Plugin Architecture spec](https://github.com/laurent22/joplin/blob/dev/readme/spec/plugins.md)
 	- [Search Sorting spec](https://github.com/laurent22/joplin/blob/dev/readme/spec/search_sorting.md)
+	- [Server: File URL Format](https://github.com/laurent22/joplin/blob/dev/readme/spec/server_file_url_format.md)
+	- [Server: Delta Sync](https://github.com/laurent22/joplin/blob/dev/readme/spec/server_delta_sync.md)
 
 - Google Summer of Code 2020
 
@@ -436,45 +438,45 @@ Current translations:
 <!-- LOCALE-TABLE-AUTO-GENERATED -->
 &nbsp;  |  Language  |  Po File  |  Last translator  |  Percent done
 ---|---|---|---|---
-![](https://joplinapp.org/images/flags/country-4x3/arableague.png)  |  Arabic  |  [ar](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/ar.po)  |  [أحمد باشا إبراهيم](mailto:fi_ahmed_bacha@esi.dz)  |  77%
-![](https://joplinapp.org/images/flags/es/basque_country.png)  |  Basque  |  [eu](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/eu.po)  |  juan.abasolo@ehu.eus  |  33%
-![](https://joplinapp.org/images/flags/country-4x3/ba.png)  |  Bosnian (Bosna i Hercegovina)  |  [bs_BA](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/bs_BA.po)  |  [Derviš T.](mailto:dervis.t@pm.me)  |  79%
-![](https://joplinapp.org/images/flags/country-4x3/bg.png)  |  Bulgarian (България)  |  [bg_BG](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/bg_BG.po)  |    |  64%
-![](https://joplinapp.org/images/flags/es/catalonia.png)  |  Catalan  |  [ca](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/ca.po)  |  jmontane, 2019  |  92%
+![](https://joplinapp.org/images/flags/country-4x3/arableague.png)  |  Arabic  |  [ar](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/ar.po)  |  [أحمد باشا إبراهيم](mailto:fi_ahmed_bacha@esi.dz)  |  75%
+![](https://joplinapp.org/images/flags/es/basque_country.png)  |  Basque  |  [eu](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/eu.po)  |  juan.abasolo@ehu.eus  |  32%
+![](https://joplinapp.org/images/flags/country-4x3/ba.png)  |  Bosnian (Bosna i Hercegovina)  |  [bs_BA](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/bs_BA.po)  |  [Derviš T.](mailto:dervis.t@pm.me)  |  77%
+![](https://joplinapp.org/images/flags/country-4x3/bg.png)  |  Bulgarian (България)  |  [bg_BG](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/bg_BG.po)  |    |  62%
+![](https://joplinapp.org/images/flags/es/catalonia.png)  |  Catalan  |  [ca](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/ca.po)  |  jmontane, 2019  |  89%
 ![](https://joplinapp.org/images/flags/country-4x3/hr.png)  |  Croatian (Hrvatska)  |  [hr_HR](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/hr_HR.po)  |  [Hrvoje Mandić](mailto:trbuhom@net.hr)  |  26%
-![](https://joplinapp.org/images/flags/country-4x3/cz.png)  |  Czech (Česká republika)  |  [cs_CZ](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/cs_CZ.po)  |  [Lukas Helebrandt](mailto:lukas@aiya.cz)  |  96%
-![](https://joplinapp.org/images/flags/country-4x3/dk.png)  |  Dansk (Danmark)  |  [da_DK](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/da_DK.po)  |  Mustafa Al-Dailemi (dailemi@hotmail.com)Language-Team:  |  79%
-![](https://joplinapp.org/images/flags/country-4x3/de.png)  |  Deutsch (Deutschland)  |  [de_DE](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/de_DE.po)  |  [Ettore Atalan](mailto:atalanttore@users.noreply.github.com)  |  96%
-![](https://joplinapp.org/images/flags/country-4x3/ee.png)  |  Eesti Keel (Eesti)  |  [et_EE](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/et_EE.po)  |    |  63%
+![](https://joplinapp.org/images/flags/country-4x3/cz.png)  |  Czech (Česká republika)  |  [cs_CZ](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/cs_CZ.po)  |  [Lukas Helebrandt](mailto:lukas@aiya.cz)  |  93%
+![](https://joplinapp.org/images/flags/country-4x3/dk.png)  |  Dansk (Danmark)  |  [da_DK](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/da_DK.po)  |  Mustafa Al-Dailemi (dailemi@hotmail.com)Language-Team:  |  77%
+![](https://joplinapp.org/images/flags/country-4x3/de.png)  |  Deutsch (Deutschland)  |  [de_DE](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/de_DE.po)  |  [Ettore Atalan](mailto:atalanttore@users.noreply.github.com)  |  95%
+![](https://joplinapp.org/images/flags/country-4x3/ee.png)  |  Eesti Keel (Eesti)  |  [et_EE](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/et_EE.po)  |    |  61%
 ![](https://joplinapp.org/images/flags/country-4x3/gb.png)  |  English (United Kingdom)  |  [en_GB](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/en_GB.po)  |    |  100%
 ![](https://joplinapp.org/images/flags/country-4x3/us.png)  |  English (United States of America)  |  [en_US](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/en_US.po)  |    |  100%
-![](https://joplinapp.org/images/flags/country-4x3/es.png)  |  Español (España)  |  [es_ES](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/es_ES.po)  |  [Mario Campo](mailto:mario.campo@gmail.com)  |  96%
-![](https://joplinapp.org/images/flags/esperanto.png)  |  Esperanto  |  [eo](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/eo.po)  |  Marton Paulo  |  36%
-![](https://joplinapp.org/images/flags/country-4x3/fi.png)  |  Finnish (Suomi)  |  [fi_FI](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/fi_FI.po)  |    |  97%
-![](https://joplinapp.org/images/flags/country-4x3/fr.png)  |  Français (France)  |  [fr_FR](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/fr_FR.po)  |  Laurent Cozic  |  96%
-![](https://joplinapp.org/images/flags/es/galicia.png)  |  Galician (España)  |  [gl_ES](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/gl_ES.po)  |  [Marcos Lans](mailto:marcoslansgarza@gmail.com)  |  42%
-![](https://joplinapp.org/images/flags/country-4x3/id.png)  |  Indonesian (Indonesia)  |  [id_ID](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/id_ID.po)  |  [Fathy AR](mailto:16875937+fathyar@users.noreply.github.com)  |  88%
-![](https://joplinapp.org/images/flags/country-4x3/it.png)  |  Italiano (Italia)  |  [it_IT](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/it_IT.po)  |  [Alessandro Bernardello](mailto:mailfilledwithspam@gmail.com)  |  97%
-![](https://joplinapp.org/images/flags/country-4x3/be.png)  |  Nederlands (België, Belgique, Belgien)  |  [nl_BE](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/nl_BE.po)  |    |  33%
-![](https://joplinapp.org/images/flags/country-4x3/nl.png)  |  Nederlands (Nederland)  |  [nl_NL](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/nl_NL.po)  |  [MetBril](mailto:metbril@users.noreply.github.com)  |  96%
-![](https://joplinapp.org/images/flags/country-4x3/no.png)  |  Norwegian (Norge, Noreg)  |  [nb_NO](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/nb_NO.po)  |  [Mats Estensen](mailto:code@mxe.no)  |  85%
-![](https://joplinapp.org/images/flags/country-4x3/ir.png)  |  Persian  |  [fa](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/fa.po)  |  [Kourosh Firoozbakht](mailto:kourox@protonmail.com)  |  79%
-![](https://joplinapp.org/images/flags/country-4x3/pl.png)  |  Polski (Polska)  |  [pl_PL](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/pl_PL.po)  |    |  95%
-![](https://joplinapp.org/images/flags/country-4x3/br.png)  |  Português (Brasil)  |  [pt_BR](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/pt_BR.po)  |  [Renato Nunes Bastos](mailto:rnbastos@gmail.com)  |  93%
-![](https://joplinapp.org/images/flags/country-4x3/pt.png)  |  Português (Portugal)  |  [pt_PT](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/pt_PT.po)  |  [João Duarte](mailto:jduar@protonmail.com)  |  95%
-![](https://joplinapp.org/images/flags/country-4x3/ro.png)  |  Română  |  [ro](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/ro.po)  |  [Cristi Duluta](mailto:cristi.duluta@gmail.com)  |  74%
-![](https://joplinapp.org/images/flags/country-4x3/si.png)  |  Slovenian (Slovenija)  |  [sl_SI](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/sl_SI.po)  |    |  41%
-![](https://joplinapp.org/images/flags/country-4x3/se.png)  |  Svenska  |  [sv](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/sv.po)  |  [Jonatan Nyberg](mailto:jonatan@autistici.org)  |  68%
-![](https://joplinapp.org/images/flags/country-4x3/th.png)  |  Thai (ประเทศไทย)  |  [th_TH](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/th_TH.po)  |    |  50%
-![](https://joplinapp.org/images/flags/country-4x3/vi.png)  |  Tiếng Việt  |  [vi](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/vi.po)  |    |  82%
-![](https://joplinapp.org/images/flags/country-4x3/tr.png)  |  Türkçe (Türkiye)  |  [tr_TR](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/tr_TR.po)  |  [Arda Kılıçdağı](mailto:arda@kilicdagi.com)  |  94%
-![](https://joplinapp.org/images/flags/country-4x3/gr.png)  |  Ελληνικά (Ελλάδα)  |  [el_GR](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/el_GR.po)  |  [Harris Arvanitis](mailto:xaris@tuta.io)  |  92%
-![](https://joplinapp.org/images/flags/country-4x3/ru.png)  |  Русский (Россия)  |  [ru_RU](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/ru_RU.po)  |  [Sergey Segeda](mailto:thesermanarm@gmail.com)  |  92%
-![](https://joplinapp.org/images/flags/country-4x3/rs.png)  |  српски језик (Србија)  |  [sr_RS](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/sr_RS.po)  |    |  69%
-![](https://joplinapp.org/images/flags/country-4x3/cn.png)  |  中文 (简体)  |  [zh_CN](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/zh_CN.po)  |  [WhiredPlanck](mailto:fungdaat31@outlook.com)  |  97%
-![](https://joplinapp.org/images/flags/country-4x3/tw.png)  |  中文 (繁體)  |  [zh_TW](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/zh_TW.po)  |  [Yaoze Ye](mailto:yaozeye@yahoo.co.jp)  |  91%
-![](https://joplinapp.org/images/flags/country-4x3/jp.png)  |  日本語 (日本)  |  [ja_JP](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/ja_JP.po)  |  [genneko](mailto:genneko217@gmail.com)  |  97%
-![](https://joplinapp.org/images/flags/country-4x3/kr.png)  |  한국어  |  [ko](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/ko.po)  |  [Ji-Hyeon Gim](mailto:potatogim@potatogim.net)  |  97%
+![](https://joplinapp.org/images/flags/country-4x3/es.png)  |  Español (España)  |  [es_ES](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/es_ES.po)  |  [Mario Campo](mailto:mario.campo@gmail.com)  |  99%
+![](https://joplinapp.org/images/flags/esperanto.png)  |  Esperanto  |  [eo](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/eo.po)  |  Marton Paulo  |  35%
+![](https://joplinapp.org/images/flags/country-4x3/fi.png)  |  Finnish (Suomi)  |  [fi_FI](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/fi_FI.po)  |    |  94%
+![](https://joplinapp.org/images/flags/country-4x3/fr.png)  |  Français (France)  |  [fr_FR](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/fr_FR.po)  |  Laurent Cozic  |  99%
+![](https://joplinapp.org/images/flags/es/galicia.png)  |  Galician (España)  |  [gl_ES](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/gl_ES.po)  |  [Marcos Lans](mailto:marcoslansgarza@gmail.com)  |  40%
+![](https://joplinapp.org/images/flags/country-4x3/id.png)  |  Indonesian (Indonesia)  |  [id_ID](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/id_ID.po)  |  [Fathy AR](mailto:16875937+fathyar@users.noreply.github.com)  |  85%
+![](https://joplinapp.org/images/flags/country-4x3/it.png)  |  Italiano (Italia)  |  [it_IT](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/it_IT.po)  |  [Alessandro Bernardello](mailto:mailfilledwithspam@gmail.com)  |  96%
+![](https://joplinapp.org/images/flags/country-4x3/be.png)  |  Nederlands (België, Belgique, Belgien)  |  [nl_BE](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/nl_BE.po)  |    |  32%
+![](https://joplinapp.org/images/flags/country-4x3/nl.png)  |  Nederlands (Nederland)  |  [nl_NL](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/nl_NL.po)  |  [MetBril](mailto:metbril@users.noreply.github.com)  |  93%
+![](https://joplinapp.org/images/flags/country-4x3/no.png)  |  Norwegian (Norge, Noreg)  |  [nb_NO](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/nb_NO.po)  |  [Mats Estensen](mailto:code@mxe.no)  |  82%
+![](https://joplinapp.org/images/flags/country-4x3/ir.png)  |  Persian  |  [fa](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/fa.po)  |  [Kourosh Firoozbakht](mailto:kourox@protonmail.com)  |  77%
+![](https://joplinapp.org/images/flags/country-4x3/pl.png)  |  Polski (Polska)  |  [pl_PL](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/pl_PL.po)  |    |  92%
+![](https://joplinapp.org/images/flags/country-4x3/br.png)  |  Português (Brasil)  |  [pt_BR](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/pt_BR.po)  |  [Renato Nunes Bastos](mailto:rnbastos@gmail.com)  |  91%
+![](https://joplinapp.org/images/flags/country-4x3/pt.png)  |  Português (Portugal)  |  [pt_PT](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/pt_PT.po)  |  [João Duarte](mailto:jduar@protonmail.com)  |  92%
+![](https://joplinapp.org/images/flags/country-4x3/ro.png)  |  Română  |  [ro](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/ro.po)  |  [Cristi Duluta](mailto:cristi.duluta@gmail.com)  |  72%
+![](https://joplinapp.org/images/flags/country-4x3/si.png)  |  Slovenian (Slovenija)  |  [sl_SI](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/sl_SI.po)  |    |  40%
+![](https://joplinapp.org/images/flags/country-4x3/se.png)  |  Svenska  |  [sv](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/sv.po)  |  [Jonatan Nyberg](mailto:jonatan@autistici.org)  |  66%
+![](https://joplinapp.org/images/flags/country-4x3/th.png)  |  Thai (ประเทศไทย)  |  [th_TH](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/th_TH.po)  |    |  49%
+![](https://joplinapp.org/images/flags/country-4x3/vi.png)  |  Tiếng Việt  |  [vi](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/vi.po)  |    |  79%
+![](https://joplinapp.org/images/flags/country-4x3/tr.png)  |  Türkçe (Türkiye)  |  [tr_TR](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/tr_TR.po)  |  [Arda Kılıçdağı](mailto:arda@kilicdagi.com)  |  99%
+![](https://joplinapp.org/images/flags/country-4x3/gr.png)  |  Ελληνικά (Ελλάδα)  |  [el_GR](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/el_GR.po)  |  [Harris Arvanitis](mailto:xaris@tuta.io)  |  89%
+![](https://joplinapp.org/images/flags/country-4x3/ru.png)  |  Русский (Россия)  |  [ru_RU](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/ru_RU.po)  |  [Sergey Segeda](mailto:thesermanarm@gmail.com)  |  96%
+![](https://joplinapp.org/images/flags/country-4x3/rs.png)  |  српски језик (Србија)  |  [sr_RS](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/sr_RS.po)  |    |  67%
+![](https://joplinapp.org/images/flags/country-4x3/cn.png)  |  中文 (简体)  |  [zh_CN](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/zh_CN.po)  |  [WhiredPlanck](mailto:fungdaat31@outlook.com)  |  99%
+![](https://joplinapp.org/images/flags/country-4x3/tw.png)  |  中文 (繁體)  |  [zh_TW](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/zh_TW.po)  |  [Yaoze Ye](mailto:yaozeye@yahoo.co.jp)  |  95%
+![](https://joplinapp.org/images/flags/country-4x3/jp.png)  |  日本語 (日本)  |  [ja_JP](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/ja_JP.po)  |  [genneko](mailto:genneko217@gmail.com)  |  96%
+![](https://joplinapp.org/images/flags/country-4x3/kr.png)  |  한국어  |  [ko](https://github.com/laurent22/joplin/blob/dev/packages/tools/locales/ko.po)  |  [Ji-Hyeon Gim](mailto:potatogim@potatogim.net)  |  96%
 <!-- LOCALE-TABLE-AUTO-GENERATED -->
 
 # Contributors

docker-compose.server-dev.yml

@@ -0,0 +1,28 @@
+# For development, the easiest might be to only start the Postgres container and
+# run the app directly with `npm start`. Or use sqlite3.
+
+version: '3'
+
+services:
+    # app:
+    #   build:
+    #     context: .
+    #     dockerfile: Dockerfile.server-dev
+    #   ports:
+    #     - "22300:22300"
+    #   # volumes:
+    #   #   - ./packages/server/:/var/www/joplin/packages/server/
+    #   #   - /var/www/joplin/packages/server/node_modules/
+    db:
+        build:
+            context: .
+            dockerfile: Dockerfile.db
+        ports:
+            - "5432:5432"
+        environment:
+            # TODO: Considering the database is only exposed to the
+            # application, and not to the outside world, is there a need to
+            # pick a secure password?
+            - POSTGRES_PASSWORD=joplin
+            - POSTGRES_USER=joplin
+            - POSTGRES_DB=joplin

docker-compose.server.yml

@@ -0,0 +1,40 @@
+version: '3'
+
+services:
+    app:
+        environment:
+            - JOPLIN_BASE_URL=${JOPLIN_BASE_URL}
+            - JOPLIN_PORT=${JOPLIN_PORT}
+        restart: unless-stopped
+        build:
+            context: .
+            dockerfile: Dockerfile.server
+        ports:
+            - "${JOPLIN_PORT}:${JOPLIN_PORT}"
+        # volumes:
+        #     # Mount the server directory so that it's possible to edit file
+        #     # while the container is running. However don't mount the
+        #     # node_modules directory which will be specific to the Docker
+        #     # image (eg native modules will be built for Ubuntu, while the
+        #     # container might be running in Windows)
+        #     # https://stackoverflow.com/a/37898591/561309
+        #     - ./packages/server:/home/joplin/packages/server
+        #     - /home/joplin/packages/server/node_modules/
+    db:
+        restart: unless-stopped
+        # By default, the Postgres image saves the data to a Docker volume,
+        # so it persists whenever the server is restarted using
+        # `docker-compose up`. Note that it would however be deleted when
+        # running `docker-compose down`.
+        build:
+            context: .
+            dockerfile: Dockerfile.db
+        ports:
+            - "5432:5432"
+        environment:
+            # TODO: Considering the database is only exposed to the
+            # application, and not to the outside world, is there a need to
+            # pick a secure password?
+            - POSTGRES_PASSWORD=joplin
+            - POSTGRES_USER=joplin
+            - POSTGRES_DB=joplin

docs/api/references/plugin_api/classes/joplinplugins.html

@@ -150,13 +150,21 @@
 							</aside>
 							<div class="tsd-comment tsd-typography">
 								<div class="lead">
-									<p>Registers a new content script. Unlike regular plugin code, which runs in a separate process, content scripts run within the main process code
-									and thus allow improved performances and more customisations in specific cases. It can be used for example to load a Markdown or editor plugin.</p>
+									<p>Registers a new content script. Unlike regular plugin code, which
+										runs in a separate process, content scripts run within the main
+										process code and thus allow improved performances and more
+										customisations in specific cases. It can be used for example to load
+									a Markdown or editor plugin.</p>
 								</div>
-								<p>Note that registering a content script in itself will do nothing - it will only be loaded in specific cases by the relevant app modules
-								(eg. the Markdown renderer or the code editor). So it is not a way to inject and run arbitrary code in the app, which for safety and performance reasons is not supported.</p>
-								<p><a href="https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script">View the renderer demo plugin</a>
-								<a href="https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script">View the editor demo plugin</a></p>
+								<p>Note that registering a content script in itself will do nothing -
+									it will only be loaded in specific cases by the relevant app modules
+									(eg. the Markdown renderer or the code editor). So it is not a way
+									to inject and run arbitrary code in the app, which for safety and
+								performance reasons is not supported.</p>
+								<ul>
+									<li><a href="https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script">View the renderer demo plugin</a></li>
+									<li><a href="https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script">View the editor demo plugin</a></li>
+								</ul>
 							</div>
 							<h4 class="tsd-parameters-title">Parameters</h4>
 							<ul class="tsd-parameters">

docs/api/references/plugin_api/classes/joplinsettings.html

@@ -124,7 +124,7 @@
 									<p>Gets a global setting value, including app-specific settings and those set by other plugins.</p>
 								</div>
 								<p>The list of available settings is not documented yet, but can be found by looking at the source code:</p>
-								<p><a href="https://github.com/laurent22/joplin/blob/3539a452a359162c461d2849829d2d42973eab50/packages/app-mobile/lib/models/Setting.ts#L142">https://github.com/laurent22/joplin/blob/3539a452a359162c461d2849829d2d42973eab50/packages/app-mobile/lib/models/Setting.ts#L142</a></p>
+								<p><a href="https://github.com/laurent22/joplin/blob/dev/packages/lib/models/Setting.ts#L142">https://github.com/laurent22/joplin/blob/dev/packages/lib/models/Setting.ts#L142</a></p>
 							</div>
 							<h4 class="tsd-parameters-title">Parameters</h4>
 							<ul class="tsd-parameters">

docs/api/references/plugin_api/enums/contentscripttype.html

@@ -88,7 +88,8 @@
 					</aside>
 					<div class="tsd-comment tsd-typography">
 						<div class="lead">
-							<p>Registers a new CodeMirror plugin, which should follow the template below.</p>
+							<p>Registers a new CodeMirror plugin, which should follow the template
+							below.</p>
 						</div>
 						<pre><code class="language-javascript"><span class="hljs-built_in">module</span>.exports = {
     <span class="hljs-attr">default</span>: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">context</span>) </span>{
@@ -98,8 +99,8 @@
             },
             <span class="hljs-attr">codeMirrorResources</span>: [],
             <span class="hljs-attr">codeMirrorOptions</span>: {
-                                    <span class="hljs-comment">// ...</span>
-                         },
+                                 <span class="hljs-comment">// ...</span>
+                      },
             <span class="hljs-attr">assets</span>: {
                 <span class="hljs-comment">// ...</span>
             },
@@ -107,19 +108,42 @@
     }
 }</code></pre>
 						<ul>
-							<li><p>The <code>context</code> argument is currently unused but could be used later on to provide access to your own plugin so that the content script and plugin can communicate.</p>
+							<li><p>The <code>context</code> argument is currently unused but could be used later
+									on to provide access to your own plugin so that the content script
+								and plugin can communicate.</p>
 							</li>
-							<li><p>The <code>plugin</code> key is your CodeMirror plugin. This is where you can register new commands with CodeMirror or interact with the CodeMirror instance as needed.</p>
+							<li><p>The <code>plugin</code> key is your CodeMirror plugin. This is where you can
+									register new commands with CodeMirror or interact with the
+								CodeMirror instance as needed.</p>
 							</li>
-							<li><p>The <code>codeMirrorResources</code> key is an array of CodeMirror resources that will be loaded and attached to the CodeMirror module. These are made up of addons, keymaps, and modes. For example, for a plugin that want&#39;s to enable clojure highlighting in code blocks. <code>codeMirrorResources</code> would be set to <code>[&#39;mode/clojure/clojure&#39;]</code>.</p>
+							<li><p>The <code>codeMirrorResources</code> key is an array of CodeMirror resources
+									that will be loaded and attached to the CodeMirror module. These
+									are made up of addons, keymaps, and modes. For example, for a
+									plugin that want&#39;s to enable clojure highlighting in code blocks.
+								<code>codeMirrorResources</code> would be set to <code>[&#39;mode/clojure/clojure&#39;]</code>.</p>
 							</li>
-							<li><p>The <code>codeMirrorOptions</code> key contains all the <a href="https://codemirror.net/doc/manual.html#config">CodeMirror</a> options that will be set or changed by this plugin. New options can alse be declared via <a href="https://codemirror.net/doc/manual.html#defineOption"><code>CodeMirror.defineOption</code></a>, and then have their value set here. For example, a plugin that enables line numbers would set <code>codeMirrorOptions</code> to <code>{&#39;lineNumbers&#39;: true}</code>.</p>
+							<li><p>The <code>codeMirrorOptions</code> key contains all the
+									<a href="https://codemirror.net/doc/manual.html#config">CodeMirror</a>
+									options that will be set or changed by this plugin. New options
+									can alse be declared via
+									<a href="https://codemirror.net/doc/manual.html#defineOption"><code>CodeMirror.defineOption</code></a>,
+									and then have their value set here. For example, a plugin that
+									enables line numbers would set <code>codeMirrorOptions</code> to
+								<code>{&#39;lineNumbers&#39;: true}</code>.</p>
 							</li>
-							<li><p>Using the <strong>optional</strong> <code>assets</code> key you may specify <strong>only</strong> CSS assets that should be loaded in the rendered HTML document. Check for example the Joplin <a href="https://github.com/laurent22/joplin/blob/dev/packages/app-mobile/lib/joplin-renderer/MdToHtml/rules/mermaid.ts">Mermaid plugin</a> to see how the data should be structured.</p>
+							<li><p>Using the <strong>optional</strong> <code>assets</code> key you may specify <strong>only</strong> CSS
+									assets that should be loaded in the rendered HTML document. Check
+									for example the Joplin [Mermaid
+									plugin](<a href="https://github.com/laurent22/joplin/blob/dev/packages/renderer/MdToHtml/rules/mermaid.ts">https://github.com/laurent22/joplin/blob/dev/packages/renderer/MdToHtml/rules/mermaid.ts</a>)
+								to see how the data should be structured.</p>
 							</li>
 						</ul>
-						<p>One of the <code>plugin</code>, <code>codeMirrorResources</code>, or <code>codeMirrorOptions</code> keys must be provided for the plugin to be valid. Having multiple or all provided is also okay.</p>
-						<p>See the <a href="https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script">demo plugin</a> for an example of all these keys being used in one plugin.</p>
+						<p>One of the <code>plugin</code>, <code>codeMirrorResources</code>, or <code>codeMirrorOptions</code>
+							keys must be provided for the plugin to be valid. Having multiple or
+						all provided is also okay.</p>
+						<p>See the <a href="https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script">demo
+							plugin</a>
+						for an example of all these keys being used in one plugin.</p>
 					</div>
 				</section>
 				<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
@@ -130,7 +154,8 @@
 					</aside>
 					<div class="tsd-comment tsd-typography">
 						<div class="lead">
-							<p>Registers a new Markdown-It plugin, which should follow the template below.</p>
+							<p>Registers a new Markdown-It plugin, which should follow the template
+							below.</p>
 						</div>
 						<pre><code class="language-javascript"><span class="hljs-built_in">module</span>.exports = {
     <span class="hljs-attr">default</span>: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">context</span>) </span>{
@@ -144,15 +169,50 @@
         }
     }
 }</code></pre>
+						<p>See <a href="https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script">the
+							demo</a>
+						for a simple Markdown-it plugin example.</p>
+						<a href="#exported-members" id="exported-members" style="color: inherit; text-decoration: none;">
+							<h2>Exported members</h2>
+						</a>
 						<ul>
-							<li><p>The <code>context</code> argument is currently unused but could be used later on to provide access to your own plugin so that the content script and plugin can communicate.</p>
+							<li><p>The <code>context</code> argument is currently unused but could be used later
+									on to provide access to your own plugin so that the content script
+								and plugin can communicate.</p>
 							</li>
-							<li><p>The <strong>required</strong> <code>plugin</code> key is the actual Markdown-It plugin - check the <a href="https://github.com/markdown-it/markdown-it">official doc</a> for more information. The <code>options</code> parameter is of type <a href="https://github.com/laurent22/joplin/blob/dev/packages/app-mobile/lib/joplin-renderer/MdToHtml.ts">RuleOptions</a>, which contains a number of options, mostly useful for Joplin&#39;s internal code.</p>
+							<li><p>The <strong>required</strong> <code>plugin</code> key is the actual Markdown-It plugin -
+									check the [official
+									doc](<a href="https://github.com/markdown-it/markdown-it">https://github.com/markdown-it/markdown-it</a>) for more
+									information. The <code>options</code> parameter is of type
+									<a href="https://github.com/laurent22/joplin/blob/dev/packages/renderer/MdToHtml.ts">RuleOptions</a>,
+									which contains a number of options, mostly useful for Joplin&#39;s
+								internal code.</p>
 							</li>
-							<li><p>Using the <strong>optional</strong> <code>assets</code> key you may specify assets such as JS or CSS that should be loaded in the rendered HTML document. Check for example the Joplin <a href="https://github.com/laurent22/joplin/blob/dev/packages/app-mobile/lib/joplin-renderer/MdToHtml/rules/mermaid.ts">Mermaid plugin</a> to see how the data should be structured.</p>
+							<li><p>Using the <strong>optional</strong> <code>assets</code> key you may specify assets such as
+									JS or CSS that should be loaded in the rendered HTML document.
+									Check for example the Joplin [Mermaid
+									plugin](<a href="https://github.com/laurent22/joplin/blob/dev/packages/renderer/MdToHtml/rules/mermaid.ts">https://github.com/laurent22/joplin/blob/dev/packages/renderer/MdToHtml/rules/mermaid.ts</a>)
+								to see how the data should be structured.</p>
 							</li>
 						</ul>
-						<p>To include a regular Markdown-It plugin, that doesn&#39;t make use of any Joplin-specific features, you would simply create a file such as this:</p>
+						<a href="#passing-messages-from-the-content-script-to-your-plugin" id="passing-messages-from-the-content-script-to-your-plugin" style="color: inherit; text-decoration: none;">
+							<h2>Passing messages from the content script to your plugin</h2>
+						</a>
+						<p>The application provides the following function to allow executing
+						commands from the rendered HTML code:</p>
+						<p><code>webviewApi.executeCommand(commandName, ...args)</code></p>
+						<p>So you can use this mechanism to pass messages from the note viewer
+							to your own plugin. To do so you would define a command, using
+							<code>joplin.commands.register</code>, then you would call this command using
+							the <code>webviewApi</code> object. See again <a href="https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script">the
+							demo</a>
+						to see how this can be done.</p>
+						<a href="#registering-an-existing-markdown-it-plugin" id="registering-an-existing-markdown-it-plugin" style="color: inherit; text-decoration: none;">
+							<h2>Registering an existing Markdown-it plugin</h2>
+						</a>
+						<p>To include a regular Markdown-It plugin, that doesn&#39;t make use of
+							any Joplin-specific features, you would simply create a file such as
+						this:</p>
 						<pre><code class="language-javascript"><span class="hljs-built_in">module</span>.exports = {
     <span class="hljs-attr">default</span>: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">context</span>) </span>{
         <span class="hljs-keyword">return</span> {

docs/api/references/plugin_api/enums/menuitemlocation.html

@@ -75,9 +75,11 @@
 								<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="menuitemlocation.html#edit" class="tsd-kind-icon">Edit</a></li>
 								<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="menuitemlocation.html#editorcontextmenu" class="tsd-kind-icon">Editor<wbr>Context<wbr>Menu</a></li>
 								<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="menuitemlocation.html#file" class="tsd-kind-icon">File</a></li>
+								<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="menuitemlocation.html#foldercontextmenu" class="tsd-kind-icon">Folder<wbr>Context<wbr>Menu</a></li>
 								<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="menuitemlocation.html#help" class="tsd-kind-icon">Help</a></li>
 								<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="menuitemlocation.html#note" class="tsd-kind-icon">Note</a></li>
 								<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="menuitemlocation.html#notelistcontextmenu" class="tsd-kind-icon">Note<wbr>List<wbr>Context<wbr>Menu</a></li>
+								<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="menuitemlocation.html#tagcontextmenu" class="tsd-kind-icon">Tag<wbr>Context<wbr>Menu</a></li>
 								<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="menuitemlocation.html#tools" class="tsd-kind-icon">Tools</a></li>
 								<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="menuitemlocation.html#view" class="tsd-kind-icon">View</a></li>
 							</ul>
@@ -122,6 +124,22 @@
 					<aside class="tsd-sources">
 					</aside>
 				</section>
+				<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
+					<a name="foldercontextmenu" class="tsd-anchor"></a>
+					<h3>Folder<wbr>Context<wbr>Menu</h3>
+					<div class="tsd-signature tsd-kind-icon">Folder<wbr>Context<wbr>Menu<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;folderContextMenu&quot;</span></div>
+					<aside class="tsd-sources">
+					</aside>
+					<div class="tsd-comment tsd-typography">
+						<div class="lead">
+							<p>When a command is called from a folder context menu, the
+							command will receive the following arguments:</p>
+						</div>
+						<ul>
+							<li><code>folderId:string</code>: ID of the folder that was right-clicked on</li>
+						</ul>
+					</div>
+				</section>
 				<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
 					<a name="help" class="tsd-anchor"></a>
 					<h3>Help</h3>
@@ -142,6 +160,31 @@
 					<div class="tsd-signature tsd-kind-icon">Note<wbr>List<wbr>Context<wbr>Menu<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;noteListContextMenu&quot;</span></div>
 					<aside class="tsd-sources">
 					</aside>
+					<div class="tsd-comment tsd-typography">
+						<div class="lead">
+							<p>When a command is called from the note list context menu, the
+							command will receive the following arguments:</p>
+						</div>
+						<ul>
+							<li><code>noteIds:string[]</code>: IDs of the notes that were right-clicked on.</li>
+						</ul>
+					</div>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
+					<a name="tagcontextmenu" class="tsd-anchor"></a>
+					<h3>Tag<wbr>Context<wbr>Menu</h3>
+					<div class="tsd-signature tsd-kind-icon">Tag<wbr>Context<wbr>Menu<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;tagContextMenu&quot;</span></div>
+					<aside class="tsd-sources">
+					</aside>
+					<div class="tsd-comment tsd-typography">
+						<div class="lead">
+							<p>When a command is called from a tag context menu, the
+							command will receive the following arguments:</p>
+						</div>
+						<ul>
+							<li><code>tagId:string</code>: ID of the tag that was right-clicked on</li>
+						</ul>
+					</div>
 				</section>
 				<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
 					<a name="tools" class="tsd-anchor"></a>
@@ -188,6 +231,9 @@
 							<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
 								<a href="menuitemlocation.html#file" class="tsd-kind-icon">File</a>
 							</li>
+							<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
+								<a href="menuitemlocation.html#foldercontextmenu" class="tsd-kind-icon">Folder<wbr>Context<wbr>Menu</a>
+							</li>
 							<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
 								<a href="menuitemlocation.html#help" class="tsd-kind-icon">Help</a>
 							</li>
@@ -197,6 +243,9 @@
 							<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
 								<a href="menuitemlocation.html#notelistcontextmenu" class="tsd-kind-icon">Note<wbr>List<wbr>Context<wbr>Menu</a>
 							</li>
+							<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
+								<a href="menuitemlocation.html#tagcontextmenu" class="tsd-kind-icon">Tag<wbr>Context<wbr>Menu</a>
+							</li>
 							<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
 								<a href="menuitemlocation.html#tools" class="tsd-kind-icon">Tools</a>
 							</li>

docs/api/references/plugin_api/globals.html

@@ -133,6 +133,12 @@
 								<li class="tsd-kind-variable"><a href="globals.html#logger" class="tsd-kind-icon">logger</a></li>
 							</ul>
 						</section>
+						<section class="tsd-index-section ">
+							<h3>Functions</h3>
+							<ul class="tsd-index-list">
+								<li class="tsd-kind-function"><a href="globals.html#iscontextmenuitemlocation" class="tsd-kind-icon">is<wbr>Context<wbr>Menu<wbr>Item<wbr>Location</a></li>
+							</ul>
+						</section>
 					</div>
 				</section>
 			</section>
@@ -187,9 +193,11 @@
 						<div class="lead">
 							<p>An array of at least one element and at most three elements.</p>
 						</div>
-						<p>[0]: Resource name (eg. &quot;notes&quot;, &quot;folders&quot;, &quot;tags&quot;, etc.)
-							[1]: (Optional) Resource ID.
-						[2]: (Optional) Resource link.</p>
+						<ul>
+							<li><strong>[0]</strong>: Resource name (eg. &quot;notes&quot;, &quot;folders&quot;, &quot;tags&quot;, etc.)</li>
+							<li><strong>[1]</strong>: (Optional) Resource ID.</li>
+							<li><strong>[2]</strong>: (Optional) Resource link.</li>
+						</ul>
 					</div>
 				</section>
 				<section class="tsd-panel tsd-member tsd-kind-type-alias">
@@ -242,6 +250,33 @@
 					</aside>
 				</section>
 			</section>
+			<section class="tsd-panel-group tsd-member-group ">
+				<h2>Functions</h2>
+				<section class="tsd-panel tsd-member tsd-kind-function">
+					<a name="iscontextmenuitemlocation" class="tsd-anchor"></a>
+					<h3>is<wbr>Context<wbr>Menu<wbr>Item<wbr>Location</h3>
+					<ul class="tsd-signatures tsd-kind-function">
+						<li class="tsd-signature tsd-kind-icon">is<wbr>Context<wbr>Menu<wbr>Item<wbr>Location<span class="tsd-signature-symbol">(</span>location<span class="tsd-signature-symbol">: </span><a href="enums/menuitemlocation.html" class="tsd-signature-type">MenuItemLocation</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
+					</ul>
+					<ul class="tsd-descriptions">
+						<li class="tsd-description">
+							<aside class="tsd-sources">
+							</aside>
+							<h4 class="tsd-parameters-title">Parameters</h4>
+							<ul class="tsd-parameters">
+								<li>
+									<h5>location: <a href="enums/menuitemlocation.html" class="tsd-signature-type">MenuItemLocation</a></h5>
+								</li>
+							</ul>
+							<!-- JOPLINCHANGE
+    <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
+
+
+-->
+						</li>
+					</ul>
+				</section>
+			</section>
 		</div>
 		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 			<!--
@@ -381,6 +416,9 @@
 					<li class=" tsd-kind-type-alias">
 						<a href="globals.html#viewhandle" class="tsd-kind-icon">ViewHandle</a>
 					</li>
+					<li class=" tsd-kind-function">
+						<a href="globals.html#iscontextmenuitemlocation" class="tsd-kind-icon">isContextMenuItemLocation</a>
+					</li>
 				</ul>
 			</nav>
 		</div>

docs/api/references/plugin_api/index.html

@@ -206,6 +206,9 @@
 					<li class=" tsd-kind-type-alias">
 						<a href="globals.html#viewhandle" class="tsd-kind-icon">ViewHandle</a>
 					</li>
+					<li class=" tsd-kind-function">
+						<a href="globals.html#iscontextmenuitemlocation" class="tsd-kind-icon">isContextMenuItemLocation</a>
+					</li>
 				</ul>
 			</nav>
 		</div>

docs/api/references/plugin_api/interfaces/command.html

@@ -142,7 +142,7 @@
 									<td>&quot;oneNoteSelected &amp;&amp; !inConflictFolder&quot;</td>
 								</tr>
 						</tbody></table>
-						<p>Currently the supported context variables aren&#39;t documented, but you can <a href="https://github.com/laurent22/joplin/blob/dev/packages/app-mobile/lib/services/commands/stateToWhenClauseContext.ts">find the list here</a>.</p>
+						<p>Currently the supported context variables aren&#39;t documented, but you can <a href="https://github.com/laurent22/joplin/blob/dev/packages/lib/services/commands/stateToWhenClauseContext.ts">find the list here</a>.</p>
 						<p>Note: Commands are enabled by default unless you use this property.</p>
 					</div>
 				</section>

docs/changelog/index.html

@@ -400,6 +400,46 @@ https://github.com/laurent22/joplin/blob/dev/readme/changelog.md
 
 	<div class="main">
 <h1>Joplin changelog<a name="joplin-changelog" href="#joplin-changelog" class="heading-anchor">🔗</a></h1>
+<h2><a href="https://github.com/laurent22/joplin/releases/tag/v1.5.11">v1.5.11</a> - 2020-12-27T19:54:07Z<a name="v1-5-11-https-github-com-laurent22-joplin-releases-tag-v1-5-11-2020-12-27t19-54-07z" href="#v1-5-11-https-github-com-laurent22-joplin-releases-tag-v1-5-11-2020-12-27t19-54-07z" class="heading-anchor">🔗</a></h2>
+<ul>
+<li>New: Add support for media players (video, audio and PDF)</li>
+<li>New: Add table captions when importing ENEX files</li>
+<li>New: Added doc about Rich Text editor and added way to dismiss warning banner</li>
+<li>New: MacOS: Notarize application</li>
+<li>New: Plugins: Add support for content script asset files, for Markdown-it plugins</li>
+<li>New: Plugins: Add support for context menu items on notebooks and tags</li>
+<li>New: Plugins: Add support for workspace.onSyncStart event</li>
+<li>New: Plugins: Added a way to execute commands from Markdown-it content scripts</li>
+<li>Fixed: Fix End key behavior with Codemirror spellcheck (<a href="https://github.com/laurent22/joplin/issues/4215">#4215</a> by Caleb John)</li>
+<li>Fixed: Fixed basic search when executing a query in Chinese (<a href="https://github.com/laurent22/joplin/issues/4034">#4034</a> by Naveen M V)</li>
+<li>Fixed: Fixed context menu when the UI is zoomed in or out (<a href="https://github.com/laurent22/joplin/issues/4201">#4201</a>)</li>
+<li>Fixed: Fixed importing certain code blocks from ENEX</li>
+<li>Fixed: Fixed importing ENEX files that contain empty resources</li>
+<li>Fixed: Fixed importing ENEX files that contain resources with invalid mime type</li>
+<li>Fixed: Fixed issue when searching for text that contains diacritic (<a href="https://github.com/laurent22/joplin/issues/4152">#4152</a>) (<a href="https://github.com/laurent22/joplin/issues/4025">#4025</a> by Roman Musin)</li>
+<li>Fixed: Fixed issue with attachment paths being invalid when user has spaces in home directory path.</li>
+<li>Fixed: Fixed issue with note not being saved when a column is added or remove from Rich Text editor</li>
+<li>Fixed: Fixed issues when importing hidden tables within hidden sections in Enex files</li>
+<li>Fixed: Fixed numbered list bug in markdown editor (<a href="https://github.com/laurent22/joplin/issues/4116">#4116</a>) (<a href="https://github.com/laurent22/joplin/issues/3917">#3917</a> by <a href="https://github.com/MichBoi">@MichBoi</a>)</li>
+<li>Fixed: Fixed potential crash when watching note files or resources</li>
+<li>Fixed: Fixed title input field width on small windows</li>
+<li>Fixed: Focus editor after pressing toolbar buttons (<a href="https://github.com/laurent22/joplin/issues/4037">#4037</a>) (<a href="https://github.com/laurent22/joplin/issues/4036">#4036</a> by <a href="https://github.com/CalebJohn">@CalebJohn</a>)</li>
+<li>Fixed: Plugins: Fixed disabling plugin files that start with &quot;_&quot;</li>
+<li>Fixed: Prevent double paste when using Shift+Ctrl+V (<a href="https://github.com/laurent22/joplin/issues/4243">#4243</a>)</li>
+<li>Fixed: Prevents crash when invalid spell checker language is selected, and provide fallback for invalid language codes (<a href="https://github.com/laurent22/joplin/issues/4146">#4146</a>)</li>
+<li>Fixed: Register Markdown editor commands with the Keyboard Shortcut editor (<a href="https://github.com/laurent22/joplin/issues/4136">#4136</a>) (<a href="https://github.com/laurent22/joplin/issues/4130">#4130</a> by Caleb John)</li>
+<li>Improved: Display Katex parsing errors</li>
+<li>Improved: Improved warning banner colors</li>
+<li>Improved: Plugins: Commands would not show up in keymap editor when no shortcut was associated with them</li>
+<li>Improved: Plugins: Improved note change event handling.</li>
+<li>Improved: Removed warning for Markdown editor spell checking</li>
+<li>Improved: Restrict auto-detection of links, and added option to toggle linkify (<a href="https://github.com/laurent22/joplin/issues/4205">#4205</a>)</li>
+<li>Improved: Rich Text: Do not converts to markdown links URLs that would be linkified</li>
+<li>Improved: Translation: Update zh_CN (<a href="https://github.com/laurent22/joplin/issues/4195">#4195</a> by Zhang YANG)</li>
+<li>Improved: Update macOS icon for macOS Big Sur</li>
+<li>Improved: Update Mermaid: 8.8.1 -&gt; 8.8.4 (<a href="https://github.com/laurent22/joplin/issues/4193">#4193</a> by Helmut K. C. Tessarek)</li>
+<li>Improved: Use plugins whenever printing or exporting notes</li>
+</ul>
 <h2><a href="https://github.com/laurent22/joplin/releases/tag/v1.4.19">v1.4.19</a> - 2020-12-01T11:11:16Z<a name="v1-4-19-https-github-com-laurent22-joplin-releases-tag-v1-4-19-2020-12-01t11-11-16z" href="#v1-4-19-https-github-com-laurent22-joplin-releases-tag-v1-4-19-2020-12-01t11-11-16z" class="heading-anchor">🔗</a></h2>
 <ul>
 <li>Improved: Disable soft-break by default in Markdown rendering</li>

docs/changelog_cli/index.html

@@ -400,6 +400,22 @@ https://github.com/laurent22/joplin/blob/dev/readme/changelog_cli.md
 
 	<div class="main">
 <h1>Joplin terminal app changelog<a name="joplin-terminal-app-changelog" href="#joplin-terminal-app-changelog" class="heading-anchor">🔗</a></h1>
+<h2><a href="https://github.com/laurent22/joplin/releases/tag/cli-v1.5.1">cli-v1.5.1</a> - 2020-12-26T00:46:31Z<a name="cli-v1-5-1-https-github-com-laurent22-joplin-releases-tag-cli-v1-5-1-2020-12-26t00-46-31z" href="#cli-v1-5-1-https-github-com-laurent22-joplin-releases-tag-cli-v1-5-1-2020-12-26t00-46-31z" class="heading-anchor">🔗</a></h2>
+<ul>
+<li>New: Add table captions when importing ENEX files</li>
+<li>Improved: Allow exporting conflict notes (#4095)</li>
+<li>Improved: Allow lowercase filters when doing search</li>
+<li>Improved: Improved error handling when importing ENEX files</li>
+<li>Improved: Partially reverts #3975 (link rendering)</li>
+<li>Fixed: Fix sorting by title in a case insensitive way</li>
+<li>Fixed: Fixed basic search when executing a query in Chinese (#4034 by Naveen M V)</li>
+<li>Fixed: Fixed importing ENEX files that contain empty resources</li>
+<li>Fixed: Fixed importing ENEX files that contain resources with invalid mime type</li>
+<li>Fixed: Fixed importing certain ENEX files that contain invalid dates</li>
+<li>Fixed: Fixed importing certain code blocks from ENEX</li>
+<li>Fixed: Fixed issue when searching for text that contains diacritic (#4152) (#4025 by Roman Musin)</li>
+<li>Fixed: Fixed issues when importing hidden tables within hidden sections in Enex files</li>
+</ul>
 <h2><a href="https://github.com/laurent22/joplin/releases/tag/cli-v1.4.9">cli-v1.4.9</a> - 2020-11-26T15:00:37Z<a name="cli-v1-4-9-https-github-com-laurent22-joplin-releases-tag-cli-v1-4-9-2020-11-26t15-00-37z" href="#cli-v1-4-9-https-github-com-laurent22-joplin-releases-tag-cli-v1-4-9-2020-11-26t15-00-37z" class="heading-anchor">🔗</a></h2>
 <ul>
 <li>Improved: Allow exporting conflict notes (#4095)</li>

docs/faq/index.html

@@ -411,6 +411,9 @@ https://github.com/laurent22/joplin/blob/dev/readme/faq.md
 </ul>
 <p>Now try to install again and it should work.</p>
 <p>More info there: <a href="https://github.com/electron-userland/electron-builder/issues/4057">https://github.com/electron-userland/electron-builder/issues/4057</a></p>
+<h2>How can I pass arguments to the Linux installation script?<a name="how-can-i-pass-arguments-to-the-linux-installation-script" href="#how-can-i-pass-arguments-to-the-linux-installation-script" class="heading-anchor">🔗</a></h2>
+<p>You can pass <a href="https://github.com/laurent22/joplin/blob/dev/Joplin_install_and_update.sh#L37">arguments</a> to the installation script by using this command.</p>
+<p><code>wget -O - https://raw.githubusercontent.com/laurent22/joplin/dev/Joplin_install_and_update.sh \| bash -s -- --argument1 --argument2</code></p>
 <h2>How can I edit my note in an external text editor?<a name="how-can-i-edit-my-note-in-an-external-text-editor" href="#how-can-i-edit-my-note-in-an-external-text-editor" class="heading-anchor">🔗</a></h2>
 <p>The editor command (may include arguments) defines which editor will be used to open a note. If none is provided it will try to auto-detect the default editor. If this does nothing or you want to change it for Joplin, you need to configure it in the Preferences -&gt; Text editor command.</p>
 <p>Some example configurations are: (comments after #)</p>

docs/index.html

@@ -420,17 +420,17 @@ https://github.com/laurent22/joplin/blob/dev/README.md
 <tbody>
 <tr>
 <td>Windows (32 and 64-bit)</td>
-<td><a href='https://github.com/laurent22/joplin/releases/download/v1.4.19/Joplin-Setup-1.4.19.exe'><img alt='Get it on Windows' width="134px" src='https://joplinapp.org/images/BadgeWindows.png'/></a></td>
-<td>Or get the <a href='https://github.com/laurent22/joplin/releases/download/v1.4.19/JoplinPortable.exe'>Portable version</a><br><br>The <a href="https://en.wikipedia.org/wiki/Portable_application">portable application</a> allows installing the software on a portable device such as a USB key. Simply copy the file JoplinPortable.exe in any directory on that USB key ; the application will then create a directory called &quot;JoplinProfile&quot; next to the executable file.</td>
+<td><a href='https://github.com/laurent22/joplin/releases/download/v1.5.11/Joplin-Setup-1.5.11.exe'><img alt='Get it on Windows' width="134px" src='https://joplinapp.org/images/BadgeWindows.png'/></a></td>
+<td>Or get the <a href='https://github.com/laurent22/joplin/releases/download/v1.5.11/JoplinPortable.exe'>Portable version</a><br><br>The <a href="https://en.wikipedia.org/wiki/Portable_application">portable application</a> allows installing the software on a portable device such as a USB key. Simply copy the file JoplinPortable.exe in any directory on that USB key ; the application will then create a directory called &quot;JoplinProfile&quot; next to the executable file.</td>
 </tr>
 <tr>
 <td>macOS</td>
-<td><a href='https://github.com/laurent22/joplin/releases/download/v1.4.19/Joplin-1.4.19.dmg'><img alt='Get it on macOS' width="134px" src='https://joplinapp.org/images/BadgeMacOS.png'/></a></td>
+<td><a href='https://github.com/laurent22/joplin/releases/download/v1.5.11/Joplin-1.5.11.dmg'><img alt='Get it on macOS' width="134px" src='https://joplinapp.org/images/BadgeMacOS.png'/></a></td>
 <td>-</td>
 </tr>
 <tr>
 <td>Linux</td>
-<td><a href='https://github.com/laurent22/joplin/releases/download/v1.4.19/Joplin-1.4.19.AppImage'><img alt='Get it on Linux' width="134px" src='https://joplinapp.org/images/BadgeLinux.png'/></a></td>
+<td><a href='https://github.com/laurent22/joplin/releases/download/v1.5.11/Joplin-1.5.11.AppImage'><img alt='Get it on Linux' width="134px" src='https://joplinapp.org/images/BadgeLinux.png'/></a></td>
 <td>The recommended way is to use the following installation script as it will handle the desktop icon too:<br><br> <code>wget -O - https://raw.githubusercontent.com/laurent22/joplin/dev/Joplin_install_and_update.sh | bash</code></td>
 </tr>
 </tbody>

docs/nextcloud_app/index.html

@@ -400,6 +400,10 @@ https://github.com/laurent22/joplin/blob/dev/readme/nextcloud_app.md
 
 	<div class="main">
 <h1>Joplin Web API for Nextcloud<a name="joplin-web-api-for-nextcloud" href="#joplin-web-api-for-nextcloud" class="heading-anchor">🔗</a></h1>
+<hr>
+<p><strong>IMPORTANT: THIS APPLICATION IS DEPRECATED AND WILL NO LONGER BE SUPPORTED FROM JOPLIN 1.6.x</strong></p>
+<p>It is deprecated in favour of <a href="https://discourse.joplinapp.org/t/joplin-web-api-for-nextcloud/4491/72?u=laurent">Joplin Server</a>, so if you are relying on it please do not upgrade to Joplin 1.6.x till you are ready to migrate to Joplin Server or some other alternative.</p>
+<hr>
 <p><strong>This is a beta feature, not yet completed. More info coming soon!</strong></p>
 <p>The app can be downloaded from there: <a href="https://apps.nextcloud.com/apps/joplin">https://apps.nextcloud.com/apps/joplin</a></p>
 <p>The Joplin Web API for Nextcloud is a helper application that enables certain features that are not possible otherwise. In particular:</p>

joplin.code-workspace

@@ -116,6 +116,7 @@
 			"**/_vieux/": true,
 			"**/.DS_Store": true,
 			"**/*.base64": true,
+			"**/*~": true,
 			"**/*.bundle.js": true,
 			"**/*.eot": true,
 			"**/*.icns": true,
@@ -309,6 +310,10 @@
 			"packages/renderer/MdToHtml/rules/sanitize_html.js": true,
 			"packages/app-mobile/lib/rnInjectedJs/": true,
 			"packages/app-mobile/lib/sql-extensions/spellfix.so": true,
+			"packages/server/dist/": true,
+			"packages/server/db-*.sqlite": true,
+			"packages/server/test.pid": true,
+			"packages/server/temp": true,
 			"packages/generator-joplin/generators/app/templates/api/": true,
 			"packages/app-mobile/node_modules/": true,
 			"phpunit.xml": true,

package-lock.json

@@ -289,6 +289,75 @@
         "dedent": "^0.7.0",
         "npmlog": "^4.1.2",
         "yargs": "^14.2.2"
+      },
+      "dependencies": {
+        "ansi-regex": {
+          "version": "4.1.0",
+          "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.0.tgz",
+          "integrity": "sha512-1apePfXM1UOSqw0o9IiFAovVz9M5S1Dg+4TrDwfMewQ6p/rmMueb7tWZjQ1rx4Loy1ArBggoqGpfqqdI4rondg==",
+          "dev": true
+        },
+        "is-fullwidth-code-point": {
+          "version": "2.0.0",
+          "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz",
+          "integrity": "sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=",
+          "dev": true
+        },
+        "string-width": {
+          "version": "3.1.0",
+          "resolved": "https://registry.npmjs.org/string-width/-/string-width-3.1.0.tgz",
+          "integrity": "sha512-vafcv6KjVZKSgz06oM/H6GDBrAtz8vdhQakGjFIvNrHA6y3HCF1CInLy+QLq8dTJPQ1b+KDUqDFctkdRW44e1w==",
+          "dev": true,
+          "requires": {
+            "emoji-regex": "^7.0.1",
+            "is-fullwidth-code-point": "^2.0.0",
+            "strip-ansi": "^5.1.0"
+          }
+        },
+        "strip-ansi": {
+          "version": "5.2.0",
+          "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-5.2.0.tgz",
+          "integrity": "sha512-DuRs1gKbBqsMKIZlrffwlug8MHkcnpjs5VPmL1PAh+mA30U0DTotfDZ0d2UUsXpPmPmMMJ6W773MaA3J+lbiWA==",
+          "dev": true,
+          "requires": {
+            "ansi-regex": "^4.1.0"
+          }
+        },
+        "y18n": {
+          "version": "4.0.0",
+          "resolved": "https://registry.npmjs.org/y18n/-/y18n-4.0.0.tgz",
+          "integrity": "sha512-r9S/ZyXu/Xu9q1tYlpsLIsa3EeLXXk0VwlxqTcFRfg9EhMW+17kbt9G0NrgCmhGb5vT2hyhJZLfDGx+7+5Uj/w==",
+          "dev": true
+        },
+        "yargs": {
+          "version": "14.2.3",
+          "resolved": "https://registry.npmjs.org/yargs/-/yargs-14.2.3.tgz",
+          "integrity": "sha512-ZbotRWhF+lkjijC/VhmOT9wSgyBQ7+zr13+YLkhfsSiTriYsMzkTUFP18pFhWwBeMa5gUc1MzbhrO6/VB7c9Xg==",
+          "dev": true,
+          "requires": {
+            "cliui": "^5.0.0",
+            "decamelize": "^1.2.0",
+            "find-up": "^3.0.0",
+            "get-caller-file": "^2.0.1",
+            "require-directory": "^2.1.1",
+            "require-main-filename": "^2.0.0",
+            "set-blocking": "^2.0.0",
+            "string-width": "^3.0.0",
+            "which-module": "^2.0.0",
+            "y18n": "^4.0.0",
+            "yargs-parser": "^15.0.1"
+          }
+        },
+        "yargs-parser": {
+          "version": "15.0.1",
+          "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-15.0.1.tgz",
+          "integrity": "sha512-0OAMV2mAZQrs3FkNpDQcBk1x5HXb8X4twADss4S0Iuk+2dGnLOE/fRHrsYm542GduMveyA77OF4wrNJuanRCWw==",
+          "dev": true,
+          "requires": {
+            "camelcase": "^5.0.0",
+            "decamelize": "^1.2.0"
+          }
+        }
       }
     },
     "@lerna/collect-uncommitted": {
@@ -2183,6 +2252,14 @@
         "ssri": "^6.0.1",
         "unique-filename": "^1.1.1",
         "y18n": "^4.0.0"
+      },
+      "dependencies": {
+        "y18n": {
+          "version": "4.0.0",
+          "resolved": "https://registry.npmjs.org/y18n/-/y18n-4.0.0.tgz",
+          "integrity": "sha512-r9S/ZyXu/Xu9q1tYlpsLIsa3EeLXXk0VwlxqTcFRfg9EhMW+17kbt9G0NrgCmhGb5vT2hyhJZLfDGx+7+5Uj/w==",
+          "dev": true
+        }
       }
     },
     "cache-base": {
@@ -10578,80 +10655,11 @@
       "integrity": "sha512-LKYU1iAXJXUgAXn9URjiu+MWhyUXHsvfp7mcuYm9dSUKK0/CjtrUwFAxD82/mCWbtLsGjFIad0wIsod4zrTAEQ==",
       "dev": true
     },
-    "y18n": {
-      "version": "4.0.0",
-      "resolved": "https://registry.npmjs.org/y18n/-/y18n-4.0.0.tgz",
-      "integrity": "sha512-r9S/ZyXu/Xu9q1tYlpsLIsa3EeLXXk0VwlxqTcFRfg9EhMW+17kbt9G0NrgCmhGb5vT2hyhJZLfDGx+7+5Uj/w==",
-      "dev": true
-    },
     "yallist": {
       "version": "3.1.1",
       "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz",
       "integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==",
       "dev": true
-    },
-    "yargs": {
-      "version": "14.2.3",
-      "resolved": "https://registry.npmjs.org/yargs/-/yargs-14.2.3.tgz",
-      "integrity": "sha512-ZbotRWhF+lkjijC/VhmOT9wSgyBQ7+zr13+YLkhfsSiTriYsMzkTUFP18pFhWwBeMa5gUc1MzbhrO6/VB7c9Xg==",
-      "dev": true,
-      "requires": {
-        "cliui": "^5.0.0",
-        "decamelize": "^1.2.0",
-        "find-up": "^3.0.0",
-        "get-caller-file": "^2.0.1",
-        "require-directory": "^2.1.1",
-        "require-main-filename": "^2.0.0",
-        "set-blocking": "^2.0.0",
-        "string-width": "^3.0.0",
-        "which-module": "^2.0.0",
-        "y18n": "^4.0.0",
-        "yargs-parser": "^15.0.1"
-      },
-      "dependencies": {
-        "ansi-regex": {
-          "version": "4.1.0",
-          "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.0.tgz",
-          "integrity": "sha512-1apePfXM1UOSqw0o9IiFAovVz9M5S1Dg+4TrDwfMewQ6p/rmMueb7tWZjQ1rx4Loy1ArBggoqGpfqqdI4rondg==",
-          "dev": true
-        },
-        "is-fullwidth-code-point": {
-          "version": "2.0.0",
-          "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz",
-          "integrity": "sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=",
-          "dev": true
-        },
-        "string-width": {
-          "version": "3.1.0",
-          "resolved": "https://registry.npmjs.org/string-width/-/string-width-3.1.0.tgz",
-          "integrity": "sha512-vafcv6KjVZKSgz06oM/H6GDBrAtz8vdhQakGjFIvNrHA6y3HCF1CInLy+QLq8dTJPQ1b+KDUqDFctkdRW44e1w==",
-          "dev": true,
-          "requires": {
-            "emoji-regex": "^7.0.1",
-            "is-fullwidth-code-point": "^2.0.0",
-            "strip-ansi": "^5.1.0"
-          }
-        },
-        "strip-ansi": {
-          "version": "5.2.0",
-          "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-5.2.0.tgz",
-          "integrity": "sha512-DuRs1gKbBqsMKIZlrffwlug8MHkcnpjs5VPmL1PAh+mA30U0DTotfDZ0d2UUsXpPmPmMMJ6W773MaA3J+lbiWA==",
-          "dev": true,
-          "requires": {
-            "ansi-regex": "^4.1.0"
-          }
-        }
-      }
-    },
-    "yargs-parser": {
-      "version": "15.0.1",
-      "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-15.0.1.tgz",
-      "integrity": "sha512-0OAMV2mAZQrs3FkNpDQcBk1x5HXb8X4twADss4S0Iuk+2dGnLOE/fRHrsYm542GduMveyA77OF4wrNJuanRCWw==",
-      "dev": true,
-      "requires": {
-        "camelcase": "^5.0.0",
-        "decamelize": "^1.2.0"
-      }
     }
   }
 }

package.json

@@ -20,12 +20,16 @@
     "buildTranslationsNoTsc": "node packages/tools/build-translation.js",
     "buildWebsite": "npm run buildApiDoc && node ./packages/tools/build-website.js && npm run buildPluginDoc",
     "clean": "lerna clean -y && lerna run clean",
+    "circularDependencyCheck": "npx madge --warning --circular --extensions js ./",
     "generateDatabaseTypes": "node packages/tools/generate-database-types",
     "linkChecker": "linkchecker https://joplinapp.org",
     "linter-ci": "./node_modules/.bin/eslint --resolve-plugins-relative-to . --quiet --ext .js --ext .jsx --ext .ts --ext .tsx",
     "linter-precommit": "./node_modules/.bin/eslint --resolve-plugins-relative-to . --fix --ext .js --ext .jsx --ext .ts --ext .tsx",
     "linter": "./node_modules/.bin/eslint --resolve-plugins-relative-to . --fix --quiet --ext .js --ext .jsx --ext .ts --ext .tsx",
-    "postinstall": "lerna bootstrap --no-ci && npm run tsc",
+    "bootstrap": "lerna bootstrap --no-ci",
+    "bootstrapIgnoreScripts": "lerna bootstrap --ignore-scripts --no-ci",
+    "postinstall": "npm run bootstrap --no-ci && npm run build",
+    "build": "lerna run build && npm run tsc",
     "publishAll": "git pull && lerna version --yes --no-private --no-git-tag-version && gulp completePublishAll",
     "releaseAndroid": "node packages/tools/release-android.js",
     "releaseCli": "node packages/tools/release-cli.js",
@@ -39,7 +43,8 @@
     "updateIgnored": "gulp updateIgnoredTypeScriptBuild",
     "updatePluginTypes": "./packages/generator-joplin/updateTypes.sh",
     "watch": "lerna run watch --stream --parallel",
-    "i": "lerna add --no-bootstrap --scope"
+    "i": "lerna add --no-bootstrap --scope",
+    "server-start-dev": "docker-compose --file docker-compose.server-dev.yml up"
   },
   "husky": {
     "hooks": {

packages/app-cli/gulpfile.js

@@ -1,6 +1,7 @@
 const gulp = require('gulp');
 const fs = require('fs-extra');
 const utils = require('@joplin/tools/gulp/utils');
+const { setPackagePrivateField } = require('@joplin/tools/tool-utils');
 const tasks = {
 	// compileExtensions: {
 	// 	fn: require('../Tools/gulp/tasks/compileExtensions.js'),
@@ -10,12 +11,12 @@ const tasks = {
 	// updateIgnoredTypeScriptBuild: require('../Tools/gulp/tasks/updateIgnoredTypeScriptBuild'),
 };
 
-async function makePackagePublic(filePath) {
-	const text = await fs.readFile(filePath, 'utf8');
-	const obj = JSON.parse(text);
-	delete obj.private;
-	await fs.writeFile(filePath, JSON.stringify(obj), 'utf8');
-}
+// async function makePackagePublic(filePath) {
+// 	const text = await fs.readFile(filePath, 'utf8');
+// 	const obj = JSON.parse(text);
+// 	delete obj.private;
+// 	await fs.writeFile(filePath, JSON.stringify(obj), 'utf8');
+// }
 
 tasks.prepareBuild = {
 	fn: async () => {
@@ -25,7 +26,8 @@ tasks.prepareBuild = {
 		});
 
 		await utils.copyFile(`${__dirname}/package.json`, `${buildDir}/package.json`);
-		await makePackagePublic(`${buildDir}/package.json`);
+		// await makePackagePublic(`${buildDir}/package.json`);
+		await setPackagePrivateField(`${buildDir}/package.json`, false);
 
 		await utils.copyFile(`${__dirname}/package-lock.json`, `${buildDir}/package-lock.json`);
 		await utils.copyFile(`${__dirname}/gulpfile.js`, `${buildDir}/gulpfile.js`);

packages/app-cli/jest.config.js

@@ -54,5 +54,5 @@ module.exports = {
 
 	testEnvironment: 'node',
 	setupFilesAfterEnv: [`${__dirname}/jest.setup.js`],
-	slowTestThreshold: 20,
+	slowTestThreshold: 40,
 };

packages/app-cli/package.json

@@ -31,7 +31,7 @@
     ],
     "owner": "Laurent Cozic"
   },
-  "version": "1.5.1",
+  "version": "1.6.0",
   "bin": {
     "joplin": "./main.js"
   },

packages/app-cli/tests/MdToHtml.ts

@@ -147,27 +147,86 @@ describe('MdToHtml', function() {
 		expect(result.html.trim()).toBe('<div id="rendered-md"><p>just <strong>testing</strong></p>\n</div>');
 	}));
 
-	// it('should render links correctly', (async () => {
-	// 	const mdToHtml = newTestMdToHtml();
+	it('should render links correctly', (async () => {
+		const testCases = [
+			// 0: input
+			// 1: output with linkify = off
+			// 2: output with linkify = on
+			[
+				'https://example.com',
+				'https://example.com',
+				'<a data-from-md title=\'https://example.com\' href=\'https://example.com\'>https://example.com</a>',
+			],
+			[
+				'file://C:\\AUTOEXEC.BAT',
+				'file://C:\\AUTOEXEC.BAT',
+				'<a data-from-md title=\'file://C:%5CAUTOEXEC.BAT\' href=\'file://C:%5CAUTOEXEC.BAT\'>file://C:\\AUTOEXEC.BAT</a>',
+			],
+			[
+				'example.com',
+				'example.com',
+				'example.com',
+			],
+			[
+				'oo.ps',
+				'oo.ps',
+				'oo.ps',
+			],
+			[
+				'test@example.com',
+				'test@example.com',
+				'test@example.com',
+			],
+			[
+				'<https://example.com>',
+				'<a data-from-md title=\'https://example.com\' href=\'https://example.com\'>https://example.com</a>',
+				'<a data-from-md title=\'https://example.com\' href=\'https://example.com\'>https://example.com</a>',
+			],
+			[
+				'[ok](https://example.com)',
+				'<a data-from-md title=\'https://example.com\' href=\'https://example.com\'>ok</a>',
+				'<a data-from-md title=\'https://example.com\' href=\'https://example.com\'>ok</a>',
+			],
+			[
+				'[bla.pdf](file:///Users/tessus/Downloads/bla.pdf)',
+				'<a data-from-md title=\'file:///Users/tessus/Downloads/bla.pdf\' href=\'file:///Users/tessus/Downloads/bla.pdf\'>bla.pdf</a>',
+				'<a data-from-md title=\'file:///Users/tessus/Downloads/bla.pdf\' href=\'file:///Users/tessus/Downloads/bla.pdf\'>bla.pdf</a>',
+			],
+		];
 
-	// 	const testCases = [
-	// 		// None of these should result in a link
-	// 		['https://example.com', 'https://example.com'],
-	// 		['file://C:\\AUTOEXEC.BAT', 'file://C:\\AUTOEXEC.BAT'],
-	// 		['example.com', 'example.com'],
-	// 		['oo.ps', 'oo.ps'],
-	// 		['test@example.com', 'test@example.com'],
+		const mdToHtmlLinkifyOn = newTestMdToHtml({
+			pluginOptions: {
+				linkify: { enabled: true },
+			},
+		});
 
-	// 		// Those should be converted to links
-	// 		['<https://example.com>', '<a data-from-md title=\'https://example.com\' href=\'https://example.com\'>https://example.com</a>'],
-	// 		['[ok](https://example.com)', '<a data-from-md title=\'https://example.com\' href=\'https://example.com\'>ok</a>'],
-	// 	];
+		const mdToHtmlLinkifyOff = newTestMdToHtml({
+			pluginOptions: {
+				linkify: { enabled: false },
+			},
+		});
 
-	// 	for (const testCase of testCases) {
-	// 		const [input, expected] = testCase;
-	// 		const actual = await mdToHtml.render(input, null, { bodyOnly: true, plainResourceRendering: true });
-	// 		expect(actual.html).toBe(expected);
-	// 	}
-	// }));
+		for (const testCase of testCases) {
+			const [input, expectedLinkifyOff, expectedLinkifyOn] = testCase;
+
+			{
+				const actual = await mdToHtmlLinkifyOn.render(input, null, {
+					bodyOnly: true,
+					plainResourceRendering: true,
+				});
+
+				expect(actual.html).toBe(expectedLinkifyOn);
+			}
+
+			{
+				const actual = await mdToHtmlLinkifyOff.render(input, null, {
+					bodyOnly: true,
+					plainResourceRendering: true,
+				});
+
+				expect(actual.html).toBe(expectedLinkifyOff);
+			}
+		}
+	}));
 
 });

packages/app-cli/tests/Synchronizer.basics.ts

@@ -1,7 +1,7 @@
 import Setting from '@joplin/lib/models/Setting';
 import { allNotesFolders, remoteNotesAndFolders, localNotesFoldersSameAsRemote } from './test-utils-synchronizer';
 
-const { syncTargetName, synchronizerStart, setupDatabaseAndSynchronizer, synchronizer, sleep, switchClient, syncTargetId, fileApi } = require('./test-utils.js');
+const { syncTargetName, afterAllCleanUp, synchronizerStart, setupDatabaseAndSynchronizer, synchronizer, sleep, switchClient, syncTargetId, fileApi } = require('./test-utils.js');
 const Folder = require('@joplin/lib/models/Folder.js');
 const Note = require('@joplin/lib/models/Note.js');
 const BaseItem = require('@joplin/lib/models/BaseItem.js');
@@ -16,6 +16,10 @@ describe('Synchronizer.basics', function() {
 		done();
 	});
 
+	afterAll(async () => {
+		await afterAllCleanUp();
+	});
+
 	it('should create remote items', (async () => {
 		const folder = await Folder.save({ title: 'folder1' });
 		await Note.save({ title: 'un', parent_id: folder.id });
@@ -123,10 +127,6 @@ describe('Synchronizer.basics', function() {
 	}));
 
 	it('should delete local notes', (async () => {
-		// For these tests we pass the context around for each user. This is to make sure that the "deletedItemsProcessed"
-		// property of the basicDelta() function is cleared properly at the end of a sync operation. If it is not cleared
-		// it means items will no longer be deleted locally via sync.
-
 		const folder1 = await Folder.save({ title: 'folder1' });
 		const note1 = await Note.save({ title: 'un', parent_id: folder1.id });
 		const note2 = await Note.save({ title: 'deux', parent_id: folder1.id });

packages/app-cli/tests/enex_to_md/svg.html

@@ -0,0 +1 @@
+<img src="data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' x='0px' y='0px' width='16px' height='16px' viewBox='0 0 24 24' data-evernote-id='0' class='js-evernote-checked'%3e%3cg transform='translate(0%2c 0)' data-evernote-id='18' class='js-evernote-checked'%3e%3cpolygon fill='none' stroke='%23343434' stroke-width='2' stroke-linecap='square' stroke-miterlimit='10' points='12%2c2.6 15%2c9 21.4%2c9 16.7%2c13.9 18.6%2c21.4 12%2c17.6 5.4%2c21.4 7.3%2c13.9 2.6%2c9 9%2c9 ' stroke-linejoin='miter' data-evernote-id='19' class='js-evernote-checked'%3e%3c/polygon%3e%3c/g%3e%3c/svg%3e"/>

packages/app-cli/tests/enex_to_md/svg.md

@@ -0,0 +1 @@
+![](data:image/svg+xml,%3csvg%20xmlns='http://www.w3.org/2000/svg'%20xmlns:xlink='http://www.w3.org/1999/xlink'%20x='0px'%20y='0px'%20width='16px'%20height='16px'%20viewBox='0%200%2024%2024'%20data-evernote-id='0'%20class='js-evernote-checked'%3e%3cg%20transform='translate%280%2c%200%29'%20data-evernote-id='18'%20class='js-evernote-checked'%3e%3cpolygon%20fill='none'%20stroke='%23343434'%20stroke-width='2'%20stroke-linecap='square'%20stroke-miterlimit='10'%20points='12%2c2.6%2015%2c9%2021.4%2c9%2016.7%2c13.9%2018.6%2c21.4%2012%2c17.6%205.4%2c21.4%207.3%2c13.9%202.6%2c9%209%2c9%20'%20stroke-linejoin='miter'%20data-evernote-id='19'%20class='js-evernote-checked'%3e%3c/polygon%3e%3c/g%3e%3c/svg%3e)

packages/app-cli/tests/services_PluginService.ts

@@ -171,7 +171,7 @@ describe('services_PluginService', function() {
 
 		const contentScriptPath = `${tempDir}/markdownItTestPlugin.js`;
 		const contentScriptCssPath = `${tempDir}/markdownItTestPlugin.css`;
-		await shim.fsDriver().copy(`${testPluginDir}/content_script/src/markdownItTestPlugin.js`, contentScriptPath);
+		await shim.fsDriver().copy(`${testPluginDir}/markdownItTestPlugin.js`, contentScriptPath);
 		await shim.fsDriver().copy(`${testPluginDir}/content_script/src/markdownItTestPlugin.css`, contentScriptCssPath);
 
 		const service = newPluginService();

packages/app-cli/tests/support/plugins/codemirror_content_script/GENERATOR_DOC.md

@@ -0,0 +1,83 @@
+# generator-joplin
+
+Scaffolds out a new Joplin plugin
+
+## Installation
+
+First, install [Yeoman](http://yeoman.io) and generator-joplin using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).
+
+```bash
+npm install -g yo
+npm install -g generator-joplin
+```
+
+Then generate your new project:
+
+```bash
+yo joplin
+```
+
+## Development
+
+To test the generator for development purposes, follow the instructions there: https://yeoman.io/authoring/#running-the-generator
+This is a template to create a new Joplin plugin.
+
+## Structure
+
+The main two files you will want to look at are:
+
+- `/src/index.ts`, which contains the entry point for the plugin source code.
+- `/src/manifest.json`, which is the plugin manifest. It contains information such as the plugin a name, version, etc.
+
+## Building the plugin
+
+The plugin is built using Webpack, which creates the compiled code in `/dist`. A JPL archive will also be created at the root, which can use to distribute the plugin.
+
+To build the plugin, simply run `npm run dist`.
+
+The project is setup to use TypeScript, although you can change the configuration to use plain JavaScript.
+
+## Updating the plugin framework
+
+To update the plugin framework, run `yo joplin --update`
+
+Keep in mind that doing so will overwrite all the framework-related files **outside of the "src/" directory** (your source code will not be touched). So if you have modified any of the framework-related files, such as package.json or .gitignore, make sure your code is under version control so that you can check the diff and re-apply your changes.
+
+For that reason, it's generally best not to change any of the framework files or to do so in a way that minimises the number of changes. For example, if you want to modify the Webpack config, create a new separate JavaScript file and include it in webpack.config.js. That way, when you update, you only have to restore the line that include your file.
+
+## Content scripts
+
+A plugin that uses [content scripts](https://joplinapp.org/api/references/plugin_api/classes/joplinplugins.html#registercontentscript) must declare them under the `content_scripts` key of [manifest.json](https://joplinapp.org/api/references/plugin_manifest/).
+
+Each entry must be a path **relative to /src**, and **without extension**. The extension should not be included because it might change once the script is compiled. Each of these scripts will then be compiled to JavaScript and packaged into the plugin file. The content script files can be TypeScript (.ts or .tsx) or JavaScript.
+
+For example, assuming these files:
+
+```bash
+/src
+    index.ts                # Main plugin script
+    myContentScript.js      # One content script (JS)
+    otherContentScript.ts   # Another content script (TypeScript)
+    vendor/
+        test.ts             # Sub-directories are also supported
+```
+
+The `manifest.json` file would be:
+
+```json
+{
+    "manifest_version": 1,
+    "name": "Testing Content Scripts",
+    content_scripts: [
+        "myContentScript",
+        "otherContentScript",
+        "vendor/test"
+    ]
+}
+```
+
+Note in particular how the file path is relative to /src and the extensions removed.
+
+## License
+
+MIT © Laurent Cozic

packages/app-cli/tests/support/plugins/codemirror_content_script/api/JoplinPlugins.d.ts

@@ -20,17 +20,21 @@ export default class JoplinPlugins {
      */
     register(script: Script): Promise<void>;
     /**
-     * Registers a new content script. Unlike regular plugin code, which
-     * runs in a separate process, content scripts run within the main
-     * process code and thus allow improved performances and more
-     * customisations in specific cases. It can be used for example to load
-     * a Markdown or editor plugin.
+     * Registers a new content script. Unlike regular plugin code, which runs in
+     * a separate process, content scripts run within the main process code and
+     * thus allow improved performances and more customisations in specific
+     * cases. It can be used for example to load a Markdown or editor plugin.
      *
-     * Note that registering a content script in itself will do nothing -
-     * it will only be loaded in specific cases by the relevant app modules
-     * (eg. the Markdown renderer or the code editor). So it is not a way
-     * to inject and run arbitrary code in the app, which for safety and
-     * performance reasons is not supported.
+     * Note that registering a content script in itself will do nothing - it
+     * will only be loaded in specific cases by the relevant app modules (eg.
+     * the Markdown renderer or the code editor). So it is not a way to inject
+     * and run arbitrary code in the app, which for safety and performance
+     * reasons is not supported.
+     *
+     * The plugin generator provides a way to build any content script you might
+     * want to package as well as its dependencies. See the [Plugin Generator
+     * doc](https://github.com/laurent22/joplin/blob/dev/packages/generator-joplin/README.md)
+     * for more information.
      *
      * * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script)
      * * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script)

packages/app-cli/tests/support/plugins/codemirror_content_script/api/JoplinViewsDialogs.d.ts

@@ -47,6 +47,10 @@ export default class JoplinViewsDialogs {
      * Sets the dialog HTML content
      */
     setHtml(handle: ViewHandle, html: string): Promise<string>;
+    /**
+     * Adds and loads a new JS or CSS files into the dialog.
+     */
+    addScript(handle: ViewHandle, scriptPath: string): Promise<void>;
     /**
      * Sets the dialog buttons.
      */

packages/app-cli/tests/support/plugins/codemirror_content_script/api/JoplinViewsPanels.d.ts

@@ -30,4 +30,16 @@ export default class JoplinViewsPanels {
      * Called when a message is sent from the webview (using postMessage).
      */
     onMessage(handle: ViewHandle, callback: Function): Promise<void>;
+    /**
+     * Shows the panel
+     */
+    show(handle: ViewHandle, show?: boolean): Promise<void>;
+    /**
+     * Hides the panel
+     */
+    hide(handle: ViewHandle): Promise<void>;
+    /**
+     * Tells whether the panel is visible or not
+     */
+    visible(handle: ViewHandle): Promise<boolean>;
 }

packages/app-cli/tests/support/plugins/codemirror_content_script/api/types.ts

@@ -208,7 +208,7 @@ export enum MenuItemLocation {
 	Note = 'note',
 	Tools = 'tools',
 	Help = 'help',
-	
+
 	/**
 	 * @deprecated Do not use - same as NoteListContextMenu
 	 */
@@ -223,7 +223,7 @@ export enum MenuItemLocation {
 	 * - `noteIds:string[]`: IDs of the notes that were right-clicked on.
 	 */
 	NoteListContextMenu = 'noteListContextMenu',
-	
+
 	EditorContextMenu = 'editorContextMenu',
 
 	/**
@@ -243,7 +243,7 @@ export enum MenuItemLocation {
 	TagContextMenu = 'tagContextMenu',
 }
 
-export function isContextMenuItemLocation(location:MenuItemLocation):boolean {
+export function isContextMenuItemLocation(location: MenuItemLocation): boolean {
 	return [
 		MenuItemLocation.Context,
 		MenuItemLocation.NoteListContextMenu,

packages/app-cli/tests/support/plugins/codemirror_content_script/webpack.config.js

@@ -39,17 +39,17 @@ function createPluginArchive(sourceDir, destPath) {
 	console.info(`Plugin archive has been created in ${destPath}`);
 }
 
-const distDir = path.resolve(__dirname, 'dist');
-const srcDir = path.resolve(__dirname, 'src');
+const rootDir = path.resolve(__dirname);
+const distDir = path.resolve(rootDir, 'dist');
+const srcDir = path.resolve(rootDir, 'src');
 const manifestPath = `${srcDir}/manifest.json`;
 const manifest = readManifest(manifestPath);
 const archiveFilePath = path.resolve(__dirname, `${manifest.id}.jpl`);
 
 fs.removeSync(distDir);
 
-module.exports = {
+const baseConfig = {
 	mode: 'production',
-	entry: './src/index.ts',
 	target: 'node',
 	module: {
 		rules: [
@@ -60,6 +60,10 @@ module.exports = {
 			},
 		],
 	},
+};
+
+const pluginConfig = Object.assign({}, baseConfig, {
+	entry: './src/index.ts',
 	resolve: {
 		alias: {
 			api: path.resolve(__dirname, 'api'),
@@ -70,6 +74,9 @@ module.exports = {
 		filename: 'index.js',
 		path: distDir,
 	},
+});
+
+const lastStepConfig = {
 	plugins: [
 		new CopyPlugin({
 			patterns: [
@@ -79,8 +86,17 @@ module.exports = {
 					to: path.resolve(__dirname, 'dist'),
 					globOptions: {
 						ignore: [
+							// All TypeScript files are compiled to JS and
+							// already copied into /dist so we don't copy them.
 							'**/*.ts',
 							'**/*.tsx',
+
+							// Currently we don't support JS files for the main
+							// plugin script. We support it for content scripts,
+							// but theyr should be declared in manifest.json,
+							// and then they are also compiled and copied to
+							// /dist. So wse also don't need to copy JS files.
+							'**/*.js',
 						],
 					},
 				},
@@ -91,3 +107,62 @@ module.exports = {
 		}),
 	],
 };
+
+const contentScriptConfig = Object.assign({}, baseConfig, {
+	resolve: {
+		alias: {
+			api: path.resolve(__dirname, 'api'),
+		},
+		extensions: ['.tsx', '.ts', '.js'],
+	},
+});
+
+function resolveContentScriptPaths(name) {
+	if (['.js', '.ts', '.tsx'].includes(path.extname(name).toLowerCase())) {
+		throw new Error(`Content script path must not include file extension: ${name}`);
+	}
+
+	const pathsToTry = [
+		`./src/${name}.ts`,
+		`${'./src/' + '/'}${name}.js`,
+	];
+
+	for (const pathToTry of pathsToTry) {
+		if (fs.pathExistsSync(`${rootDir}/${pathToTry}`)) {
+			return {
+				entry: pathToTry,
+				output: {
+					filename: `${name}.js`,
+					path: distDir,
+					library: 'default',
+					libraryTarget: 'commonjs',
+					libraryExport: 'default',
+				},
+			};
+		}
+	}
+
+	throw new Error(`Could not find content script "${name}" at locations ${JSON.stringify(pathsToTry)}`);
+}
+
+function createContentScriptConfigs() {
+	if (!manifest.content_scripts) return [];
+
+	const output = [];
+
+	for (const contentScriptName of manifest.content_scripts) {
+		const scriptPaths = resolveContentScriptPaths(contentScriptName);
+		output.push(Object.assign({}, contentScriptConfig, {
+			entry: scriptPaths.entry,
+			output: scriptPaths.output,
+		}));
+	}
+
+	return output;
+}
+
+const exportedConfigs = [pluginConfig].concat(createContentScriptConfigs());
+
+exportedConfigs[exportedConfigs.length - 1] = Object.assign({}, exportedConfigs[exportedConfigs.length - 1], lastStepConfig);
+
+module.exports = exportedConfigs;

packages/app-cli/tests/support/plugins/content_script/GENERATOR_DOC.md

@@ -0,0 +1,83 @@
+# generator-joplin
+
+Scaffolds out a new Joplin plugin
+
+## Installation
+
+First, install [Yeoman](http://yeoman.io) and generator-joplin using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).
+
+```bash
+npm install -g yo
+npm install -g generator-joplin
+```
+
+Then generate your new project:
+
+```bash
+yo joplin
+```
+
+## Development
+
+To test the generator for development purposes, follow the instructions there: https://yeoman.io/authoring/#running-the-generator
+This is a template to create a new Joplin plugin.
+
+## Structure
+
+The main two files you will want to look at are:
+
+- `/src/index.ts`, which contains the entry point for the plugin source code.
+- `/src/manifest.json`, which is the plugin manifest. It contains information such as the plugin a name, version, etc.
+
+## Building the plugin
+
+The plugin is built using Webpack, which creates the compiled code in `/dist`. A JPL archive will also be created at the root, which can use to distribute the plugin.
+
+To build the plugin, simply run `npm run dist`.
+
+The project is setup to use TypeScript, although you can change the configuration to use plain JavaScript.
+
+## Updating the plugin framework
+
+To update the plugin framework, run `yo joplin --update`
+
+Keep in mind that doing so will overwrite all the framework-related files **outside of the "src/" directory** (your source code will not be touched). So if you have modified any of the framework-related files, such as package.json or .gitignore, make sure your code is under version control so that you can check the diff and re-apply your changes.
+
+For that reason, it's generally best not to change any of the framework files or to do so in a way that minimises the number of changes. For example, if you want to modify the Webpack config, create a new separate JavaScript file and include it in webpack.config.js. That way, when you update, you only have to restore the line that include your file.
+
+## Content scripts
+
+A plugin that uses [content scripts](https://joplinapp.org/api/references/plugin_api/classes/joplinplugins.html#registercontentscript) must declare them under the `content_scripts` key of [manifest.json](https://joplinapp.org/api/references/plugin_manifest/).
+
+Each entry must be a path **relative to /src**, and **without extension**. The extension should not be included because it might change once the script is compiled. Each of these scripts will then be compiled to JavaScript and packaged into the plugin file. The content script files can be TypeScript (.ts or .tsx) or JavaScript.
+
+For example, assuming these files:
+
+```bash
+/src
+    index.ts                # Main plugin script
+    myContentScript.js      # One content script (JS)
+    otherContentScript.ts   # Another content script (TypeScript)
+    vendor/
+        test.ts             # Sub-directories are also supported
+```
+
+The `manifest.json` file would be:
+
+```json
+{
+    "manifest_version": 1,
+    "name": "Testing Content Scripts",
+    content_scripts: [
+        "myContentScript",
+        "otherContentScript",
+        "vendor/test"
+    ]
+}
+```
+
+Note in particular how the file path is relative to /src and the extensions removed.
+
+## License
+
+MIT © Laurent Cozic

packages/app-cli/tests/support/plugins/content_script/api/JoplinPlugins.d.ts

@@ -20,17 +20,21 @@ export default class JoplinPlugins {
      */
     register(script: Script): Promise<void>;
     /**
-     * Registers a new content script. Unlike regular plugin code, which
-     * runs in a separate process, content scripts run within the main
-     * process code and thus allow improved performances and more
-     * customisations in specific cases. It can be used for example to load
-     * a Markdown or editor plugin.
+     * Registers a new content script. Unlike regular plugin code, which runs in
+     * a separate process, content scripts run within the main process code and
+     * thus allow improved performances and more customisations in specific
+     * cases. It can be used for example to load a Markdown or editor plugin.
      *
-     * Note that registering a content script in itself will do nothing -
-     * it will only be loaded in specific cases by the relevant app modules
-     * (eg. the Markdown renderer or the code editor). So it is not a way
-     * to inject and run arbitrary code in the app, which for safety and
-     * performance reasons is not supported.
+     * Note that registering a content script in itself will do nothing - it
+     * will only be loaded in specific cases by the relevant app modules (eg.
+     * the Markdown renderer or the code editor). So it is not a way to inject
+     * and run arbitrary code in the app, which for safety and performance
+     * reasons is not supported.
+     *
+     * The plugin generator provides a way to build any content script you might
+     * want to package as well as its dependencies. See the [Plugin Generator
+     * doc](https://github.com/laurent22/joplin/blob/dev/packages/generator-joplin/README.md)
+     * for more information.
      *
      * * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script)
      * * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script)

packages/app-cli/tests/support/plugins/content_script/api/JoplinViewsDialogs.d.ts

@@ -47,6 +47,10 @@ export default class JoplinViewsDialogs {
      * Sets the dialog HTML content
      */
     setHtml(handle: ViewHandle, html: string): Promise<string>;
+    /**
+     * Adds and loads a new JS or CSS files into the dialog.
+     */
+    addScript(handle: ViewHandle, scriptPath: string): Promise<void>;
     /**
      * Sets the dialog buttons.
      */

packages/app-cli/tests/support/plugins/content_script/api/JoplinViewsPanels.d.ts

@@ -30,4 +30,16 @@ export default class JoplinViewsPanels {
      * Called when a message is sent from the webview (using postMessage).
      */
     onMessage(handle: ViewHandle, callback: Function): Promise<void>;
+    /**
+     * Shows the panel
+     */
+    show(handle: ViewHandle, show?: boolean): Promise<void>;
+    /**
+     * Hides the panel
+     */
+    hide(handle: ViewHandle): Promise<void>;
+    /**
+     * Tells whether the panel is visible or not
+     */
+    visible(handle: ViewHandle): Promise<boolean>;
 }

packages/app-cli/tests/support/plugins/content_script/api/types.ts

@@ -208,7 +208,7 @@ export enum MenuItemLocation {
 	Note = 'note',
 	Tools = 'tools',
 	Help = 'help',
-	
+
 	/**
 	 * @deprecated Do not use - same as NoteListContextMenu
 	 */
@@ -223,7 +223,7 @@ export enum MenuItemLocation {
 	 * - `noteIds:string[]`: IDs of the notes that were right-clicked on.
 	 */
 	NoteListContextMenu = 'noteListContextMenu',
-	
+
 	EditorContextMenu = 'editorContextMenu',
 
 	/**
@@ -243,7 +243,7 @@ export enum MenuItemLocation {
 	TagContextMenu = 'tagContextMenu',
 }
 
-export function isContextMenuItemLocation(location:MenuItemLocation):boolean {
+export function isContextMenuItemLocation(location: MenuItemLocation): boolean {
 	return [
 		MenuItemLocation.Context,
 		MenuItemLocation.NoteListContextMenu,

packages/app-cli/tests/support/plugins/content_script/package-lock.json

@@ -492,6 +492,16 @@
       "dev": true,
       "optional": true
     },
+    "bindings": {
+      "version": "1.5.0",
+      "resolved": "https://registry.npmjs.org/bindings/-/bindings-1.5.0.tgz",
+      "integrity": "sha512-p2q/t/mhvuOj/UeLlV6566GD/guowlr0hHxClI0W9m7MWYkL1F0hLo+0Aexs9HSPCtR1SXQ0TD3MMKrXZajbiQ==",
+      "dev": true,
+      "optional": true,
+      "requires": {
+        "file-uri-to-path": "1.0.0"
+      }
+    },
     "bluebird": {
       "version": "3.7.2",
       "resolved": "https://registry.npmjs.org/bluebird/-/bluebird-3.7.2.tgz",
@@ -1436,6 +1446,13 @@
       "integrity": "sha512-0btnI/H8f2pavGMN8w40mlSKOfTK2SVJmBfBeVIj3kNw0swwgzyRq0d5TJVOwodFmtvpPeWPN/MCcfuWF0Ezbw==",
       "dev": true
     },
+    "file-uri-to-path": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/file-uri-to-path/-/file-uri-to-path-1.0.0.tgz",
+      "integrity": "sha512-0Zt+s3L7Vf1biwWZ29aARiVYLx7iMGnEUl9x33fbB/j3jR81u/O2LbqK+Bm1CDSNDKVtJ/YjwY7TUd5SkeLQLw==",
+      "dev": true,
+      "optional": true
+    },
     "fill-range": {
       "version": "7.0.1",
       "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz",
@@ -2192,6 +2209,11 @@
       "integrity": "sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw==",
       "dev": true
     },
+    "left-pad": {
+      "version": "1.3.0",
+      "resolved": "https://registry.npmjs.org/left-pad/-/left-pad-1.3.0.tgz",
+      "integrity": "sha512-XI5MPzVNApjAyhQzphX8BkmKsKUxD4LdyK24iZeQGinBN9yTQT3bFlCBy/aVx2HrNcqQGsdot8ghrjyrvMCoEA=="
+    },
     "loader-runner": {
       "version": "2.4.0",
       "resolved": "https://registry.npmjs.org/loader-runner/-/loader-runner-2.4.0.tgz",
@@ -2464,6 +2486,13 @@
       "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=",
       "dev": true
     },
+    "nan": {
+      "version": "2.14.2",
+      "resolved": "https://registry.npmjs.org/nan/-/nan-2.14.2.tgz",
+      "integrity": "sha512-M2ufzIiINKCuDfBSAUr1vWQ+vuVcA9kqx8JJUsbQi6yf1uGRyb7HfpdfUr5qLXf3B/t8dPvcjhKMmlfnP47EzQ==",
+      "dev": true,
+      "optional": true
+    },
     "nanomatch": {
       "version": "1.2.13",
       "resolved": "https://registry.npmjs.org/nanomatch/-/nanomatch-1.2.13.tgz",
@@ -4086,7 +4115,11 @@
           "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-1.2.13.tgz",
           "integrity": "sha512-oWb1Z6mkHIskLzEJ/XWX0srkpkTQ7vaopMQkyaEIoq0fmtFVxOthb8cCxeT+p3ynTdkk/RZwbgG4brR5BeWECw==",
           "dev": true,
-          "optional": true
+          "optional": true,
+          "requires": {
+            "bindings": "^1.5.0",
+            "nan": "^2.12.1"
+          }
         },
         "glob-parent": {
           "version": "3.1.0",

packages/app-cli/tests/support/plugins/content_script/package.json

@@ -19,5 +19,8 @@
     "typescript": "^3.9.3",
     "webpack": "^4.43.0",
     "webpack-cli": "^3.3.11"
+  },
+  "dependencies": {
+    "left-pad": "^1.3.0"
   }
 }

packages/app-cli/tests/support/plugins/content_script/src/manifest.json

@@ -6,5 +6,8 @@
 	"description": "",
 	"version": "1.0.0",
 	"author": "",
-	"homepage_url": ""
+	"homepage_url": "",
+	"content_scripts": [
+		"markdownItTestPlugin"
+	]
 }

packages/app-cli/tests/support/plugins/content_script/src/markdownItTestPlugin.ts

@@ -1,3 +1,5 @@
+const leftPad = require('left-pad');
+
 function plugin(markdownIt, _options) {
 	const defaultRender = markdownIt.renderer.rules.fence || function(tokens, idx, options, env, self) {
 		return self.renderToken(tokens, idx, options, env, self);
@@ -8,7 +10,7 @@ function plugin(markdownIt, _options) {
 		if (token.info !== 'justtesting') return defaultRender(tokens, idx, options, env, self);
 		return `
 			<div class="just-testing">
-				<p>JUST TESTING: ${token.content}</p>
+				<p>JUST TESTING: <pre>${leftPad(token.content.trim(), 10, 'x')}</pre></p>
 				<p><a href="#" onclick="webviewApi.executeCommand('testCommand', 'one', 'two'); return false;">Click to send "testCommand" to plugin</a></p>
 				<p><a href="#" onclick="webviewApi.executeCommand('testCommandNoArgs'); return false;">Click to send "testCommandNoArgs" to plugin</a></p>
 			</div>
@@ -16,15 +18,13 @@ function plugin(markdownIt, _options) {
 	};
 }
 
-module.exports = {
-	default: function(_context) { 
-		return {
-			plugin: plugin,
-			assets: function() {
-				return [
-					{ name: 'markdownItTestPlugin.css' }
-				];
-			},
-		}
-	},
+export default function(_context) { 
+	return {
+		plugin: plugin,
+		assets: function() {
+			return [
+				{ name: 'markdownItTestPlugin.css' }
+			];
+		},
+	}
 }

packages/app-cli/tests/support/plugins/content_script/webpack.config.js

@@ -39,17 +39,17 @@ function createPluginArchive(sourceDir, destPath) {
 	console.info(`Plugin archive has been created in ${destPath}`);
 }
 
-const distDir = path.resolve(__dirname, 'dist');
-const srcDir = path.resolve(__dirname, 'src');
+const rootDir = path.resolve(__dirname);
+const distDir = path.resolve(rootDir, 'dist');
+const srcDir = path.resolve(rootDir, 'src');
 const manifestPath = `${srcDir}/manifest.json`;
 const manifest = readManifest(manifestPath);
 const archiveFilePath = path.resolve(__dirname, `${manifest.id}.jpl`);
 
 fs.removeSync(distDir);
 
-module.exports = {
+const baseConfig = {
 	mode: 'production',
-	entry: './src/index.ts',
 	target: 'node',
 	module: {
 		rules: [
@@ -60,6 +60,10 @@ module.exports = {
 			},
 		],
 	},
+};
+
+const pluginConfig = Object.assign({}, baseConfig, {
+	entry: './src/index.ts',
 	resolve: {
 		alias: {
 			api: path.resolve(__dirname, 'api'),
@@ -70,6 +74,9 @@ module.exports = {
 		filename: 'index.js',
 		path: distDir,
 	},
+});
+
+const lastStepConfig = {
 	plugins: [
 		new CopyPlugin({
 			patterns: [
@@ -79,8 +86,17 @@ module.exports = {
 					to: path.resolve(__dirname, 'dist'),
 					globOptions: {
 						ignore: [
+							// All TypeScript files are compiled to JS and
+							// already copied into /dist so we don't copy them.
 							'**/*.ts',
 							'**/*.tsx',
+
+							// Currently we don't support JS files for the main
+							// plugin script. We support it for content scripts,
+							// but theyr should be declared in manifest.json,
+							// and then they are also compiled and copied to
+							// /dist. So wse also don't need to copy JS files.
+							'**/*.js',
 						],
 					},
 				},
@@ -91,3 +107,62 @@ module.exports = {
 		}),
 	],
 };
+
+const contentScriptConfig = Object.assign({}, baseConfig, {
+	resolve: {
+		alias: {
+			api: path.resolve(__dirname, 'api'),
+		},
+		extensions: ['.tsx', '.ts', '.js'],
+	},
+});
+
+function resolveContentScriptPaths(name) {
+	if (['.js', '.ts', '.tsx'].includes(path.extname(name).toLowerCase())) {
+		throw new Error(`Content script path must not include file extension: ${name}`);
+	}
+
+	const pathsToTry = [
+		`./src/${name}.ts`,
+		`${'./src/' + '/'}${name}.js`,
+	];
+
+	for (const pathToTry of pathsToTry) {
+		if (fs.pathExistsSync(`${rootDir}/${pathToTry}`)) {
+			return {
+				entry: pathToTry,
+				output: {
+					filename: `${name}.js`,
+					path: distDir,
+					library: 'default',
+					libraryTarget: 'commonjs',
+					libraryExport: 'default',
+				},
+			};
+		}
+	}
+
+	throw new Error(`Could not find content script "${name}" at locations ${JSON.stringify(pathsToTry)}`);
+}
+
+function createContentScriptConfigs() {
+	if (!manifest.content_scripts) return [];
+
+	const output = [];
+
+	for (const contentScriptName of manifest.content_scripts) {
+		const scriptPaths = resolveContentScriptPaths(contentScriptName);
+		output.push(Object.assign({}, contentScriptConfig, {
+			entry: scriptPaths.entry,
+			output: scriptPaths.output,
+		}));
+	}
+
+	return output;
+}
+
+const exportedConfigs = [pluginConfig].concat(createContentScriptConfigs());
+
+exportedConfigs[exportedConfigs.length - 1] = Object.assign({}, exportedConfigs[exportedConfigs.length - 1], lastStepConfig);
+
+module.exports = exportedConfigs;

packages/app-cli/tests/support/plugins/dialog/GENERATOR_DOC.md

@@ -0,0 +1,83 @@
+# generator-joplin
+
+Scaffolds out a new Joplin plugin
+
+## Installation
+
+First, install [Yeoman](http://yeoman.io) and generator-joplin using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).
+
+```bash
+npm install -g yo
+npm install -g generator-joplin
+```
+
+Then generate your new project:
+
+```bash
+yo joplin
+```
+
+## Development
+
+To test the generator for development purposes, follow the instructions there: https://yeoman.io/authoring/#running-the-generator
+This is a template to create a new Joplin plugin.
+
+## Structure
+
+The main two files you will want to look at are:
+
+- `/src/index.ts`, which contains the entry point for the plugin source code.
+- `/src/manifest.json`, which is the plugin manifest. It contains information such as the plugin a name, version, etc.
+
+## Building the plugin
+
+The plugin is built using Webpack, which creates the compiled code in `/dist`. A JPL archive will also be created at the root, which can use to distribute the plugin.
+
+To build the plugin, simply run `npm run dist`.
+
+The project is setup to use TypeScript, although you can change the configuration to use plain JavaScript.
+
+## Updating the plugin framework
+
+To update the plugin framework, run `yo joplin --update`
+
+Keep in mind that doing so will overwrite all the framework-related files **outside of the "src/" directory** (your source code will not be touched). So if you have modified any of the framework-related files, such as package.json or .gitignore, make sure your code is under version control so that you can check the diff and re-apply your changes.
+
+For that reason, it's generally best not to change any of the framework files or to do so in a way that minimises the number of changes. For example, if you want to modify the Webpack config, create a new separate JavaScript file and include it in webpack.config.js. That way, when you update, you only have to restore the line that include your file.
+
+## Content scripts
+
+A plugin that uses [content scripts](https://joplinapp.org/api/references/plugin_api/classes/joplinplugins.html#registercontentscript) must declare them under the `content_scripts` key of [manifest.json](https://joplinapp.org/api/references/plugin_manifest/).
+
+Each entry must be a path **relative to /src**, and **without extension**. The extension should not be included because it might change once the script is compiled. Each of these scripts will then be compiled to JavaScript and packaged into the plugin file. The content script files can be TypeScript (.ts or .tsx) or JavaScript.
+
+For example, assuming these files:
+
+```bash
+/src
+    index.ts                # Main plugin script
+    myContentScript.js      # One content script (JS)
+    otherContentScript.ts   # Another content script (TypeScript)
+    vendor/
+        test.ts             # Sub-directories are also supported
+```
+
+The `manifest.json` file would be:
+
+```json
+{
+    "manifest_version": 1,
+    "name": "Testing Content Scripts",
+    content_scripts: [
+        "myContentScript",
+        "otherContentScript",
+        "vendor/test"
+    ]
+}
+```
+
+Note in particular how the file path is relative to /src and the extensions removed.
+
+## License
+
+MIT © Laurent Cozic

packages/app-cli/tests/support/plugins/dialog/api/JoplinPlugins.d.ts

@@ -20,17 +20,21 @@ export default class JoplinPlugins {
      */
     register(script: Script): Promise<void>;
     /**
-     * Registers a new content script. Unlike regular plugin code, which
-     * runs in a separate process, content scripts run within the main
-     * process code and thus allow improved performances and more
-     * customisations in specific cases. It can be used for example to load
-     * a Markdown or editor plugin.
+     * Registers a new content script. Unlike regular plugin code, which runs in
+     * a separate process, content scripts run within the main process code and
+     * thus allow improved performances and more customisations in specific
+     * cases. It can be used for example to load a Markdown or editor plugin.
      *
-     * Note that registering a content script in itself will do nothing -
-     * it will only be loaded in specific cases by the relevant app modules
-     * (eg. the Markdown renderer or the code editor). So it is not a way
-     * to inject and run arbitrary code in the app, which for safety and
-     * performance reasons is not supported.
+     * Note that registering a content script in itself will do nothing - it
+     * will only be loaded in specific cases by the relevant app modules (eg.
+     * the Markdown renderer or the code editor). So it is not a way to inject
+     * and run arbitrary code in the app, which for safety and performance
+     * reasons is not supported.
+     *
+     * The plugin generator provides a way to build any content script you might
+     * want to package as well as its dependencies. See the [Plugin Generator
+     * doc](https://github.com/laurent22/joplin/blob/dev/packages/generator-joplin/README.md)
+     * for more information.
      *
      * * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script)
      * * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script)

packages/app-cli/tests/support/plugins/dialog/api/JoplinViewsDialogs.d.ts

@@ -47,6 +47,10 @@ export default class JoplinViewsDialogs {
      * Sets the dialog HTML content
      */
     setHtml(handle: ViewHandle, html: string): Promise<string>;
+    /**
+     * Adds and loads a new JS or CSS files into the dialog.
+     */
+    addScript(handle: ViewHandle, scriptPath: string): Promise<void>;
     /**
      * Sets the dialog buttons.
      */

packages/app-cli/tests/support/plugins/dialog/api/JoplinViewsPanels.d.ts

@@ -30,4 +30,16 @@ export default class JoplinViewsPanels {
      * Called when a message is sent from the webview (using postMessage).
      */
     onMessage(handle: ViewHandle, callback: Function): Promise<void>;
+    /**
+     * Shows the panel
+     */
+    show(handle: ViewHandle, show?: boolean): Promise<void>;
+    /**
+     * Hides the panel
+     */
+    hide(handle: ViewHandle): Promise<void>;
+    /**
+     * Tells whether the panel is visible or not
+     */
+    visible(handle: ViewHandle): Promise<boolean>;
 }

packages/app-cli/tests/support/plugins/dialog/api/types.ts

@@ -208,7 +208,7 @@ export enum MenuItemLocation {
 	Note = 'note',
 	Tools = 'tools',
 	Help = 'help',
-	
+
 	/**
 	 * @deprecated Do not use - same as NoteListContextMenu
 	 */
@@ -223,7 +223,7 @@ export enum MenuItemLocation {
 	 * - `noteIds:string[]`: IDs of the notes that were right-clicked on.
 	 */
 	NoteListContextMenu = 'noteListContextMenu',
-	
+
 	EditorContextMenu = 'editorContextMenu',
 
 	/**
@@ -243,7 +243,7 @@ export enum MenuItemLocation {
 	TagContextMenu = 'tagContextMenu',
 }
 
-export function isContextMenuItemLocation(location:MenuItemLocation):boolean {
+export function isContextMenuItemLocation(location: MenuItemLocation): boolean {
 	return [
 		MenuItemLocation.Context,
 		MenuItemLocation.NoteListContextMenu,

packages/app-cli/tests/support/plugins/dialog/webpack.config.js

@@ -39,17 +39,17 @@ function createPluginArchive(sourceDir, destPath) {
 	console.info(`Plugin archive has been created in ${destPath}`);
 }
 
-const distDir = path.resolve(__dirname, 'dist');
-const srcDir = path.resolve(__dirname, 'src');
+const rootDir = path.resolve(__dirname);
+const distDir = path.resolve(rootDir, 'dist');
+const srcDir = path.resolve(rootDir, 'src');
 const manifestPath = `${srcDir}/manifest.json`;
 const manifest = readManifest(manifestPath);
 const archiveFilePath = path.resolve(__dirname, `${manifest.id}.jpl`);
 
 fs.removeSync(distDir);
 
-module.exports = {
+const baseConfig = {
 	mode: 'production',
-	entry: './src/index.ts',
 	target: 'node',
 	module: {
 		rules: [
@@ -60,6 +60,10 @@ module.exports = {
 			},
 		],
 	},
+};
+
+const pluginConfig = Object.assign({}, baseConfig, {
+	entry: './src/index.ts',
 	resolve: {
 		alias: {
 			api: path.resolve(__dirname, 'api'),
@@ -70,6 +74,9 @@ module.exports = {
 		filename: 'index.js',
 		path: distDir,
 	},
+});
+
+const lastStepConfig = {
 	plugins: [
 		new CopyPlugin({
 			patterns: [
@@ -79,8 +86,17 @@ module.exports = {
 					to: path.resolve(__dirname, 'dist'),
 					globOptions: {
 						ignore: [
+							// All TypeScript files are compiled to JS and
+							// already copied into /dist so we don't copy them.
 							'**/*.ts',
 							'**/*.tsx',
+
+							// Currently we don't support JS files for the main
+							// plugin script. We support it for content scripts,
+							// but theyr should be declared in manifest.json,
+							// and then they are also compiled and copied to
+							// /dist. So wse also don't need to copy JS files.
+							'**/*.js',
 						],
 					},
 				},
@@ -91,3 +107,62 @@ module.exports = {
 		}),
 	],
 };
+
+const contentScriptConfig = Object.assign({}, baseConfig, {
+	resolve: {
+		alias: {
+			api: path.resolve(__dirname, 'api'),
+		},
+		extensions: ['.tsx', '.ts', '.js'],
+	},
+});
+
+function resolveContentScriptPaths(name) {
+	if (['.js', '.ts', '.tsx'].includes(path.extname(name).toLowerCase())) {
+		throw new Error(`Content script path must not include file extension: ${name}`);
+	}
+
+	const pathsToTry = [
+		`./src/${name}.ts`,
+		`${'./src/' + '/'}${name}.js`,
+	];
+
+	for (const pathToTry of pathsToTry) {
+		if (fs.pathExistsSync(`${rootDir}/${pathToTry}`)) {
+			return {
+				entry: pathToTry,
+				output: {
+					filename: `${name}.js`,
+					path: distDir,
+					library: 'default',
+					libraryTarget: 'commonjs',
+					libraryExport: 'default',
+				},
+			};
+		}
+	}
+
+	throw new Error(`Could not find content script "${name}" at locations ${JSON.stringify(pathsToTry)}`);
+}
+
+function createContentScriptConfigs() {
+	if (!manifest.content_scripts) return [];
+
+	const output = [];
+
+	for (const contentScriptName of manifest.content_scripts) {
+		const scriptPaths = resolveContentScriptPaths(contentScriptName);
+		output.push(Object.assign({}, contentScriptConfig, {
+			entry: scriptPaths.entry,
+			output: scriptPaths.output,
+		}));
+	}
+
+	return output;
+}
+
+const exportedConfigs = [pluginConfig].concat(createContentScriptConfigs());
+
+exportedConfigs[exportedConfigs.length - 1] = Object.assign({}, exportedConfigs[exportedConfigs.length - 1], lastStepConfig);
+
+module.exports = exportedConfigs;

packages/app-cli/tests/support/plugins/editor_context_menu/GENERATOR_DOC.md

@@ -0,0 +1,83 @@
+# generator-joplin
+
+Scaffolds out a new Joplin plugin
+
+## Installation
+
+First, install [Yeoman](http://yeoman.io) and generator-joplin using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).
+
+```bash
+npm install -g yo
+npm install -g generator-joplin
+```
+
+Then generate your new project:
+
+```bash
+yo joplin
+```
+
+## Development
+
+To test the generator for development purposes, follow the instructions there: https://yeoman.io/authoring/#running-the-generator
+This is a template to create a new Joplin plugin.
+
+## Structure
+
+The main two files you will want to look at are:
+
+- `/src/index.ts`, which contains the entry point for the plugin source code.
+- `/src/manifest.json`, which is the plugin manifest. It contains information such as the plugin a name, version, etc.
+
+## Building the plugin
+
+The plugin is built using Webpack, which creates the compiled code in `/dist`. A JPL archive will also be created at the root, which can use to distribute the plugin.
+
+To build the plugin, simply run `npm run dist`.
+
+The project is setup to use TypeScript, although you can change the configuration to use plain JavaScript.
+
+## Updating the plugin framework
+
+To update the plugin framework, run `yo joplin --update`
+
+Keep in mind that doing so will overwrite all the framework-related files **outside of the "src/" directory** (your source code will not be touched). So if you have modified any of the framework-related files, such as package.json or .gitignore, make sure your code is under version control so that you can check the diff and re-apply your changes.
+
+For that reason, it's generally best not to change any of the framework files or to do so in a way that minimises the number of changes. For example, if you want to modify the Webpack config, create a new separate JavaScript file and include it in webpack.config.js. That way, when you update, you only have to restore the line that include your file.
+
+## Content scripts
+
+A plugin that uses [content scripts](https://joplinapp.org/api/references/plugin_api/classes/joplinplugins.html#registercontentscript) must declare them under the `content_scripts` key of [manifest.json](https://joplinapp.org/api/references/plugin_manifest/).
+
+Each entry must be a path **relative to /src**, and **without extension**. The extension should not be included because it might change once the script is compiled. Each of these scripts will then be compiled to JavaScript and packaged into the plugin file. The content script files can be TypeScript (.ts or .tsx) or JavaScript.
+
+For example, assuming these files:
+
+```bash
+/src
+    index.ts                # Main plugin script
+    myContentScript.js      # One content script (JS)
+    otherContentScript.ts   # Another content script (TypeScript)
+    vendor/
+        test.ts             # Sub-directories are also supported
+```
+
+The `manifest.json` file would be:
+
+```json
+{
+    "manifest_version": 1,
+    "name": "Testing Content Scripts",
+    content_scripts: [
+        "myContentScript",
+        "otherContentScript",
+        "vendor/test"
+    ]
+}
+```
+
+Note in particular how the file path is relative to /src and the extensions removed.
+
+## License
+
+MIT © Laurent Cozic

packages/app-cli/tests/support/plugins/editor_context_menu/api/JoplinPlugins.d.ts

@@ -20,17 +20,21 @@ export default class JoplinPlugins {
      */
     register(script: Script): Promise<void>;
     /**
-     * Registers a new content script. Unlike regular plugin code, which
-     * runs in a separate process, content scripts run within the main
-     * process code and thus allow improved performances and more
-     * customisations in specific cases. It can be used for example to load
-     * a Markdown or editor plugin.
+     * Registers a new content script. Unlike regular plugin code, which runs in
+     * a separate process, content scripts run within the main process code and
+     * thus allow improved performances and more customisations in specific
+     * cases. It can be used for example to load a Markdown or editor plugin.
      *
-     * Note that registering a content script in itself will do nothing -
-     * it will only be loaded in specific cases by the relevant app modules
-     * (eg. the Markdown renderer or the code editor). So it is not a way
-     * to inject and run arbitrary code in the app, which for safety and
-     * performance reasons is not supported.
+     * Note that registering a content script in itself will do nothing - it
+     * will only be loaded in specific cases by the relevant app modules (eg.
+     * the Markdown renderer or the code editor). So it is not a way to inject
+     * and run arbitrary code in the app, which for safety and performance
+     * reasons is not supported.
+     *
+     * The plugin generator provides a way to build any content script you might
+     * want to package as well as its dependencies. See the [Plugin Generator
+     * doc](https://github.com/laurent22/joplin/blob/dev/packages/generator-joplin/README.md)
+     * for more information.
      *
      * * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script)
      * * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script)

packages/app-cli/tests/support/plugins/editor_context_menu/api/JoplinViewsDialogs.d.ts

@@ -47,6 +47,10 @@ export default class JoplinViewsDialogs {
      * Sets the dialog HTML content
      */
     setHtml(handle: ViewHandle, html: string): Promise<string>;
+    /**
+     * Adds and loads a new JS or CSS files into the dialog.
+     */
+    addScript(handle: ViewHandle, scriptPath: string): Promise<void>;
     /**
      * Sets the dialog buttons.
      */

packages/app-cli/tests/support/plugins/editor_context_menu/api/JoplinViewsPanels.d.ts

@@ -30,4 +30,16 @@ export default class JoplinViewsPanels {
      * Called when a message is sent from the webview (using postMessage).
      */
     onMessage(handle: ViewHandle, callback: Function): Promise<void>;
+    /**
+     * Shows the panel
+     */
+    show(handle: ViewHandle, show?: boolean): Promise<void>;
+    /**
+     * Hides the panel
+     */
+    hide(handle: ViewHandle): Promise<void>;
+    /**
+     * Tells whether the panel is visible or not
+     */
+    visible(handle: ViewHandle): Promise<boolean>;
 }

packages/app-cli/tests/support/plugins/editor_context_menu/api/types.ts

@@ -208,7 +208,7 @@ export enum MenuItemLocation {
 	Note = 'note',
 	Tools = 'tools',
 	Help = 'help',
-	
+
 	/**
 	 * @deprecated Do not use - same as NoteListContextMenu
 	 */
@@ -223,7 +223,7 @@ export enum MenuItemLocation {
 	 * - `noteIds:string[]`: IDs of the notes that were right-clicked on.
 	 */
 	NoteListContextMenu = 'noteListContextMenu',
-	
+
 	EditorContextMenu = 'editorContextMenu',
 
 	/**
@@ -243,7 +243,7 @@ export enum MenuItemLocation {
 	TagContextMenu = 'tagContextMenu',
 }
 
-export function isContextMenuItemLocation(location:MenuItemLocation):boolean {
+export function isContextMenuItemLocation(location: MenuItemLocation): boolean {
 	return [
 		MenuItemLocation.Context,
 		MenuItemLocation.NoteListContextMenu,

packages/app-cli/tests/support/plugins/editor_context_menu/webpack.config.js

@@ -39,17 +39,17 @@ function createPluginArchive(sourceDir, destPath) {
 	console.info(`Plugin archive has been created in ${destPath}`);
 }
 
-const distDir = path.resolve(__dirname, 'dist');
-const srcDir = path.resolve(__dirname, 'src');
+const rootDir = path.resolve(__dirname);
+const distDir = path.resolve(rootDir, 'dist');
+const srcDir = path.resolve(rootDir, 'src');
 const manifestPath = `${srcDir}/manifest.json`;
 const manifest = readManifest(manifestPath);
 const archiveFilePath = path.resolve(__dirname, `${manifest.id}.jpl`);
 
 fs.removeSync(distDir);
 
-module.exports = {
+const baseConfig = {
 	mode: 'production',
-	entry: './src/index.ts',
 	target: 'node',
 	module: {
 		rules: [
@@ -60,6 +60,10 @@ module.exports = {
 			},
 		],
 	},
+};
+
+const pluginConfig = Object.assign({}, baseConfig, {
+	entry: './src/index.ts',
 	resolve: {
 		alias: {
 			api: path.resolve(__dirname, 'api'),
@@ -70,6 +74,9 @@ module.exports = {
 		filename: 'index.js',
 		path: distDir,
 	},
+});
+
+const lastStepConfig = {
 	plugins: [
 		new CopyPlugin({
 			patterns: [
@@ -79,8 +86,17 @@ module.exports = {
 					to: path.resolve(__dirname, 'dist'),
 					globOptions: {
 						ignore: [
+							// All TypeScript files are compiled to JS and
+							// already copied into /dist so we don't copy them.
 							'**/*.ts',
 							'**/*.tsx',
+
+							// Currently we don't support JS files for the main
+							// plugin script. We support it for content scripts,
+							// but theyr should be declared in manifest.json,
+							// and then they are also compiled and copied to
+							// /dist. So wse also don't need to copy JS files.
+							'**/*.js',
 						],
 					},
 				},
@@ -91,3 +107,62 @@ module.exports = {
 		}),
 	],
 };
+
+const contentScriptConfig = Object.assign({}, baseConfig, {
+	resolve: {
+		alias: {
+			api: path.resolve(__dirname, 'api'),
+		},
+		extensions: ['.tsx', '.ts', '.js'],
+	},
+});
+
+function resolveContentScriptPaths(name) {
+	if (['.js', '.ts', '.tsx'].includes(path.extname(name).toLowerCase())) {
+		throw new Error(`Content script path must not include file extension: ${name}`);
+	}
+
+	const pathsToTry = [
+		`./src/${name}.ts`,
+		`${'./src/' + '/'}${name}.js`,
+	];
+
+	for (const pathToTry of pathsToTry) {
+		if (fs.pathExistsSync(`${rootDir}/${pathToTry}`)) {
+			return {
+				entry: pathToTry,
+				output: {
+					filename: `${name}.js`,
+					path: distDir,
+					library: 'default',
+					libraryTarget: 'commonjs',
+					libraryExport: 'default',
+				},
+			};
+		}
+	}
+
+	throw new Error(`Could not find content script "${name}" at locations ${JSON.stringify(pathsToTry)}`);
+}
+
+function createContentScriptConfigs() {
+	if (!manifest.content_scripts) return [];
+
+	const output = [];
+
+	for (const contentScriptName of manifest.content_scripts) {
+		const scriptPaths = resolveContentScriptPaths(contentScriptName);
+		output.push(Object.assign({}, contentScriptConfig, {
+			entry: scriptPaths.entry,
+			output: scriptPaths.output,
+		}));
+	}
+
+	return output;
+}
+
+const exportedConfigs = [pluginConfig].concat(createContentScriptConfigs());
+
+exportedConfigs[exportedConfigs.length - 1] = Object.assign({}, exportedConfigs[exportedConfigs.length - 1], lastStepConfig);
+
+module.exports = exportedConfigs;

packages/app-cli/tests/support/plugins/events/GENERATOR_DOC.md

@@ -0,0 +1,83 @@
+# generator-joplin
+
+Scaffolds out a new Joplin plugin
+
+## Installation
+
+First, install [Yeoman](http://yeoman.io) and generator-joplin using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).
+
+```bash
+npm install -g yo
+npm install -g generator-joplin
+```
+
+Then generate your new project:
+
+```bash
+yo joplin
+```
+
+## Development
+
+To test the generator for development purposes, follow the instructions there: https://yeoman.io/authoring/#running-the-generator
+This is a template to create a new Joplin plugin.
+
+## Structure
+
+The main two files you will want to look at are:
+
+- `/src/index.ts`, which contains the entry point for the plugin source code.
+- `/src/manifest.json`, which is the plugin manifest. It contains information such as the plugin a name, version, etc.
+
+## Building the plugin
+
+The plugin is built using Webpack, which creates the compiled code in `/dist`. A JPL archive will also be created at the root, which can use to distribute the plugin.
+
+To build the plugin, simply run `npm run dist`.
+
+The project is setup to use TypeScript, although you can change the configuration to use plain JavaScript.
+
+## Updating the plugin framework
+
+To update the plugin framework, run `yo joplin --update`
+
+Keep in mind that doing so will overwrite all the framework-related files **outside of the "src/" directory** (your source code will not be touched). So if you have modified any of the framework-related files, such as package.json or .gitignore, make sure your code is under version control so that you can check the diff and re-apply your changes.
+
+For that reason, it's generally best not to change any of the framework files or to do so in a way that minimises the number of changes. For example, if you want to modify the Webpack config, create a new separate JavaScript file and include it in webpack.config.js. That way, when you update, you only have to restore the line that include your file.
+
+## Content scripts
+
+A plugin that uses [content scripts](https://joplinapp.org/api/references/plugin_api/classes/joplinplugins.html#registercontentscript) must declare them under the `content_scripts` key of [manifest.json](https://joplinapp.org/api/references/plugin_manifest/).
+
+Each entry must be a path **relative to /src**, and **without extension**. The extension should not be included because it might change once the script is compiled. Each of these scripts will then be compiled to JavaScript and packaged into the plugin file. The content script files can be TypeScript (.ts or .tsx) or JavaScript.
+
+For example, assuming these files:
+
+```bash
+/src
+    index.ts                # Main plugin script
+    myContentScript.js      # One content script (JS)
+    otherContentScript.ts   # Another content script (TypeScript)
+    vendor/
+        test.ts             # Sub-directories are also supported
+```
+
+The `manifest.json` file would be:
+
+```json
+{
+    "manifest_version": 1,
+    "name": "Testing Content Scripts",
+    content_scripts: [
+        "myContentScript",
+        "otherContentScript",
+        "vendor/test"
+    ]
+}
+```
+
+Note in particular how the file path is relative to /src and the extensions removed.
+
+## License
+
+MIT © Laurent Cozic

packages/app-cli/tests/support/plugins/events/api/JoplinPlugins.d.ts

@@ -20,17 +20,21 @@ export default class JoplinPlugins {
      */
     register(script: Script): Promise<void>;
     /**
-     * Registers a new content script. Unlike regular plugin code, which
-     * runs in a separate process, content scripts run within the main
-     * process code and thus allow improved performances and more
-     * customisations in specific cases. It can be used for example to load
-     * a Markdown or editor plugin.
+     * Registers a new content script. Unlike regular plugin code, which runs in
+     * a separate process, content scripts run within the main process code and
+     * thus allow improved performances and more customisations in specific
+     * cases. It can be used for example to load a Markdown or editor plugin.
      *
-     * Note that registering a content script in itself will do nothing -
-     * it will only be loaded in specific cases by the relevant app modules
-     * (eg. the Markdown renderer or the code editor). So it is not a way
-     * to inject and run arbitrary code in the app, which for safety and
-     * performance reasons is not supported.
+     * Note that registering a content script in itself will do nothing - it
+     * will only be loaded in specific cases by the relevant app modules (eg.
+     * the Markdown renderer or the code editor). So it is not a way to inject
+     * and run arbitrary code in the app, which for safety and performance
+     * reasons is not supported.
+     *
+     * The plugin generator provides a way to build any content script you might
+     * want to package as well as its dependencies. See the [Plugin Generator
+     * doc](https://github.com/laurent22/joplin/blob/dev/packages/generator-joplin/README.md)
+     * for more information.
      *
      * * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script)
      * * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script)

packages/app-cli/tests/support/plugins/events/api/JoplinViewsDialogs.d.ts

@@ -47,6 +47,10 @@ export default class JoplinViewsDialogs {
      * Sets the dialog HTML content
      */
     setHtml(handle: ViewHandle, html: string): Promise<string>;
+    /**
+     * Adds and loads a new JS or CSS files into the dialog.
+     */
+    addScript(handle: ViewHandle, scriptPath: string): Promise<void>;
     /**
      * Sets the dialog buttons.
      */

packages/app-cli/tests/support/plugins/events/api/JoplinViewsPanels.d.ts

@@ -30,4 +30,16 @@ export default class JoplinViewsPanels {
      * Called when a message is sent from the webview (using postMessage).
      */
     onMessage(handle: ViewHandle, callback: Function): Promise<void>;
+    /**
+     * Shows the panel
+     */
+    show(handle: ViewHandle, show?: boolean): Promise<void>;
+    /**
+     * Hides the panel
+     */
+    hide(handle: ViewHandle): Promise<void>;
+    /**
+     * Tells whether the panel is visible or not
+     */
+    visible(handle: ViewHandle): Promise<boolean>;
 }

packages/app-cli/tests/support/plugins/events/api/types.ts

@@ -208,7 +208,7 @@ export enum MenuItemLocation {
 	Note = 'note',
 	Tools = 'tools',
 	Help = 'help',
-	
+
 	/**
 	 * @deprecated Do not use - same as NoteListContextMenu
 	 */
@@ -223,7 +223,7 @@ export enum MenuItemLocation {
 	 * - `noteIds:string[]`: IDs of the notes that were right-clicked on.
 	 */
 	NoteListContextMenu = 'noteListContextMenu',
-	
+
 	EditorContextMenu = 'editorContextMenu',
 
 	/**
@@ -243,7 +243,7 @@ export enum MenuItemLocation {
 	TagContextMenu = 'tagContextMenu',
 }
 
-export function isContextMenuItemLocation(location:MenuItemLocation):boolean {
+export function isContextMenuItemLocation(location: MenuItemLocation): boolean {
 	return [
 		MenuItemLocation.Context,
 		MenuItemLocation.NoteListContextMenu,

packages/app-cli/tests/support/plugins/events/webpack.config.js

@@ -39,17 +39,17 @@ function createPluginArchive(sourceDir, destPath) {
 	console.info(`Plugin archive has been created in ${destPath}`);
 }
 
-const distDir = path.resolve(__dirname, 'dist');
-const srcDir = path.resolve(__dirname, 'src');
+const rootDir = path.resolve(__dirname);
+const distDir = path.resolve(rootDir, 'dist');
+const srcDir = path.resolve(rootDir, 'src');
 const manifestPath = `${srcDir}/manifest.json`;
 const manifest = readManifest(manifestPath);
 const archiveFilePath = path.resolve(__dirname, `${manifest.id}.jpl`);
 
 fs.removeSync(distDir);
 
-module.exports = {
+const baseConfig = {
 	mode: 'production',
-	entry: './src/index.ts',
 	target: 'node',
 	module: {
 		rules: [
@@ -60,6 +60,10 @@ module.exports = {
 			},
 		],
 	},
+};
+
+const pluginConfig = Object.assign({}, baseConfig, {
+	entry: './src/index.ts',
 	resolve: {
 		alias: {
 			api: path.resolve(__dirname, 'api'),
@@ -70,6 +74,9 @@ module.exports = {
 		filename: 'index.js',
 		path: distDir,
 	},
+});
+
+const lastStepConfig = {
 	plugins: [
 		new CopyPlugin({
 			patterns: [
@@ -79,8 +86,17 @@ module.exports = {
 					to: path.resolve(__dirname, 'dist'),
 					globOptions: {
 						ignore: [
+							// All TypeScript files are compiled to JS and
+							// already copied into /dist so we don't copy them.
 							'**/*.ts',
 							'**/*.tsx',
+
+							// Currently we don't support JS files for the main
+							// plugin script. We support it for content scripts,
+							// but theyr should be declared in manifest.json,
+							// and then they are also compiled and copied to
+							// /dist. So wse also don't need to copy JS files.
+							'**/*.js',
 						],
 					},
 				},
@@ -91,3 +107,62 @@ module.exports = {
 		}),
 	],
 };
+
+const contentScriptConfig = Object.assign({}, baseConfig, {
+	resolve: {
+		alias: {
+			api: path.resolve(__dirname, 'api'),
+		},
+		extensions: ['.tsx', '.ts', '.js'],
+	},
+});
+
+function resolveContentScriptPaths(name) {
+	if (['.js', '.ts', '.tsx'].includes(path.extname(name).toLowerCase())) {
+		throw new Error(`Content script path must not include file extension: ${name}`);
+	}
+
+	const pathsToTry = [
+		`./src/${name}.ts`,
+		`${'./src/' + '/'}${name}.js`,
+	];
+
+	for (const pathToTry of pathsToTry) {
+		if (fs.pathExistsSync(`${rootDir}/${pathToTry}`)) {
+			return {
+				entry: pathToTry,
+				output: {
+					filename: `${name}.js`,
+					path: distDir,
+					library: 'default',
+					libraryTarget: 'commonjs',
+					libraryExport: 'default',
+				},
+			};
+		}
+	}
+
+	throw new Error(`Could not find content script "${name}" at locations ${JSON.stringify(pathsToTry)}`);
+}
+
+function createContentScriptConfigs() {
+	if (!manifest.content_scripts) return [];
+
+	const output = [];
+
+	for (const contentScriptName of manifest.content_scripts) {
+		const scriptPaths = resolveContentScriptPaths(contentScriptName);
+		output.push(Object.assign({}, contentScriptConfig, {
+			entry: scriptPaths.entry,
+			output: scriptPaths.output,
+		}));
+	}
+
+	return output;
+}
+
+const exportedConfigs = [pluginConfig].concat(createContentScriptConfigs());
+
+exportedConfigs[exportedConfigs.length - 1] = Object.assign({}, exportedConfigs[exportedConfigs.length - 1], lastStepConfig);
+
+module.exports = exportedConfigs;

packages/app-cli/tests/support/plugins/jpl_test/.gitignore

@@ -1,2 +1,3 @@
 dist/*
 node_modules/
+*.jpl

packages/app-cli/tests/support/plugins/jpl_test/GENERATOR_DOC.md

@@ -0,0 +1,83 @@
+# generator-joplin
+
+Scaffolds out a new Joplin plugin
+
+## Installation
+
+First, install [Yeoman](http://yeoman.io) and generator-joplin using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).
+
+```bash
+npm install -g yo
+npm install -g generator-joplin
+```
+
+Then generate your new project:
+
+```bash
+yo joplin
+```
+
+## Development
+
+To test the generator for development purposes, follow the instructions there: https://yeoman.io/authoring/#running-the-generator
+This is a template to create a new Joplin plugin.
+
+## Structure
+
+The main two files you will want to look at are:
+
+- `/src/index.ts`, which contains the entry point for the plugin source code.
+- `/src/manifest.json`, which is the plugin manifest. It contains information such as the plugin a name, version, etc.
+
+## Building the plugin
+
+The plugin is built using Webpack, which creates the compiled code in `/dist`. A JPL archive will also be created at the root, which can use to distribute the plugin.
+
+To build the plugin, simply run `npm run dist`.
+
+The project is setup to use TypeScript, although you can change the configuration to use plain JavaScript.
+
+## Updating the plugin framework
+
+To update the plugin framework, run `yo joplin --update`
+
+Keep in mind that doing so will overwrite all the framework-related files **outside of the "src/" directory** (your source code will not be touched). So if you have modified any of the framework-related files, such as package.json or .gitignore, make sure your code is under version control so that you can check the diff and re-apply your changes.
+
+For that reason, it's generally best not to change any of the framework files or to do so in a way that minimises the number of changes. For example, if you want to modify the Webpack config, create a new separate JavaScript file and include it in webpack.config.js. That way, when you update, you only have to restore the line that include your file.
+
+## Content scripts
+
+A plugin that uses [content scripts](https://joplinapp.org/api/references/plugin_api/classes/joplinplugins.html#registercontentscript) must declare them under the `content_scripts` key of [manifest.json](https://joplinapp.org/api/references/plugin_manifest/).
+
+Each entry must be a path **relative to /src**, and **without extension**. The extension should not be included because it might change once the script is compiled. Each of these scripts will then be compiled to JavaScript and packaged into the plugin file. The content script files can be TypeScript (.ts or .tsx) or JavaScript.
+
+For example, assuming these files:
+
+```bash
+/src
+    index.ts                # Main plugin script
+    myContentScript.js      # One content script (JS)
+    otherContentScript.ts   # Another content script (TypeScript)
+    vendor/
+        test.ts             # Sub-directories are also supported
+```
+
+The `manifest.json` file would be:
+
+```json
+{
+    "manifest_version": 1,
+    "name": "Testing Content Scripts",
+    content_scripts: [
+        "myContentScript",
+        "otherContentScript",
+        "vendor/test"
+    ]
+}
+```
+
+Note in particular how the file path is relative to /src and the extensions removed.
+
+## License
+
+MIT © Laurent Cozic

packages/app-cli/tests/support/plugins/jpl_test/api/JoplinPlugins.d.ts

@@ -20,17 +20,21 @@ export default class JoplinPlugins {
      */
     register(script: Script): Promise<void>;
     /**
-     * Registers a new content script. Unlike regular plugin code, which
-     * runs in a separate process, content scripts run within the main
-     * process code and thus allow improved performances and more
-     * customisations in specific cases. It can be used for example to load
-     * a Markdown or editor plugin.
+     * Registers a new content script. Unlike regular plugin code, which runs in
+     * a separate process, content scripts run within the main process code and
+     * thus allow improved performances and more customisations in specific
+     * cases. It can be used for example to load a Markdown or editor plugin.
      *
-     * Note that registering a content script in itself will do nothing -
-     * it will only be loaded in specific cases by the relevant app modules
-     * (eg. the Markdown renderer or the code editor). So it is not a way
-     * to inject and run arbitrary code in the app, which for safety and
-     * performance reasons is not supported.
+     * Note that registering a content script in itself will do nothing - it
+     * will only be loaded in specific cases by the relevant app modules (eg.
+     * the Markdown renderer or the code editor). So it is not a way to inject
+     * and run arbitrary code in the app, which for safety and performance
+     * reasons is not supported.
+     *
+     * The plugin generator provides a way to build any content script you might
+     * want to package as well as its dependencies. See the [Plugin Generator
+     * doc](https://github.com/laurent22/joplin/blob/dev/packages/generator-joplin/README.md)
+     * for more information.
      *
      * * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script)
      * * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script)

packages/app-cli/tests/support/plugins/jpl_test/api/JoplinViewsDialogs.d.ts

@@ -47,6 +47,10 @@ export default class JoplinViewsDialogs {
      * Sets the dialog HTML content
      */
     setHtml(handle: ViewHandle, html: string): Promise<string>;
+    /**
+     * Adds and loads a new JS or CSS files into the dialog.
+     */
+    addScript(handle: ViewHandle, scriptPath: string): Promise<void>;
     /**
      * Sets the dialog buttons.
      */

packages/app-cli/tests/support/plugins/jpl_test/api/JoplinViewsPanels.d.ts

@@ -30,4 +30,16 @@ export default class JoplinViewsPanels {
      * Called when a message is sent from the webview (using postMessage).
      */
     onMessage(handle: ViewHandle, callback: Function): Promise<void>;
+    /**
+     * Shows the panel
+     */
+    show(handle: ViewHandle, show?: boolean): Promise<void>;
+    /**
+     * Hides the panel
+     */
+    hide(handle: ViewHandle): Promise<void>;
+    /**
+     * Tells whether the panel is visible or not
+     */
+    visible(handle: ViewHandle): Promise<boolean>;
 }

packages/app-cli/tests/support/plugins/jpl_test/api/types.ts

@@ -208,7 +208,7 @@ export enum MenuItemLocation {
 	Note = 'note',
 	Tools = 'tools',
 	Help = 'help',
-	
+
 	/**
 	 * @deprecated Do not use - same as NoteListContextMenu
 	 */
@@ -223,7 +223,7 @@ export enum MenuItemLocation {
 	 * - `noteIds:string[]`: IDs of the notes that were right-clicked on.
 	 */
 	NoteListContextMenu = 'noteListContextMenu',
-	
+
 	EditorContextMenu = 'editorContextMenu',
 
 	/**
@@ -243,7 +243,7 @@ export enum MenuItemLocation {
 	TagContextMenu = 'tagContextMenu',
 }
 
-export function isContextMenuItemLocation(location:MenuItemLocation):boolean {
+export function isContextMenuItemLocation(location: MenuItemLocation): boolean {
 	return [
 		MenuItemLocation.Context,
 		MenuItemLocation.NoteListContextMenu,

packages/app-cli/tests/support/plugins/jpl_test/webpack.config.js

@@ -39,17 +39,17 @@ function createPluginArchive(sourceDir, destPath) {
 	console.info(`Plugin archive has been created in ${destPath}`);
 }
 
-const distDir = path.resolve(__dirname, 'dist');
-const srcDir = path.resolve(__dirname, 'src');
+const rootDir = path.resolve(__dirname);
+const distDir = path.resolve(rootDir, 'dist');
+const srcDir = path.resolve(rootDir, 'src');
 const manifestPath = `${srcDir}/manifest.json`;
 const manifest = readManifest(manifestPath);
 const archiveFilePath = path.resolve(__dirname, `${manifest.id}.jpl`);
 
 fs.removeSync(distDir);
 
-module.exports = {
+const baseConfig = {
 	mode: 'production',
-	entry: './src/index.ts',
 	target: 'node',
 	module: {
 		rules: [
@@ -60,6 +60,10 @@ module.exports = {
 			},
 		],
 	},
+};
+
+const pluginConfig = Object.assign({}, baseConfig, {
+	entry: './src/index.ts',
 	resolve: {
 		alias: {
 			api: path.resolve(__dirname, 'api'),
@@ -70,6 +74,9 @@ module.exports = {
 		filename: 'index.js',
 		path: distDir,
 	},
+});
+
+const lastStepConfig = {
 	plugins: [
 		new CopyPlugin({
 			patterns: [
@@ -79,8 +86,17 @@ module.exports = {
 					to: path.resolve(__dirname, 'dist'),
 					globOptions: {
 						ignore: [
+							// All TypeScript files are compiled to JS and
+							// already copied into /dist so we don't copy them.
 							'**/*.ts',
 							'**/*.tsx',
+
+							// Currently we don't support JS files for the main
+							// plugin script. We support it for content scripts,
+							// but theyr should be declared in manifest.json,
+							// and then they are also compiled and copied to
+							// /dist. So wse also don't need to copy JS files.
+							'**/*.js',
 						],
 					},
 				},
@@ -91,3 +107,62 @@ module.exports = {
 		}),
 	],
 };
+
+const contentScriptConfig = Object.assign({}, baseConfig, {
+	resolve: {
+		alias: {
+			api: path.resolve(__dirname, 'api'),
+		},
+		extensions: ['.tsx', '.ts', '.js'],
+	},
+});
+
+function resolveContentScriptPaths(name) {
+	if (['.js', '.ts', '.tsx'].includes(path.extname(name).toLowerCase())) {
+		throw new Error(`Content script path must not include file extension: ${name}`);
+	}
+
+	const pathsToTry = [
+		`./src/${name}.ts`,
+		`${'./src/' + '/'}${name}.js`,
+	];
+
+	for (const pathToTry of pathsToTry) {
+		if (fs.pathExistsSync(`${rootDir}/${pathToTry}`)) {
+			return {
+				entry: pathToTry,
+				output: {
+					filename: `${name}.js`,
+					path: distDir,
+					library: 'default',
+					libraryTarget: 'commonjs',
+					libraryExport: 'default',
+				},
+			};
+		}
+	}
+
+	throw new Error(`Could not find content script "${name}" at locations ${JSON.stringify(pathsToTry)}`);
+}
+
+function createContentScriptConfigs() {
+	if (!manifest.content_scripts) return [];
+
+	const output = [];
+
+	for (const contentScriptName of manifest.content_scripts) {
+		const scriptPaths = resolveContentScriptPaths(contentScriptName);
+		output.push(Object.assign({}, contentScriptConfig, {
+			entry: scriptPaths.entry,
+			output: scriptPaths.output,
+		}));
+	}
+
+	return output;
+}
+
+const exportedConfigs = [pluginConfig].concat(createContentScriptConfigs());
+
+exportedConfigs[exportedConfigs.length - 1] = Object.assign({}, exportedConfigs[exportedConfigs.length - 1], lastStepConfig);
+
+module.exports = exportedConfigs;

packages/app-cli/tests/support/plugins/json_export/GENERATOR_DOC.md

@@ -0,0 +1,83 @@
+# generator-joplin
+
+Scaffolds out a new Joplin plugin
+
+## Installation
+
+First, install [Yeoman](http://yeoman.io) and generator-joplin using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).
+
+```bash
+npm install -g yo
+npm install -g generator-joplin
+```
+
+Then generate your new project:
+
+```bash
+yo joplin
+```
+
+## Development
+
+To test the generator for development purposes, follow the instructions there: https://yeoman.io/authoring/#running-the-generator
+This is a template to create a new Joplin plugin.
+
+## Structure
+
+The main two files you will want to look at are:
+
+- `/src/index.ts`, which contains the entry point for the plugin source code.
+- `/src/manifest.json`, which is the plugin manifest. It contains information such as the plugin a name, version, etc.
+
+## Building the plugin
+
+The plugin is built using Webpack, which creates the compiled code in `/dist`. A JPL archive will also be created at the root, which can use to distribute the plugin.
+
+To build the plugin, simply run `npm run dist`.
+
+The project is setup to use TypeScript, although you can change the configuration to use plain JavaScript.
+
+## Updating the plugin framework
+
+To update the plugin framework, run `yo joplin --update`
+
+Keep in mind that doing so will overwrite all the framework-related files **outside of the "src/" directory** (your source code will not be touched). So if you have modified any of the framework-related files, such as package.json or .gitignore, make sure your code is under version control so that you can check the diff and re-apply your changes.
+
+For that reason, it's generally best not to change any of the framework files or to do so in a way that minimises the number of changes. For example, if you want to modify the Webpack config, create a new separate JavaScript file and include it in webpack.config.js. That way, when you update, you only have to restore the line that include your file.
+
+## Content scripts
+
+A plugin that uses [content scripts](https://joplinapp.org/api/references/plugin_api/classes/joplinplugins.html#registercontentscript) must declare them under the `content_scripts` key of [manifest.json](https://joplinapp.org/api/references/plugin_manifest/).
+
+Each entry must be a path **relative to /src**, and **without extension**. The extension should not be included because it might change once the script is compiled. Each of these scripts will then be compiled to JavaScript and packaged into the plugin file. The content script files can be TypeScript (.ts or .tsx) or JavaScript.
+
+For example, assuming these files:
+
+```bash
+/src
+    index.ts                # Main plugin script
+    myContentScript.js      # One content script (JS)
+    otherContentScript.ts   # Another content script (TypeScript)
+    vendor/
+        test.ts             # Sub-directories are also supported
+```
+
+The `manifest.json` file would be:
+
+```json
+{
+    "manifest_version": 1,
+    "name": "Testing Content Scripts",
+    content_scripts: [
+        "myContentScript",
+        "otherContentScript",
+        "vendor/test"
+    ]
+}
+```
+
+Note in particular how the file path is relative to /src and the extensions removed.
+
+## License
+
+MIT © Laurent Cozic

packages/app-cli/tests/support/plugins/json_export/api/JoplinPlugins.d.ts

@@ -20,17 +20,21 @@ export default class JoplinPlugins {
      */
     register(script: Script): Promise<void>;
     /**
-     * Registers a new content script. Unlike regular plugin code, which
-     * runs in a separate process, content scripts run within the main
-     * process code and thus allow improved performances and more
-     * customisations in specific cases. It can be used for example to load
-     * a Markdown or editor plugin.
+     * Registers a new content script. Unlike regular plugin code, which runs in
+     * a separate process, content scripts run within the main process code and
+     * thus allow improved performances and more customisations in specific
+     * cases. It can be used for example to load a Markdown or editor plugin.
      *
-     * Note that registering a content script in itself will do nothing -
-     * it will only be loaded in specific cases by the relevant app modules
-     * (eg. the Markdown renderer or the code editor). So it is not a way
-     * to inject and run arbitrary code in the app, which for safety and
-     * performance reasons is not supported.
+     * Note that registering a content script in itself will do nothing - it
+     * will only be loaded in specific cases by the relevant app modules (eg.
+     * the Markdown renderer or the code editor). So it is not a way to inject
+     * and run arbitrary code in the app, which for safety and performance
+     * reasons is not supported.
+     *
+     * The plugin generator provides a way to build any content script you might
+     * want to package as well as its dependencies. See the [Plugin Generator
+     * doc](https://github.com/laurent22/joplin/blob/dev/packages/generator-joplin/README.md)
+     * for more information.
      *
      * * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script)
      * * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script)

packages/app-cli/tests/support/plugins/json_export/api/JoplinViewsDialogs.d.ts

@@ -47,6 +47,10 @@ export default class JoplinViewsDialogs {
      * Sets the dialog HTML content
      */
     setHtml(handle: ViewHandle, html: string): Promise<string>;
+    /**
+     * Adds and loads a new JS or CSS files into the dialog.
+     */
+    addScript(handle: ViewHandle, scriptPath: string): Promise<void>;
     /**
      * Sets the dialog buttons.
      */

packages/app-cli/tests/support/plugins/json_export/api/JoplinViewsPanels.d.ts

@@ -30,4 +30,16 @@ export default class JoplinViewsPanels {
      * Called when a message is sent from the webview (using postMessage).
      */
     onMessage(handle: ViewHandle, callback: Function): Promise<void>;
+    /**
+     * Shows the panel
+     */
+    show(handle: ViewHandle, show?: boolean): Promise<void>;
+    /**
+     * Hides the panel
+     */
+    hide(handle: ViewHandle): Promise<void>;
+    /**
+     * Tells whether the panel is visible or not
+     */
+    visible(handle: ViewHandle): Promise<boolean>;
 }

packages/app-cli/tests/support/plugins/json_export/api/types.ts

@@ -208,7 +208,7 @@ export enum MenuItemLocation {
 	Note = 'note',
 	Tools = 'tools',
 	Help = 'help',
-	
+
 	/**
 	 * @deprecated Do not use - same as NoteListContextMenu
 	 */
@@ -223,7 +223,7 @@ export enum MenuItemLocation {
 	 * - `noteIds:string[]`: IDs of the notes that were right-clicked on.
 	 */
 	NoteListContextMenu = 'noteListContextMenu',
-	
+
 	EditorContextMenu = 'editorContextMenu',
 
 	/**
@@ -243,7 +243,7 @@ export enum MenuItemLocation {
 	TagContextMenu = 'tagContextMenu',
 }
 
-export function isContextMenuItemLocation(location:MenuItemLocation):boolean {
+export function isContextMenuItemLocation(location: MenuItemLocation): boolean {
 	return [
 		MenuItemLocation.Context,
 		MenuItemLocation.NoteListContextMenu,

packages/app-cli/tests/support/plugins/json_export/webpack.config.js

@@ -39,17 +39,17 @@ function createPluginArchive(sourceDir, destPath) {
 	console.info(`Plugin archive has been created in ${destPath}`);
 }
 
-const distDir = path.resolve(__dirname, 'dist');
-const srcDir = path.resolve(__dirname, 'src');
+const rootDir = path.resolve(__dirname);
+const distDir = path.resolve(rootDir, 'dist');
+const srcDir = path.resolve(rootDir, 'src');
 const manifestPath = `${srcDir}/manifest.json`;
 const manifest = readManifest(manifestPath);
 const archiveFilePath = path.resolve(__dirname, `${manifest.id}.jpl`);
 
 fs.removeSync(distDir);
 
-module.exports = {
+const baseConfig = {
 	mode: 'production',
-	entry: './src/index.ts',
 	target: 'node',
 	module: {
 		rules: [
@@ -60,6 +60,10 @@ module.exports = {
 			},
 		],
 	},
+};
+
+const pluginConfig = Object.assign({}, baseConfig, {
+	entry: './src/index.ts',
 	resolve: {
 		alias: {
 			api: path.resolve(__dirname, 'api'),
@@ -70,6 +74,9 @@ module.exports = {
 		filename: 'index.js',
 		path: distDir,
 	},
+});
+
+const lastStepConfig = {
 	plugins: [
 		new CopyPlugin({
 			patterns: [
@@ -79,8 +86,17 @@ module.exports = {
 					to: path.resolve(__dirname, 'dist'),
 					globOptions: {
 						ignore: [
+							// All TypeScript files are compiled to JS and
+							// already copied into /dist so we don't copy them.
 							'**/*.ts',
 							'**/*.tsx',
+
+							// Currently we don't support JS files for the main
+							// plugin script. We support it for content scripts,
+							// but theyr should be declared in manifest.json,
+							// and then they are also compiled and copied to
+							// /dist. So wse also don't need to copy JS files.
+							'**/*.js',
 						],
 					},
 				},
@@ -91,3 +107,62 @@ module.exports = {
 		}),
 	],
 };
+
+const contentScriptConfig = Object.assign({}, baseConfig, {
+	resolve: {
+		alias: {
+			api: path.resolve(__dirname, 'api'),
+		},
+		extensions: ['.tsx', '.ts', '.js'],
+	},
+});
+
+function resolveContentScriptPaths(name) {
+	if (['.js', '.ts', '.tsx'].includes(path.extname(name).toLowerCase())) {
+		throw new Error(`Content script path must not include file extension: ${name}`);
+	}
+
+	const pathsToTry = [
+		`./src/${name}.ts`,
+		`${'./src/' + '/'}${name}.js`,
+	];
+
+	for (const pathToTry of pathsToTry) {
+		if (fs.pathExistsSync(`${rootDir}/${pathToTry}`)) {
+			return {
+				entry: pathToTry,
+				output: {
+					filename: `${name}.js`,
+					path: distDir,
+					library: 'default',
+					libraryTarget: 'commonjs',
+					libraryExport: 'default',
+				},
+			};
+		}
+	}
+
+	throw new Error(`Could not find content script "${name}" at locations ${JSON.stringify(pathsToTry)}`);
+}
+
+function createContentScriptConfigs() {
+	if (!manifest.content_scripts) return [];
+
+	const output = [];
+
+	for (const contentScriptName of manifest.content_scripts) {
+		const scriptPaths = resolveContentScriptPaths(contentScriptName);
+		output.push(Object.assign({}, contentScriptConfig, {
+			entry: scriptPaths.entry,
+			output: scriptPaths.output,
+		}));
+	}
+
+	return output;
+}
+
+const exportedConfigs = [pluginConfig].concat(createContentScriptConfigs());
+
+exportedConfigs[exportedConfigs.length - 1] = Object.assign({}, exportedConfigs[exportedConfigs.length - 1], lastStepConfig);
+
+module.exports = exportedConfigs;

packages/app-cli/tests/support/plugins/markdownItTestPlugin.js

@@ -0,0 +1,28 @@
+function plugin(markdownIt, _options) {
+	const defaultRender = markdownIt.renderer.rules.fence || function(tokens, idx, options, env, self) {
+		return self.renderToken(tokens, idx, options, env, self);
+	};
+
+	markdownIt.renderer.rules.fence = function(tokens, idx, options, env, self) {
+		const token = tokens[idx];
+		if (token.info !== 'justtesting') return defaultRender(tokens, idx, options, env, self);
+		return `
+			<div class="just-testing">
+				<p>JUST TESTING: ${token.content}</p>
+			</div>
+		`;
+	};
+}
+
+module.exports = {
+	default: function(_context) { 
+		return {
+			plugin: plugin,
+			assets: function() {
+				return [
+					{ name: 'markdownItTestPlugin.css' }
+				];
+			},
+		}
+	},
+}

packages/app-cli/tests/support/plugins/menu/GENERATOR_DOC.md

@@ -0,0 +1,83 @@
+# generator-joplin
+
+Scaffolds out a new Joplin plugin
+
+## Installation
+
+First, install [Yeoman](http://yeoman.io) and generator-joplin using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).
+
+```bash
+npm install -g yo
+npm install -g generator-joplin
+```
+
+Then generate your new project:
+
+```bash
+yo joplin
+```
+
+## Development
+
+To test the generator for development purposes, follow the instructions there: https://yeoman.io/authoring/#running-the-generator
+This is a template to create a new Joplin plugin.
+
+## Structure
+
+The main two files you will want to look at are:
+
+- `/src/index.ts`, which contains the entry point for the plugin source code.
+- `/src/manifest.json`, which is the plugin manifest. It contains information such as the plugin a name, version, etc.
+
+## Building the plugin
+
+The plugin is built using Webpack, which creates the compiled code in `/dist`. A JPL archive will also be created at the root, which can use to distribute the plugin.
+
+To build the plugin, simply run `npm run dist`.
+
+The project is setup to use TypeScript, although you can change the configuration to use plain JavaScript.
+
+## Updating the plugin framework
+
+To update the plugin framework, run `yo joplin --update`
+
+Keep in mind that doing so will overwrite all the framework-related files **outside of the "src/" directory** (your source code will not be touched). So if you have modified any of the framework-related files, such as package.json or .gitignore, make sure your code is under version control so that you can check the diff and re-apply your changes.
+
+For that reason, it's generally best not to change any of the framework files or to do so in a way that minimises the number of changes. For example, if you want to modify the Webpack config, create a new separate JavaScript file and include it in webpack.config.js. That way, when you update, you only have to restore the line that include your file.
+
+## Content scripts
+
+A plugin that uses [content scripts](https://joplinapp.org/api/references/plugin_api/classes/joplinplugins.html#registercontentscript) must declare them under the `content_scripts` key of [manifest.json](https://joplinapp.org/api/references/plugin_manifest/).
+
+Each entry must be a path **relative to /src**, and **without extension**. The extension should not be included because it might change once the script is compiled. Each of these scripts will then be compiled to JavaScript and packaged into the plugin file. The content script files can be TypeScript (.ts or .tsx) or JavaScript.
+
+For example, assuming these files:
+
+```bash
+/src
+    index.ts                # Main plugin script
+    myContentScript.js      # One content script (JS)
+    otherContentScript.ts   # Another content script (TypeScript)
+    vendor/
+        test.ts             # Sub-directories are also supported
+```
+
+The `manifest.json` file would be:
+
+```json
+{
+    "manifest_version": 1,
+    "name": "Testing Content Scripts",
+    content_scripts: [
+        "myContentScript",
+        "otherContentScript",
+        "vendor/test"
+    ]
+}
+```
+
+Note in particular how the file path is relative to /src and the extensions removed.
+
+## License
+
+MIT © Laurent Cozic

packages/app-cli/tests/support/plugins/menu/api/JoplinPlugins.d.ts

@@ -20,17 +20,21 @@ export default class JoplinPlugins {
      */
     register(script: Script): Promise<void>;
     /**
-     * Registers a new content script. Unlike regular plugin code, which
-     * runs in a separate process, content scripts run within the main
-     * process code and thus allow improved performances and more
-     * customisations in specific cases. It can be used for example to load
-     * a Markdown or editor plugin.
+     * Registers a new content script. Unlike regular plugin code, which runs in
+     * a separate process, content scripts run within the main process code and
+     * thus allow improved performances and more customisations in specific
+     * cases. It can be used for example to load a Markdown or editor plugin.
      *
-     * Note that registering a content script in itself will do nothing -
-     * it will only be loaded in specific cases by the relevant app modules
-     * (eg. the Markdown renderer or the code editor). So it is not a way
-     * to inject and run arbitrary code in the app, which for safety and
-     * performance reasons is not supported.
+     * Note that registering a content script in itself will do nothing - it
+     * will only be loaded in specific cases by the relevant app modules (eg.
+     * the Markdown renderer or the code editor). So it is not a way to inject
+     * and run arbitrary code in the app, which for safety and performance
+     * reasons is not supported.
+     *
+     * The plugin generator provides a way to build any content script you might
+     * want to package as well as its dependencies. See the [Plugin Generator
+     * doc](https://github.com/laurent22/joplin/blob/dev/packages/generator-joplin/README.md)
+     * for more information.
      *
      * * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script)
      * * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script)

packages/app-cli/tests/support/plugins/menu/api/JoplinViewsDialogs.d.ts

@@ -47,6 +47,10 @@ export default class JoplinViewsDialogs {
      * Sets the dialog HTML content
      */
     setHtml(handle: ViewHandle, html: string): Promise<string>;
+    /**
+     * Adds and loads a new JS or CSS files into the dialog.
+     */
+    addScript(handle: ViewHandle, scriptPath: string): Promise<void>;
     /**
      * Sets the dialog buttons.
      */

packages/app-cli/tests/support/plugins/menu/api/JoplinViewsPanels.d.ts

@@ -30,4 +30,16 @@ export default class JoplinViewsPanels {
      * Called when a message is sent from the webview (using postMessage).
      */
     onMessage(handle: ViewHandle, callback: Function): Promise<void>;
+    /**
+     * Shows the panel
+     */
+    show(handle: ViewHandle, show?: boolean): Promise<void>;
+    /**
+     * Hides the panel
+     */
+    hide(handle: ViewHandle): Promise<void>;
+    /**
+     * Tells whether the panel is visible or not
+     */
+    visible(handle: ViewHandle): Promise<boolean>;
 }

packages/app-cli/tests/support/plugins/menu/api/types.ts

@@ -208,7 +208,7 @@ export enum MenuItemLocation {
 	Note = 'note',
 	Tools = 'tools',
 	Help = 'help',
-	
+
 	/**
 	 * @deprecated Do not use - same as NoteListContextMenu
 	 */
@@ -223,7 +223,7 @@ export enum MenuItemLocation {
 	 * - `noteIds:string[]`: IDs of the notes that were right-clicked on.
 	 */
 	NoteListContextMenu = 'noteListContextMenu',
-	
+
 	EditorContextMenu = 'editorContextMenu',
 
 	/**
@@ -243,7 +243,7 @@ export enum MenuItemLocation {
 	TagContextMenu = 'tagContextMenu',
 }
 
-export function isContextMenuItemLocation(location:MenuItemLocation):boolean {
+export function isContextMenuItemLocation(location: MenuItemLocation): boolean {
 	return [
 		MenuItemLocation.Context,
 		MenuItemLocation.NoteListContextMenu,

packages/app-cli/tests/support/plugins/menu/webpack.config.js

@@ -39,17 +39,17 @@ function createPluginArchive(sourceDir, destPath) {
 	console.info(`Plugin archive has been created in ${destPath}`);
 }
 
-const distDir = path.resolve(__dirname, 'dist');
-const srcDir = path.resolve(__dirname, 'src');
+const rootDir = path.resolve(__dirname);
+const distDir = path.resolve(rootDir, 'dist');
+const srcDir = path.resolve(rootDir, 'src');
 const manifestPath = `${srcDir}/manifest.json`;
 const manifest = readManifest(manifestPath);
 const archiveFilePath = path.resolve(__dirname, `${manifest.id}.jpl`);
 
 fs.removeSync(distDir);
 
-module.exports = {
+const baseConfig = {
 	mode: 'production',
-	entry: './src/index.ts',
 	target: 'node',
 	module: {
 		rules: [
@@ -60,6 +60,10 @@ module.exports = {
 			},
 		],
 	},
+};
+
+const pluginConfig = Object.assign({}, baseConfig, {
+	entry: './src/index.ts',
 	resolve: {
 		alias: {
 			api: path.resolve(__dirname, 'api'),
@@ -70,6 +74,9 @@ module.exports = {
 		filename: 'index.js',
 		path: distDir,
 	},
+});
+
+const lastStepConfig = {
 	plugins: [
 		new CopyPlugin({
 			patterns: [
@@ -79,8 +86,17 @@ module.exports = {
 					to: path.resolve(__dirname, 'dist'),
 					globOptions: {
 						ignore: [
+							// All TypeScript files are compiled to JS and
+							// already copied into /dist so we don't copy them.
 							'**/*.ts',
 							'**/*.tsx',
+
+							// Currently we don't support JS files for the main
+							// plugin script. We support it for content scripts,
+							// but theyr should be declared in manifest.json,
+							// and then they are also compiled and copied to
+							// /dist. So wse also don't need to copy JS files.
+							'**/*.js',
 						],
 					},
 				},
@@ -91,3 +107,62 @@ module.exports = {
 		}),
 	],
 };
+
+const contentScriptConfig = Object.assign({}, baseConfig, {
+	resolve: {
+		alias: {
+			api: path.resolve(__dirname, 'api'),
+		},
+		extensions: ['.tsx', '.ts', '.js'],
+	},
+});
+
+function resolveContentScriptPaths(name) {
+	if (['.js', '.ts', '.tsx'].includes(path.extname(name).toLowerCase())) {
+		throw new Error(`Content script path must not include file extension: ${name}`);
+	}
+
+	const pathsToTry = [
+		`./src/${name}.ts`,
+		`${'./src/' + '/'}${name}.js`,
+	];
+
+	for (const pathToTry of pathsToTry) {
+		if (fs.pathExistsSync(`${rootDir}/${pathToTry}`)) {
+			return {
+				entry: pathToTry,
+				output: {
+					filename: `${name}.js`,
+					path: distDir,
+					library: 'default',
+					libraryTarget: 'commonjs',
+					libraryExport: 'default',
+				},
+			};
+		}
+	}
+
+	throw new Error(`Could not find content script "${name}" at locations ${JSON.stringify(pathsToTry)}`);
+}
+
+function createContentScriptConfigs() {
+	if (!manifest.content_scripts) return [];
+
+	const output = [];
+
+	for (const contentScriptName of manifest.content_scripts) {
+		const scriptPaths = resolveContentScriptPaths(contentScriptName);
+		output.push(Object.assign({}, contentScriptConfig, {
+			entry: scriptPaths.entry,
+			output: scriptPaths.output,
+		}));
+	}
+
+	return output;
+}
+
+const exportedConfigs = [pluginConfig].concat(createContentScriptConfigs());
+
+exportedConfigs[exportedConfigs.length - 1] = Object.assign({}, exportedConfigs[exportedConfigs.length - 1], lastStepConfig);
+
+module.exports = exportedConfigs;

packages/app-cli/tests/support/plugins/multi_selection/GENERATOR_DOC.md

@@ -0,0 +1,83 @@
+# generator-joplin
+
+Scaffolds out a new Joplin plugin
+
+## Installation
+
+First, install [Yeoman](http://yeoman.io) and generator-joplin using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).
+
+```bash
+npm install -g yo
+npm install -g generator-joplin
+```
+
+Then generate your new project:
+
+```bash
+yo joplin
+```
+
+## Development
+
+To test the generator for development purposes, follow the instructions there: https://yeoman.io/authoring/#running-the-generator
+This is a template to create a new Joplin plugin.
+
+## Structure
+
+The main two files you will want to look at are:
+
+- `/src/index.ts`, which contains the entry point for the plugin source code.
+- `/src/manifest.json`, which is the plugin manifest. It contains information such as the plugin a name, version, etc.
+
+## Building the plugin
+
+The plugin is built using Webpack, which creates the compiled code in `/dist`. A JPL archive will also be created at the root, which can use to distribute the plugin.
+
+To build the plugin, simply run `npm run dist`.
+
+The project is setup to use TypeScript, although you can change the configuration to use plain JavaScript.
+
+## Updating the plugin framework
+
+To update the plugin framework, run `yo joplin --update`
+
+Keep in mind that doing so will overwrite all the framework-related files **outside of the "src/" directory** (your source code will not be touched). So if you have modified any of the framework-related files, such as package.json or .gitignore, make sure your code is under version control so that you can check the diff and re-apply your changes.
+
+For that reason, it's generally best not to change any of the framework files or to do so in a way that minimises the number of changes. For example, if you want to modify the Webpack config, create a new separate JavaScript file and include it in webpack.config.js. That way, when you update, you only have to restore the line that include your file.
+
+## Content scripts
+
+A plugin that uses [content scripts](https://joplinapp.org/api/references/plugin_api/classes/joplinplugins.html#registercontentscript) must declare them under the `content_scripts` key of [manifest.json](https://joplinapp.org/api/references/plugin_manifest/).
+
+Each entry must be a path **relative to /src**, and **without extension**. The extension should not be included because it might change once the script is compiled. Each of these scripts will then be compiled to JavaScript and packaged into the plugin file. The content script files can be TypeScript (.ts or .tsx) or JavaScript.
+
+For example, assuming these files:
+
+```bash
+/src
+    index.ts                # Main plugin script
+    myContentScript.js      # One content script (JS)
+    otherContentScript.ts   # Another content script (TypeScript)
+    vendor/
+        test.ts             # Sub-directories are also supported
+```
+
+The `manifest.json` file would be:
+
+```json
+{
+    "manifest_version": 1,
+    "name": "Testing Content Scripts",
+    content_scripts: [
+        "myContentScript",
+        "otherContentScript",
+        "vendor/test"
+    ]
+}
+```
+
+Note in particular how the file path is relative to /src and the extensions removed.
+
+## License
+
+MIT © Laurent Cozic

packages/app-cli/tests/support/plugins/multi_selection/api/JoplinPlugins.d.ts

@@ -20,17 +20,21 @@ export default class JoplinPlugins {
      */
     register(script: Script): Promise<void>;
     /**
-     * Registers a new content script. Unlike regular plugin code, which
-     * runs in a separate process, content scripts run within the main
-     * process code and thus allow improved performances and more
-     * customisations in specific cases. It can be used for example to load
-     * a Markdown or editor plugin.
+     * Registers a new content script. Unlike regular plugin code, which runs in
+     * a separate process, content scripts run within the main process code and
+     * thus allow improved performances and more customisations in specific
+     * cases. It can be used for example to load a Markdown or editor plugin.
      *
-     * Note that registering a content script in itself will do nothing -
-     * it will only be loaded in specific cases by the relevant app modules
-     * (eg. the Markdown renderer or the code editor). So it is not a way
-     * to inject and run arbitrary code in the app, which for safety and
-     * performance reasons is not supported.
+     * Note that registering a content script in itself will do nothing - it
+     * will only be loaded in specific cases by the relevant app modules (eg.
+     * the Markdown renderer or the code editor). So it is not a way to inject
+     * and run arbitrary code in the app, which for safety and performance
+     * reasons is not supported.
+     *
+     * The plugin generator provides a way to build any content script you might
+     * want to package as well as its dependencies. See the [Plugin Generator
+     * doc](https://github.com/laurent22/joplin/blob/dev/packages/generator-joplin/README.md)
+     * for more information.
      *
      * * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script)
      * * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script)

packages/app-cli/tests/support/plugins/multi_selection/api/JoplinViewsDialogs.d.ts

@@ -47,6 +47,10 @@ export default class JoplinViewsDialogs {
      * Sets the dialog HTML content
      */
     setHtml(handle: ViewHandle, html: string): Promise<string>;
+    /**
+     * Adds and loads a new JS or CSS files into the dialog.
+     */
+    addScript(handle: ViewHandle, scriptPath: string): Promise<void>;
     /**
      * Sets the dialog buttons.
      */

packages/app-cli/tests/support/plugins/multi_selection/api/JoplinViewsPanels.d.ts

@@ -30,4 +30,16 @@ export default class JoplinViewsPanels {
      * Called when a message is sent from the webview (using postMessage).
      */
     onMessage(handle: ViewHandle, callback: Function): Promise<void>;
+    /**
+     * Shows the panel
+     */
+    show(handle: ViewHandle, show?: boolean): Promise<void>;
+    /**
+     * Hides the panel
+     */
+    hide(handle: ViewHandle): Promise<void>;
+    /**
+     * Tells whether the panel is visible or not
+     */
+    visible(handle: ViewHandle): Promise<boolean>;
 }

packages/app-cli/tests/support/plugins/multi_selection/api/types.ts

@@ -208,7 +208,7 @@ export enum MenuItemLocation {
 	Note = 'note',
 	Tools = 'tools',
 	Help = 'help',
-	
+
 	/**
 	 * @deprecated Do not use - same as NoteListContextMenu
 	 */
@@ -223,7 +223,7 @@ export enum MenuItemLocation {
 	 * - `noteIds:string[]`: IDs of the notes that were right-clicked on.
 	 */
 	NoteListContextMenu = 'noteListContextMenu',
-	
+
 	EditorContextMenu = 'editorContextMenu',
 
 	/**
@@ -243,7 +243,7 @@ export enum MenuItemLocation {
 	TagContextMenu = 'tagContextMenu',
 }
 
-export function isContextMenuItemLocation(location:MenuItemLocation):boolean {
+export function isContextMenuItemLocation(location: MenuItemLocation): boolean {
 	return [
 		MenuItemLocation.Context,
 		MenuItemLocation.NoteListContextMenu,

packages/app-cli/tests/support/plugins/multi_selection/webpack.config.js

@@ -39,17 +39,17 @@ function createPluginArchive(sourceDir, destPath) {
 	console.info(`Plugin archive has been created in ${destPath}`);
 }
 
-const distDir = path.resolve(__dirname, 'dist');
-const srcDir = path.resolve(__dirname, 'src');
+const rootDir = path.resolve(__dirname);
+const distDir = path.resolve(rootDir, 'dist');
+const srcDir = path.resolve(rootDir, 'src');
 const manifestPath = `${srcDir}/manifest.json`;
 const manifest = readManifest(manifestPath);
 const archiveFilePath = path.resolve(__dirname, `${manifest.id}.jpl`);
 
 fs.removeSync(distDir);
 
-module.exports = {
+const baseConfig = {
 	mode: 'production',
-	entry: './src/index.ts',
 	target: 'node',
 	module: {
 		rules: [
@@ -60,6 +60,10 @@ module.exports = {
 			},
 		],
 	},
+};
+
+const pluginConfig = Object.assign({}, baseConfig, {
+	entry: './src/index.ts',
 	resolve: {
 		alias: {
 			api: path.resolve(__dirname, 'api'),
@@ -70,6 +74,9 @@ module.exports = {
 		filename: 'index.js',
 		path: distDir,
 	},
+});
+
+const lastStepConfig = {
 	plugins: [
 		new CopyPlugin({
 			patterns: [
@@ -79,8 +86,17 @@ module.exports = {
 					to: path.resolve(__dirname, 'dist'),
 					globOptions: {
 						ignore: [
+							// All TypeScript files are compiled to JS and
+							// already copied into /dist so we don't copy them.
 							'**/*.ts',
 							'**/*.tsx',
+
+							// Currently we don't support JS files for the main
+							// plugin script. We support it for content scripts,
+							// but theyr should be declared in manifest.json,
+							// and then they are also compiled and copied to
+							// /dist. So wse also don't need to copy JS files.
+							'**/*.js',
 						],
 					},
 				},
@@ -91,3 +107,62 @@ module.exports = {
 		}),
 	],
 };
+
+const contentScriptConfig = Object.assign({}, baseConfig, {
+	resolve: {
+		alias: {
+			api: path.resolve(__dirname, 'api'),
+		},
+		extensions: ['.tsx', '.ts', '.js'],
+	},
+});
+
+function resolveContentScriptPaths(name) {
+	if (['.js', '.ts', '.tsx'].includes(path.extname(name).toLowerCase())) {
+		throw new Error(`Content script path must not include file extension: ${name}`);
+	}
+
+	const pathsToTry = [
+		`./src/${name}.ts`,
+		`${'./src/' + '/'}${name}.js`,
+	];
+
+	for (const pathToTry of pathsToTry) {
+		if (fs.pathExistsSync(`${rootDir}/${pathToTry}`)) {
+			return {
+				entry: pathToTry,
+				output: {
+					filename: `${name}.js`,
+					path: distDir,
+					library: 'default',
+					libraryTarget: 'commonjs',
+					libraryExport: 'default',
+				},
+			};
+		}
+	}
+
+	throw new Error(`Could not find content script "${name}" at locations ${JSON.stringify(pathsToTry)}`);
+}
+
+function createContentScriptConfigs() {
+	if (!manifest.content_scripts) return [];
+
+	const output = [];
+
+	for (const contentScriptName of manifest.content_scripts) {
+		const scriptPaths = resolveContentScriptPaths(contentScriptName);
+		output.push(Object.assign({}, contentScriptConfig, {
+			entry: scriptPaths.entry,
+			output: scriptPaths.output,
+		}));
+	}
+
+	return output;
+}
+
+const exportedConfigs = [pluginConfig].concat(createContentScriptConfigs());
+
+exportedConfigs[exportedConfigs.length - 1] = Object.assign({}, exportedConfigs[exportedConfigs.length - 1], lastStepConfig);
+
+module.exports = exportedConfigs;

packages/app-cli/tests/support/plugins/register_command/GENERATOR_DOC.md

@@ -0,0 +1,83 @@
+# generator-joplin
+
+Scaffolds out a new Joplin plugin
+
+## Installation
+
+First, install [Yeoman](http://yeoman.io) and generator-joplin using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).
+
+```bash
+npm install -g yo
+npm install -g generator-joplin
+```
+
+Then generate your new project:
+
+```bash
+yo joplin
+```
+
+## Development
+
+To test the generator for development purposes, follow the instructions there: https://yeoman.io/authoring/#running-the-generator
+This is a template to create a new Joplin plugin.
+
+## Structure
+
+The main two files you will want to look at are:
+
+- `/src/index.ts`, which contains the entry point for the plugin source code.
+- `/src/manifest.json`, which is the plugin manifest. It contains information such as the plugin a name, version, etc.
+
+## Building the plugin
+
+The plugin is built using Webpack, which creates the compiled code in `/dist`. A JPL archive will also be created at the root, which can use to distribute the plugin.
+
+To build the plugin, simply run `npm run dist`.
+
+The project is setup to use TypeScript, although you can change the configuration to use plain JavaScript.
+
+## Updating the plugin framework
+
+To update the plugin framework, run `yo joplin --update`
+
+Keep in mind that doing so will overwrite all the framework-related files **outside of the "src/" directory** (your source code will not be touched). So if you have modified any of the framework-related files, such as package.json or .gitignore, make sure your code is under version control so that you can check the diff and re-apply your changes.
+
+For that reason, it's generally best not to change any of the framework files or to do so in a way that minimises the number of changes. For example, if you want to modify the Webpack config, create a new separate JavaScript file and include it in webpack.config.js. That way, when you update, you only have to restore the line that include your file.
+
+## Content scripts
+
+A plugin that uses [content scripts](https://joplinapp.org/api/references/plugin_api/classes/joplinplugins.html#registercontentscript) must declare them under the `content_scripts` key of [manifest.json](https://joplinapp.org/api/references/plugin_manifest/).
+
+Each entry must be a path **relative to /src**, and **without extension**. The extension should not be included because it might change once the script is compiled. Each of these scripts will then be compiled to JavaScript and packaged into the plugin file. The content script files can be TypeScript (.ts or .tsx) or JavaScript.
+
+For example, assuming these files:
+
+```bash
+/src
+    index.ts                # Main plugin script
+    myContentScript.js      # One content script (JS)
+    otherContentScript.ts   # Another content script (TypeScript)
+    vendor/
+        test.ts             # Sub-directories are also supported
+```
+
+The `manifest.json` file would be:
+
+```json
+{
+    "manifest_version": 1,
+    "name": "Testing Content Scripts",
+    content_scripts: [
+        "myContentScript",
+        "otherContentScript",
+        "vendor/test"
+    ]
+}
+```
+
+Note in particular how the file path is relative to /src and the extensions removed.
+
+## License
+
+MIT © Laurent Cozic

packages/app-cli/tests/support/plugins/register_command/api/JoplinPlugins.d.ts

@@ -20,17 +20,21 @@ export default class JoplinPlugins {
      */
     register(script: Script): Promise<void>;
     /**
-     * Registers a new content script. Unlike regular plugin code, which
-     * runs in a separate process, content scripts run within the main
-     * process code and thus allow improved performances and more
-     * customisations in specific cases. It can be used for example to load
-     * a Markdown or editor plugin.
+     * Registers a new content script. Unlike regular plugin code, which runs in
+     * a separate process, content scripts run within the main process code and
+     * thus allow improved performances and more customisations in specific
+     * cases. It can be used for example to load a Markdown or editor plugin.
      *
-     * Note that registering a content script in itself will do nothing -
-     * it will only be loaded in specific cases by the relevant app modules
-     * (eg. the Markdown renderer or the code editor). So it is not a way
-     * to inject and run arbitrary code in the app, which for safety and
-     * performance reasons is not supported.
+     * Note that registering a content script in itself will do nothing - it
+     * will only be loaded in specific cases by the relevant app modules (eg.
+     * the Markdown renderer or the code editor). So it is not a way to inject
+     * and run arbitrary code in the app, which for safety and performance
+     * reasons is not supported.
+     *
+     * The plugin generator provides a way to build any content script you might
+     * want to package as well as its dependencies. See the [Plugin Generator
+     * doc](https://github.com/laurent22/joplin/blob/dev/packages/generator-joplin/README.md)
+     * for more information.
      *
      * * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script)
      * * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script)

packages/app-cli/tests/support/plugins/register_command/api/JoplinViewsDialogs.d.ts

@@ -47,6 +47,10 @@ export default class JoplinViewsDialogs {
      * Sets the dialog HTML content
      */
     setHtml(handle: ViewHandle, html: string): Promise<string>;
+    /**
+     * Adds and loads a new JS or CSS files into the dialog.
+     */
+    addScript(handle: ViewHandle, scriptPath: string): Promise<void>;
     /**
      * Sets the dialog buttons.
      */

packages/app-cli/tests/support/plugins/register_command/api/JoplinViewsPanels.d.ts

@@ -30,4 +30,16 @@ export default class JoplinViewsPanels {
      * Called when a message is sent from the webview (using postMessage).
      */
     onMessage(handle: ViewHandle, callback: Function): Promise<void>;
+    /**
+     * Shows the panel
+     */
+    show(handle: ViewHandle, show?: boolean): Promise<void>;
+    /**
+     * Hides the panel
+     */
+    hide(handle: ViewHandle): Promise<void>;
+    /**
+     * Tells whether the panel is visible or not
+     */
+    visible(handle: ViewHandle): Promise<boolean>;
 }