Plugin Generator release v1.6.4

Might fix this: https://travis-ci.org/github/laurent22/joplin/jobs/752585346#L1352

.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

.eslintrc.js

@@ -1,4 +1,5 @@
 module.exports = {
+	'root': true,
 	'env': {
 		'browser': true,
 		'es6': true,
@@ -15,7 +16,8 @@ module.exports = {
 		'Atomics': 'readonly',
 		'SharedArrayBuffer': 'readonly',
 
-		// Jasmine variables
+		// Jest variables
+		'test': 'readonly',
 		'expect': 'readonly',
 		'describe': 'readonly',
 		'it': 'readonly',
@@ -23,7 +25,7 @@ module.exports = {
 		'afterAll': 'readonly',
 		'beforeEach': 'readonly',
 		'afterEach': 'readonly',
-		'jasmine': 'readonly',
+		'jest': 'readonly',
 
 		// React Native variables
 		'__DEV__': 'readonly',
@@ -33,6 +35,9 @@ module.exports = {
 		'chrome': 'readonly',
 		'browser': 'readonly',
 
+		// Server admin UI global variables
+		'onDocumentReady': 'readonly',
+
 		'tinymce': 'readonly',
 	},
 	'parserOptions': {
@@ -60,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'],
 
@@ -126,10 +136,37 @@ module.exports = {
 		{
 			// enable the rule specifically for TypeScript files
 			'files': ['*.ts', '*.tsx'],
+			'parserOptions': {
+				// Required for @typescript-eslint/no-floating-promises
+				'project': './tsconfig.eslint.json',
+			},
 			'rules': {
 				// Warn only because it would make it difficult to convert JS classes to TypeScript, unless we
 				// make everything public which is not great. New code however should specify member accessibility.
 				'@typescript-eslint/explicit-member-accessibility': ['warn'],
+				'@typescript-eslint/type-annotation-spacing': ['error', { 'before': false, 'after': true }],
+				'@typescript-eslint/comma-dangle': ['error', {
+					'arrays': 'always-multiline',
+					'objects': 'always-multiline',
+					'imports': 'always-multiline',
+					'exports': 'always-multiline',
+					'enums': 'always-multiline',
+					'generics': 'always-multiline',
+					'tuples': 'always-multiline',
+					'functions': 'never',
+				}],
+				'@typescript-eslint/semi': ['error', 'always'],
+				'@typescript-eslint/member-delimiter-style': ['error', {
+					'multiline': {
+						'delimiter': 'semi',
+						'requireLast': true,
+					},
+					'singleline': {
+						'delimiter': 'semi',
+						'requireLast': false,
+					},
+				}],
+				'@typescript-eslint/no-floating-promises': ['error'],
 			},
 		},
 	],

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

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

.github/ISSUE_TEMPLATE/config.yml

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

.github/PULL_REQUEST_TEMPLATE

@@ -20,6 +20,6 @@ If it's not related to any platform (such as a translation, change to the docume
 
 Then please append the issue that you've addressed or fixed. Use "Resolves #123" for new features or improvements and "Fixes #123" for bug fixes.
 
-AND PLEASE READ THE GUIDE: https://github.com/laurent22/joplin/blob/master/CONTRIBUTING.md
+AND PLEASE READ THE GUIDE: https://github.com/laurent22/joplin/blob/dev/CONTRIBUTING.md
 
 -->

.travis.yml

@@ -1,5 +1,5 @@
 # Only build tags (Doesn't work - doesn't build anything)
-if: tag IS present OR type = pull_request
+if: tag IS present OR type = pull_request OR branch = dev
 
 rvm: 2.3.3
 
@@ -15,21 +15,30 @@ branches:
 matrix:
   include:
     - os: osx
-      osx_image: xcode9.0
+      osx_image: xcode12
       language: node_js
-      node_js: "10"
-      env:
-        - ELECTRON_CACHE=$HOME/.cache/electron
-        - ELECTRON_BUILDER_CACHE=$HOME/.cache/electron-builder
+      node_js: "12"
+      cache:
+        npm: false
+      # Cache was disabled because when changing from node_js 10 to node_js 12
+      # it was still using build files from Node 10 when building SQLite which
+      # was making it fail. Might be ok to re-enable later on, although it doesn't
+      # make build that much faster.
+      #
+      # env:
+      #   - ELECTRON_CACHE=$HOME/.cache/electron
+      #   - ELECTRON_BUILDER_CACHE=$HOME/.cache/electron-builder
 
     - os: linux
       sudo: required
       dist: trusty
       language: node_js
-      node_js: "10"
-      env:
-        - ELECTRON_CACHE=$HOME/.cache/electron
-        - ELECTRON_BUILDER_CACHE=$HOME/.cache/electron-builder
+      node_js: "12"
+      cache:
+        npm: false
+      # env:
+      #   - ELECTRON_CACHE=$HOME/.cache/electron
+      #   - ELECTRON_BUILDER_CACHE=$HOME/.cache/electron-builder
 
 # cache:
 #   directories:
@@ -59,23 +68,24 @@ before_install:
 
 script:
   - |
+    # Prints some env variables
+    echo "TRAVIS_OS_NAME=$TRAVIS_OS_NAME"
+    echo "TRAVIS_BRANCH=$TRAVIS_BRANCH"
+    echo "TRAVIS_PULL_REQUEST=$TRAVIS_PULL_REQUEST"
+    echo "TRAVIS_TAG=$TRAVIS_TAG"
+
     # Install tools
     npm install
-    cd Tools
-    npm install
-    cd ..
 
     # Run test units.
     # Only do it for pull requests because Travis randomly fails to run them
     # and that would break the desktop release.
-    if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then
-      cd CliClient
+    if [ "$TRAVIS_PULL_REQUEST" != "false" ] || [ "$TRAVIS_BRANCH" = "dev" ]; then
       npm run test-ci
       testResult=$?
       if [ $testResult -ne 0 ]; then
         exit $testResult
       fi
-      cd ..
     fi
 
     # Run linter for pull requests only - this is so that
@@ -93,7 +103,7 @@ script:
     # tool like poedit. Doing it for Linux only is sufficient.
     if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then
       if [ "$TRAVIS_OS_NAME" != "osx" ]; then
-        node Tools/validate-translation.js
+        node packages/tools/validate-translation.js
         testResult=$?
         if [ $testResult -ne 0 ]; then
           exit $testResult
@@ -102,7 +112,7 @@ script:
     fi
 
     # Find out if we should run the build or not. Electron-builder gets stuck when
-    # builing PRs so we disable it in this case. The Linux build should provide
+    # building PRs so we disable it in this case. The Linux build should provide
     # enough info if the app builds or not.
     # https://github.com/electron-userland/electron-builder/issues/4263
     if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then
@@ -112,5 +122,17 @@ script:
     fi
 
     # Prepare the Electron app and build it
-    cd ElectronClient
-    USE_HARD_LINKS=false npm run dist
+    #
+    # If the current tag is a desktop release tag (starts with "v", such as
+    # "v1.4.7"), we build and publish to github
+    #
+    # Otherwise we only build but don't publish to GitHub. It helps finding
+    # out any issue in pull requests and dev branch.
+    
+    cd packages/app-desktop
+
+    if [[ $TRAVIS_TAG = v* ]]; then
+      USE_HARD_LINKS=false npm run dist
+    else
+      USE_HARD_LINKS=false npm run dist -- --publish=never
+    fi

Assets/PluginDocTheme/helpers/index.js

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

Assets/PluginDocTheme/partials/header.hbs

@@ -13,7 +13,7 @@
                         <li class="state failure">The search index is not available</li>
                     </ul>
 
-                    <a href="{{relativeURL "classes/sandbox.html"}}" class="title">{{project.name}}</a>
+                    <a href="{{relativeURL "classes/joplin.html"}}" class="title">{{project.name}}</a>
                 </div>
 
                 <div class="table-cell" id="tsd-widgets">

Assets/TinyMCE/IconPack/gulpfile.js

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

Assets/TinyMCE/JoplinLists/Gruntfile.js

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

Assets/TinyMCE/JoplinLists/README.md

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

Assets/TinyMCE/JoplinLists/package.json

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

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

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