nodebb-plugin-markdown 12.1.7 → 12.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodebb-plugin-markdown",
-  "version": "12.1.7",
+  "version": "12.2.0",
   "description": "A Markdown parser for NodeBB",
   "main": "index.js",
   "repository": {

package/plugin.json

@@ -14,7 +14,8 @@
         "styles": "node_modules/highlight.js/styles"
     },
     "modules": {
-        "../admin/plugins/markdown.js": "./public/js/admin.js"
+        "../admin/plugins/markdown.js": "./public/js/admin.js",
+        "markdown.js": "./public/js/markdown.js"
     },
     "languages": "public/languages",
     "defaultLang": "en_GB",

package/public/js/admin.js

@@ -1,7 +1,5 @@
 'use strict';
 
-/* globals define, $, socket, bootbox */
-
 define('admin/plugins/markdown', ['settings', 'alerts'], function (Settings, alerts) {
 	var Markdown = {};
 
@@ -45,30 +43,7 @@ define('admin/plugins/markdown', ['settings', 'alerts'], function (Settings, ale
 		});
 
 		$('#save').on('click', function () {
-			Settings.save('markdown', $('.markdown-settings'), function () {
-				alerts.alert({
-					type: 'success',
-					alert_id: 'markdown-saved',
-					title: 'Reload Required',
-					message: 'Please reload your NodeBB to have your changes take effect',
-					clickfn: function () {
-						socket.emit('admin.reload');
-					},
-					timeout: 2500,
-				});
-			});
-		});
-
-		// Warning for "html" option
-		$('#html').on('change', function () {
-			var inputEl = $(this);
-			if (inputEl.prop('checked')) {
-				bootbox.confirm('Are you sure you wish to disable sanitisation of HTML? <strong>Doing so compromises your forum&apos;s client-side security, and allows malicious users to execute arbitrary javascript on other users&apos; browsers.</strong>', function (result) {
-					if (!result) {
-						inputEl.prop('checked', false);
-					}
-				});
-			}
+			Settings.save('markdown', $('.markdown-settings'));
 		});
 	};
 

package/public/js/client.js

@@ -1,339 +1,21 @@
 'use strict';
 
 (function () {
-	var Markdown = {};
-
-	$(window).on('action:composer.enhanced', function (evt, data) {
-		var textareaEl = data.postContainer.find('textarea');
-		Markdown.capturePaste(textareaEl);
-		Markdown.prepareFormattingTools();
-	});
-
-	Markdown.enhanceCheckbox = function (ev, data) {
-		if (!data.posts && !data.post) {
-			return;
-		} if (data.hasOwnProperty('post')) {
-			data.posts = [data.post];
-		}
-
-		var disable;
-		var checkboxEls;
-		data.posts.forEach(function (post) {
-			disable = !post.display_edit_tools;
-			checkboxEls = $('.posts li[data-pid="' + post.pid + '"] .content div.plugin-markdown input[type="checkbox"]');
-
-			checkboxEls.on('click', function (e) {
-				if (disable) {
-					// Find the post's checkboxes in DOM and make them readonly
-					e.preventDefault();
-				}
-
-				// Otherwise, edit the post to reflect state change
-				var _this = this;
-				var pid = $(this).parents('li[data-pid]').attr('data-pid');
-				var index = $(this).parents('.content').find('input[type="checkbox"]').toArray()
-					.reduce(function (memo, cur, index) {
-						if (cur === _this) {
-							memo = index;
-						}
-
-						return memo;
-					}, null);
-
-				socket.emit('plugins.markdown.checkbox.edit', {
-					pid: pid,
-					index: index,
-					state: $(_this).prop('checked'),
-				});
-			});
-		});
-	};
-
-	Markdown.capturePaste = function (targetEl) {
-		targetEl.on('paste', function (e) {
-			var triggers = [/^>\s*/, /^\s*\*\s+/, /^\s*\d+\.\s+/, /^\s{4,}/];
-			var start = e.target.selectionStart;
-			var line = getLine(targetEl.val(), start);
-
-			var trigger = triggers.reduce(function (regexp, cur) {
-				if (regexp) {
-					return regexp;
-				}
-
-				return cur.test(line) ? cur : false;
-			}, false);
-
-			var prefix = line.match(trigger);
-			if (prefix) {
-				prefix = prefix.shift();
-
-				var payload = e.originalEvent.clipboardData.getData('text');
-				var fixed = payload.replace(/^/gm, prefix).slice(prefix.length);
-
-				setTimeout(function () {
-					var replacement = targetEl.val().slice(0, start) + fixed + targetEl.val().slice(start + payload.length);
-					targetEl.val(replacement);
-				}, 0);
-			}
-		});
-
-		function getLine(text, selectionStart) {
-			// Break apart into lines, return the line the cursor is in
-			var lines = text.split('\n');
-
-			return lines.reduce(function (memo, cur) {
-				if (typeof memo !== 'number') {
-					return memo;
-				} if (selectionStart > (memo + cur.length)) {
-					return memo + cur.length + 1;
-				}
-
-				return cur;
-			}, 0);
-		}
-	};
-
-	Markdown.highlight = function (data) {
-		if (data instanceof jQuery.Event) {
-			highlight($(data.data.selector));
-		} else {
-			highlight(data);
-		}
-	};
-
-	Markdown.prepareFormattingTools = function () {
-		require([
-			'composer/formatting',
-			'composer/controls',
-			'translator',
-		], function (formatting, controls, translator) {
-			if (formatting && controls) {
-				translator.getTranslations(window.config.userLang || window.config.defaultLang, 'markdown', function (strings) {
-					formatting.addButtonDispatch('bold', function (textarea, selectionStart, selectionEnd) {
-						if (selectionStart === selectionEnd) {
-							var block = controls.getBlockData(textarea, '**', selectionStart);
-
-							if (block.in && block.atEnd) {
-								// At end of bolded string, move cursor past delimiters
-								controls.updateTextareaSelection(textarea, selectionStart + 2, selectionStart + 2);
-							} else {
-								controls.insertIntoTextarea(textarea, '**' + strings.bold + '**');
-								controls.updateTextareaSelection(
-									textarea, selectionStart + 2, selectionStart + strings.bold.length + 2
-								);
-							}
-						} else {
-							var wrapDelta = controls.wrapSelectionInTextareaWith(textarea, '**');
-							controls.updateTextareaSelection(
-								textarea, selectionStart + 2 + wrapDelta[0], selectionEnd + 2 - wrapDelta[1]
-							);
-						}
-					});
-
-					formatting.addButtonDispatch('italic', function (textarea, selectionStart, selectionEnd) {
-						if (selectionStart === selectionEnd) {
-							var block = controls.getBlockData(textarea, '*', selectionStart);
-
-							if (block.in && block.atEnd) {
-								// At end of italicised string, move cursor past delimiters
-								controls.updateTextareaSelection(textarea, selectionStart + 1, selectionStart + 1);
-							} else {
-								controls.insertIntoTextarea(textarea, '*' + strings.italic + '*');
-								controls.updateTextareaSelection(
-									textarea, selectionStart + 1, selectionStart + strings.italic.length + 1
-								);
-							}
-						} else {
-							var wrapDelta = controls.wrapSelectionInTextareaWith(textarea, '*');
-							controls.updateTextareaSelection(
-								textarea, selectionStart + 1 + wrapDelta[0], selectionEnd + 1 - wrapDelta[1]
-							);
-						}
-					});
-
-					formatting.addButtonDispatch('list', function (textarea, selectionStart, selectionEnd) {
-						if (selectionStart === selectionEnd) {
-							controls.insertIntoTextarea(textarea, '\n* ' + strings.list_item);
-
-							// Highlight "list item"
-							controls.updateTextareaSelection(
-								textarea, selectionStart + 3, selectionStart + strings.list_item.length + 3
-							);
-						} else {
-							const selectedText = $(textarea).val().substring(selectionStart, selectionEnd);
-							const newText = '* ' + selectedText.split('\n').join('\n* ');
-							controls.replaceSelectionInTextareaWith(textarea, newText);
-							controls.updateTextareaSelection(textarea, selectionStart, selectionEnd + (newText.length - selectedText.length))
-						}
-					});
-
-					formatting.addButtonDispatch('strikethrough', function (textarea, selectionStart, selectionEnd) {
-						if (selectionStart === selectionEnd) {
-							var block = controls.getBlockData(textarea, '~~', selectionStart);
-
-							if (block.in && block.atEnd) {
-								// At end of bolded string, move cursor past delimiters
-								controls.updateTextareaSelection(textarea, selectionStart + 2, selectionStart + 2);
-							} else {
-								controls.insertIntoTextarea(textarea, '~~' + strings.strikethrough_text + '~~');
-								controls.updateTextareaSelection(
-									textarea, selectionStart + 2, selectionEnd + strings.strikethrough_text.length + 2
-								);
-							}
-						} else {
-							var wrapDelta = controls.wrapSelectionInTextareaWith(textarea, '~~', '~~');
-							controls.updateTextareaSelection(
-								textarea, selectionStart + 2 + wrapDelta[0], selectionEnd + 2 - wrapDelta[1]
-							);
-						}
-					});
-
-					formatting.addButtonDispatch('code', function (textarea, selectionStart, selectionEnd) {
-						if (selectionStart === selectionEnd) {
-							controls.insertIntoTextarea(textarea, '```\n' + strings.code_text + '\n```');
-							controls.updateTextareaSelection(
-								textarea, selectionStart + 4, selectionEnd + strings.code_text.length + 4
-							);
-						} else {
-							var wrapDelta = controls.wrapSelectionInTextareaWith(textarea, '```\n', '\n```');
-							controls.updateTextareaSelection(
-								textarea, selectionStart + 4 + wrapDelta[0], selectionEnd + 4 - wrapDelta[1]
-							);
-						}
-					});
-
-					formatting.addButtonDispatch('link', function (textarea, selectionStart, selectionEnd) {
-						if (selectionStart === selectionEnd) {
-							controls.insertIntoTextarea(textarea, '[' + strings.link_text + '](' + strings.link_url + ')');
-							controls.updateTextareaSelection(
-								textarea,
-								selectionStart + strings.link_text.length + 3,
-								selectionEnd + strings.link_text.length + strings.link_url.length + 3
-							);
-						} else {
-							var wrapDelta = controls.wrapSelectionInTextareaWith(textarea, '[', '](' + strings.link_url + ')');
-							controls.updateTextareaSelection(
-								textarea, selectionEnd + 3 - wrapDelta[1], selectionEnd + strings.link_url.length + 3 - wrapDelta[1]
-							);
-						}
-					});
-
-					formatting.addButtonDispatch('picture-o', function (textarea, selectionStart, selectionEnd) {
-						if (selectionStart === selectionEnd) {
-							controls.insertIntoTextarea(textarea, '![' + strings.picture_text + '](' + strings.picture_url + ')');
-							controls.updateTextareaSelection(
-								textarea,
-								selectionStart + strings.picture_text.length + 4,
-								selectionEnd + strings.picture_text.length + strings.picture_url.length + 4
-							);
-						} else {
-							var wrapDelta = controls.wrapSelectionInTextareaWith(textarea, '![', '](' + strings.picture_url + ')');
-							controls.updateTextareaSelection(
-								textarea, selectionEnd + 4 - wrapDelta[1], selectionEnd + strings.picture_url.length + 4 - wrapDelta[1]
-							);
-						}
-					});
-				});
-			}
+	require(['markdown', 'components'], (markdown, components) => {
+		$(window).on('action:composer.enhanced', function (evt, data) {
+			var textareaEl = data.postContainer.find('textarea');
+			markdown.capturePaste(textareaEl);
+			markdown.prepareFormattingTools();
 		});
-	};
-
-	async function highlight(elements) {
-		if (parseInt(config.markdown.highlight, 10)) {
-			console.debug('[plugin/markdown] Initializing highlight.js');
-			let hljs;
-			let list;
-			let aliasMap = new Map();
-			switch(true) {
-				case config.markdown.hljsLanguages.includes('common'): {
-					({ default: hljs} = await import(`highlight.js/lib/common`));
-					list = 'common';
-					break;
-				}
-
-				case config.markdown.hljsLanguages.includes('all'): {
-					({ default: hljs} = await import(`highlight.js`));
-					list = 'all';
-					break;
-				}
-
-				default: {
-					({ default: hljs} = await import(`highlight.js/lib/core`));
-					list = 'core';
-				}
-			}
-			console.debug(`[plugins/markdown] Loaded ${list} hljs library`);
-
-			if (list !== 'all') {
-				await Promise.all(config.markdown.hljsLanguages.map(async (language) => {
-					if (['common', 'all'].includes(language)) {
-						return;
-					}
-
-					console.debug(`[plugins/markdown] Loading ${language} support`);
-					const { default: lang } = await import('../../node_modules/highlight.js/lib/languages/' + language + '.js');
-					hljs.registerLanguage(language, lang);
-				}));
-			}
-
-			// Build alias set
-			hljs.listLanguages().forEach((language) => {
-				const { aliases } = hljs.getLanguage(language);
-				if (aliases && Array.isArray(aliases)) {
-					aliases.forEach((alias) => {
-						aliasMap.set(alias, language);
-					});
-				}
-
-				aliasMap.set(language, language);
-			});
-
-			console.debug(`[plugins/markdown] Loading support for line numbers`);
-			window.hljs = hljs;
-			require('highlightjs-line-numbers.js');
-
-			elements.each(function (i, block) {
-				const parentNode = $(block.parentNode);
-				if (parentNode.hasClass('markdown-highlight')) {
-					return;
-				}
-				parentNode.addClass('markdown-highlight');
-
-				// Default language if set in ACP
-				if (!Array.prototype.some.call(block.classList, (className) => className.startsWith('language-')) && config.markdown.defaultHighlightLanguage) {
-					block.classList.add(`language-${config.markdown.defaultHighlightLanguage}`);
-				}
-
-				window.hljs.highlightElement(block);
-
-				// Check detected language against whitelist and add lines if enabled
-				const classIterator = block.classList.values();
-				for(className of classIterator) {
-					if (className.startsWith('language-')) {
-						const language = className.split('-')[1];
-						const list = config.markdown.highlightLinesLanguageList;
-						if (aliasMap.has(language) && list && list.includes(aliasMap.get(language))) {
-							$(block).attr('data-lines', 1);
-							window.hljs.lineNumbersBlock(block);
-						}
-						break;
-					}
-				}
-			});
-		}
-	}
-
-	$(window).on('action:composer.preview', {
-		selector: '.composer .preview pre code',
-	}, Markdown.highlight);
 
-	$(window).on('action:topic.loaded', Markdown.enhanceCheckbox);
-	$(window).on('action:posts.loaded', Markdown.enhanceCheckbox);
-	$(window).on('action:posts.edited', Markdown.enhanceCheckbox);
+		$(window).on('action:composer.preview', {
+			selector: '.composer .preview pre code',
+		}, markdown.highlight);
 
-	$(window).on('action:posts.loaded action:topic.loaded action:posts.edited', function () {
-		require(['components'], function (components) {
-			Markdown.highlight(components.get('post/content').find('pre code'));
+		$(window).on('action:posts.loaded action:topic.loaded action:posts.edited', function (ev, data) {
+			markdown.highlight(components.get('post/content').find('pre code'));
+			markdown.enhanceCheckbox(ev, data);
+			markdown.markExternalLinks();
 		});
 	});
 }());