nodebb-plugin-markdown 12.2.1 → 12.2.2

package/.jshintrc

@@ -1,86 +1,86 @@
-{
-    // JSHint Default Configuration File (as on JSHint website)
-    // See http://jshint.com/docs/ for more details
-
-    "maxerr" : 50, // {int} Maximum error before stopping
-
-    // Enforcing
-    "bitwise" : true, // true: Prohibit bitwise operators (&, |, ^, etc.)
-    "camelcase" : false, // true: Identifiers must be in camelCase
-    "curly" : true, // true: Require {} for every new block or scope
-    "eqeqeq" : true, // true: Require triple equals (===) for comparison
-    "forin" : true, // true: Require filtering for..in loops with obj.hasOwnProperty()
-    "immed" : false, // true: Require immediate invocations to be wrapped in parens e.g. `(function () { } ());`
-    "indent" : 4, // {int} Number of spaces to use for indentation
-    "latedef" : false, // true: Require variables/functions to be defined before being used
-    "newcap" : false, // true: Require capitalization of all constructor functions e.g. `new F()`
-    "noarg" : true, // true: Prohibit use of `arguments.caller` and `arguments.callee`
-    "noempty" : true, // true: Prohibit use of empty blocks
-    "nonew" : false, // true: Prohibit use of constructors for side-effects (without assignment)
-    "plusplus" : false, // true: Prohibit use of `++` & `--`
-    "quotmark" : false, // Quotation mark consistency:
-                                // false : do nothing (default)
-                                // true : ensure whatever is used is consistent
-                                // "single" : require single quotes
-                                // "double" : require double quotes
-    "undef" : true, // true: Require all non-global variables to be declared (prevents global leaks)
-    "unused" : true, // true: Require all defined variables be used
-    "strict" : true, // true: Requires all functions run in ES5 Strict Mode
-    "trailing" : false, // true: Prohibit trailing whitespaces
-    "maxparams" : false, // {int} Max number of formal params allowed per function
-    "maxdepth" : false, // {int} Max depth of nested blocks (within functions)
-    "maxstatements" : false, // {int} Max number statements per function
-    "maxcomplexity" : false, // {int} Max cyclomatic complexity per function
-    "maxlen" : false, // {int} Max number of characters per line
-
-    // Relaxing
-    "asi" : false, // true: Tolerate Automatic Semicolon Insertion (no semicolons)
-    "boss" : false, // true: Tolerate assignments where comparisons would be expected
-    "debug" : false, // true: Allow debugger statements e.g. browser breakpoints.
-    "eqnull" : false, // true: Tolerate use of `== null`
-    "es5" : false, // true: Allow ES5 syntax (ex: getters and setters)
-    "esnext" : false, // true: Allow ES.next (ES6) syntax (ex: `const`)
-    "moz" : false, // true: Allow Mozilla specific syntax (extends and overrides esnext features)
-                                 // (ex: `for each`, multiple try/catch, function expression…)
-    "evil" : false, // true: Tolerate use of `eval` and `new Function()`
-    "expr" : false, // true: Tolerate `ExpressionStatement` as Programs
-    "funcscope" : false, // true: Tolerate defining variables inside control statements"
-    "globalstrict" : false, // true: Allow global "use strict" (also enables 'strict')
-    "iterator" : false, // true: Tolerate using the `__iterator__` property
-    "lastsemic" : false, // true: Tolerate omitting a semicolon for the last statement of a 1-line block
-    "laxbreak" : false, // true: Tolerate possibly unsafe line breakings
-    "laxcomma" : false, // true: Tolerate comma-first style coding
-    "loopfunc" : false, // true: Tolerate functions being defined in loops
-    "multistr" : false, // true: Tolerate multi-line strings
-    "proto" : false, // true: Tolerate using the `__proto__` property
-    "scripturl" : false, // true: Tolerate script-targeted URLs
-    "smarttabs" : false, // true: Tolerate mixed tabs/spaces when used for alignment
-    "shadow" : false, // true: Allows re-define variables later in code e.g. `var x=1; x=2;`
-    "sub" : false, // true: Tolerate using `[]` notation when it can still be expressed in dot notation
-    "supernew" : false, // true: Tolerate `new function () { ... };` and `new Object;`
-    "validthis" : false, // true: Tolerate using this in a non-constructor function
-
-    // Environments
-    "browser" : true, // Web Browser (window, document, etc)
-    "couch" : false, // CouchDB
-    "devel" : true, // Development/debugging (alert, confirm, etc)
-    "dojo" : false, // Dojo Toolkit
-    "jquery" : true, // jQuery
-    "mootools" : false, // MooTools
-    "node" : true, // Node.js
-    "nonstandard" : false, // Widely adopted globals (escape, unescape, etc)
-    "prototypejs" : false, // Prototype and Scriptaculous
-    "rhino" : false, // Rhino
-    "worker" : false, // Web Workers
-    "wsh" : false, // Windows Scripting Host
-    "yui" : false, // Yahoo User Interface
-
-    // Legacy
-    "nomen" : false, // true: Prohibit dangling `_` in variables
-    "onevar" : false, // true: Allow only one `var` statement per function
-    "passfail" : false, // true: Stop on first error
-    "white" : false, // true: Check against strict whitespace and indentation rules
-
-    // Custom Globals
-    "globals" : {} // additional predefined global variables
+{
+    // JSHint Default Configuration File (as on JSHint website)
+    // See http://jshint.com/docs/ for more details
+
+    "maxerr" : 50, // {int} Maximum error before stopping
+
+    // Enforcing
+    "bitwise" : true, // true: Prohibit bitwise operators (&, |, ^, etc.)
+    "camelcase" : false, // true: Identifiers must be in camelCase
+    "curly" : true, // true: Require {} for every new block or scope
+    "eqeqeq" : true, // true: Require triple equals (===) for comparison
+    "forin" : true, // true: Require filtering for..in loops with obj.hasOwnProperty()
+    "immed" : false, // true: Require immediate invocations to be wrapped in parens e.g. `(function () { } ());`
+    "indent" : 4, // {int} Number of spaces to use for indentation
+    "latedef" : false, // true: Require variables/functions to be defined before being used
+    "newcap" : false, // true: Require capitalization of all constructor functions e.g. `new F()`
+    "noarg" : true, // true: Prohibit use of `arguments.caller` and `arguments.callee`
+    "noempty" : true, // true: Prohibit use of empty blocks
+    "nonew" : false, // true: Prohibit use of constructors for side-effects (without assignment)
+    "plusplus" : false, // true: Prohibit use of `++` & `--`
+    "quotmark" : false, // Quotation mark consistency:
+                                // false : do nothing (default)
+                                // true : ensure whatever is used is consistent
+                                // "single" : require single quotes
+                                // "double" : require double quotes
+    "undef" : true, // true: Require all non-global variables to be declared (prevents global leaks)
+    "unused" : true, // true: Require all defined variables be used
+    "strict" : true, // true: Requires all functions run in ES5 Strict Mode
+    "trailing" : false, // true: Prohibit trailing whitespaces
+    "maxparams" : false, // {int} Max number of formal params allowed per function
+    "maxdepth" : false, // {int} Max depth of nested blocks (within functions)
+    "maxstatements" : false, // {int} Max number statements per function
+    "maxcomplexity" : false, // {int} Max cyclomatic complexity per function
+    "maxlen" : false, // {int} Max number of characters per line
+
+    // Relaxing
+    "asi" : false, // true: Tolerate Automatic Semicolon Insertion (no semicolons)
+    "boss" : false, // true: Tolerate assignments where comparisons would be expected
+    "debug" : false, // true: Allow debugger statements e.g. browser breakpoints.
+    "eqnull" : false, // true: Tolerate use of `== null`
+    "es5" : false, // true: Allow ES5 syntax (ex: getters and setters)
+    "esnext" : false, // true: Allow ES.next (ES6) syntax (ex: `const`)
+    "moz" : false, // true: Allow Mozilla specific syntax (extends and overrides esnext features)
+                                 // (ex: `for each`, multiple try/catch, function expression…)
+    "evil" : false, // true: Tolerate use of `eval` and `new Function()`
+    "expr" : false, // true: Tolerate `ExpressionStatement` as Programs
+    "funcscope" : false, // true: Tolerate defining variables inside control statements"
+    "globalstrict" : false, // true: Allow global "use strict" (also enables 'strict')
+    "iterator" : false, // true: Tolerate using the `__iterator__` property
+    "lastsemic" : false, // true: Tolerate omitting a semicolon for the last statement of a 1-line block
+    "laxbreak" : false, // true: Tolerate possibly unsafe line breakings
+    "laxcomma" : false, // true: Tolerate comma-first style coding
+    "loopfunc" : false, // true: Tolerate functions being defined in loops
+    "multistr" : false, // true: Tolerate multi-line strings
+    "proto" : false, // true: Tolerate using the `__proto__` property
+    "scripturl" : false, // true: Tolerate script-targeted URLs
+    "smarttabs" : false, // true: Tolerate mixed tabs/spaces when used for alignment
+    "shadow" : false, // true: Allows re-define variables later in code e.g. `var x=1; x=2;`
+    "sub" : false, // true: Tolerate using `[]` notation when it can still be expressed in dot notation
+    "supernew" : false, // true: Tolerate `new function () { ... };` and `new Object;`
+    "validthis" : false, // true: Tolerate using this in a non-constructor function
+
+    // Environments
+    "browser" : true, // Web Browser (window, document, etc)
+    "couch" : false, // CouchDB
+    "devel" : true, // Development/debugging (alert, confirm, etc)
+    "dojo" : false, // Dojo Toolkit
+    "jquery" : true, // jQuery
+    "mootools" : false, // MooTools
+    "node" : true, // Node.js
+    "nonstandard" : false, // Widely adopted globals (escape, unescape, etc)
+    "prototypejs" : false, // Prototype and Scriptaculous
+    "rhino" : false, // Rhino
+    "worker" : false, // Web Workers
+    "wsh" : false, // Windows Scripting Host
+    "yui" : false, // Yahoo User Interface
+
+    // Legacy
+    "nomen" : false, // true: Prohibit dangling `_` in variables
+    "onevar" : false, // true: Allow only one `var` statement per function
+    "passfail" : false, // true: Stop on first error
+    "white" : false, // true: Check against strict whitespace and indentation rules
+
+    // Custom Globals
+    "globals" : {} // additional predefined global variables
 }

package/README.md

@@ -1,9 +1,9 @@
-# NodeBB Markdown Parser
-
-This NodeBB plugin is a parser that allows users to write posts using [Markdown](https://daringfireball.net/projects/markdown/).
-
-To customise options for the parser, please consult the "Markdown" page in the administration panel, under the "Plugins" heading.
-
-## Installation
-
-    npm install nodebb-plugin-markdown
+# NodeBB Markdown Parser
+
+This NodeBB plugin is a parser that allows users to write posts using [Markdown](https://daringfireball.net/projects/markdown/).
+
+To customise options for the parser, please consult the "Markdown" page in the administration panel, under the "Plugins" heading.
+
+## Installation
+
+    npm install nodebb-plugin-markdown

package/package.json

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

package/public/js/client.js

@@ -2,6 +2,41 @@
 
 (function () {
 	require(['markdown', 'components'], (markdown, components) => {
+		async function initHljs() {
+			if (window.hljs) {
+				return;
+			}
+			console.debug('[plugin/markdown] Initializing highlight.js');
+			let hljs;
+			let list;
+			if (config.markdown.hljsLanguages.includes('common')) {
+				({ default: hljs} = await import(`highlight.js/lib/common`));
+				list = 'common';
+			} else if (config.markdown.hljsLanguages.includes('all')) {
+				({ default: hljs} = await import(`highlight.js`));
+				list = 'all';
+			} else {
+				({ 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);
+				}));
+			}
+			window.hljs = hljs;
+			markdown.buildAliasMap();
+		}
+
 		$(window).on('action:composer.enhanced', function (evt, data) {
 			var textareaEl = data.postContainer.find('textarea');
 			markdown.capturePaste(textareaEl);
@@ -10,9 +45,13 @@
 
 		$(window).on('action:composer.preview', {
 			selector: '.composer .preview pre code',
-		}, markdown.highlight);
+		}, async (params) => {
+			await initHljs();
+			markdown.highlight(params)
+		});
 
-		$(window).on('action:posts.loaded action:topic.loaded action:posts.edited', function (ev, data) {
+		$(window).on('action:posts.loaded action:topic.loaded action:posts.edited', async function (ev, data) {
+			await initHljs();
 			markdown.highlight(components.get('post/content').find('pre code'));
 			markdown.enhanceCheckbox(ev, data);
 			markdown.markExternalLinks();

package/public/js/markdown.js

@@ -251,45 +251,11 @@ export function highlight(data) {
 	}
 };
 
-async function processHighlight(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;
-				}
+const aliasMap = new Map();
 
-				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
+export function buildAliasMap() {
+	if (window.hljs) {
+		const hljs = window.hljs;
 		hljs.listLanguages().forEach((language) => {
 			const { aliases } = hljs.getLanguage(language);
 			if (aliases && Array.isArray(aliases)) {
@@ -300,9 +266,19 @@ async function processHighlight(elements) {
 
 			aliasMap.set(language, language);
 		});
+	}
+}
+
+async function processHighlight(elements) {
+	if (parseInt(config.markdown.highlight, 10)) {
+		const hljs = window.hljs;
+		if (!hljs) {
+			console.debug(`[plugins/markdown] Tryin to highlight without initializing hljs`);
+			return;
+		}
 
 		console.debug(`[plugins/markdown] Loading support for line numbers`);
-		window.hljs = hljs;
+
 		require('highlightjs-line-numbers.js');
 
 		elements.each(function (i, block) {
@@ -321,7 +297,7 @@ async function processHighlight(elements) {
 
 			// Check detected language against whitelist and add lines if enabled
 			const classIterator = block.classList.values();
-			for(className of classIterator) {
+			for (const className of classIterator) {
 				if (className.startsWith('language-')) {
 					const language = className.split('-')[1];
 					const list = config.markdown.highlightLinesLanguageList;

package/public/languages/de/markdown.json

@@ -1,11 +1,11 @@
-{
-	"bold": "Fettschrift",
-	"italic": "Kursivschrift",
-	"list_item": "Listenpunkt",
-	"strikethrough_text": "Durchgestrichen",
-	"link_text": "Link Text",
-	"link_url": "Link Adresse",
-	"picture_text": "Bild Text",
-	"picture_url": "Bild Link",
-	"help_text": "Dieses Forum unterstützt Markdown. Für mehr Informationen, [hier klicken](http://commonmark.org/help/)"
-}
+{
+	"bold": "Fettschrift",
+	"italic": "Kursivschrift",
+	"list_item": "Listenpunkt",
+	"strikethrough_text": "Durchgestrichen",
+	"link_text": "Link Text",
+	"link_url": "Link Adresse",
+	"picture_text": "Bild Text",
+	"picture_url": "Bild Link",
+	"help_text": "Dieses Forum unterstützt Markdown. Für mehr Informationen, [hier klicken](http://commonmark.org/help/)"
+}

package/public/languages/en-GB/markdown.json

@@ -1,12 +1,12 @@
-{
-	"bold": "bolded text",
-	"italic": "italicised text",
-	"list_item": "list item",
-	"strikethrough_text": "strikethrough text",
-	"code_text": "code_text",
-	"link_text": "link text",
-	"link_url": "link url",
-	"picture_text": "alt text",
-	"picture_url": "image url",
-	"help_text": "This forum is powered by Markdown. For full documentation, [click here](http://commonmark.org/help/)"
+{
+	"bold": "bolded text",
+	"italic": "italicised text",
+	"list_item": "list item",
+	"strikethrough_text": "strikethrough text",
+	"code_text": "code_text",
+	"link_text": "link text",
+	"link_url": "link url",
+	"picture_text": "alt text",
+	"picture_url": "image url",
+	"help_text": "This forum is powered by Markdown. For full documentation, [click here](http://commonmark.org/help/)"
 }

package/public/languages/fa-IR/markdown.json

@@ -1,11 +1,11 @@
-{
-	"bold": "متن پررنگ",
-	"italic": "متن ایتالیک ( کج )",
-	"list_item": "لیست",
-	"strikethrough_text": "متن خط خورده",
-	"link_text": "متن لینک",
-	"link_url": "آدرس لینک",
-	"picture_text": "متن جایگزین",
-	"picture_url": "آدرس عکس",
-	"help_text": "این انجمن از زبان مارک دون استفاده می کند، برای اطلاعات بیشتر [اینجا](http://commonmark.org/help/) کلیک کنید!"
-}
+{
+	"bold": "متن پررنگ",
+	"italic": "متن ایتالیک ( کج )",
+	"list_item": "لیست",
+	"strikethrough_text": "متن خط خورده",
+	"link_text": "متن لینک",
+	"link_url": "آدرس لینک",
+	"picture_text": "متن جایگزین",
+	"picture_url": "آدرس عکس",
+	"help_text": "این انجمن از زبان مارک دون استفاده می کند، برای اطلاعات بیشتر [اینجا](http://commonmark.org/help/) کلیک کنید!"
+}

package/public/languages/fr/markdown.json

@@ -1,11 +1,11 @@
-{
-	"bold": "texte en gras",
-	"italic": "texte en italique",
-	"list_item": "élément de liste",
-	"strikethrough_text": "strikethrough text",
-	"link_text": "texte du lien",
-	"link_url": "url du lien",
-	"picture_text": "text alternatif",
-	"picture_url": "url de l'image",
-	"help_text": "Ce forum utilise la syntaxe Markdown. Pour accéder à la documentation, suivre ce [lien](http://commonmark.org/help/)"
-}
+{
+	"bold": "texte en gras",
+	"italic": "texte en italique",
+	"list_item": "élément de liste",
+	"strikethrough_text": "strikethrough text",
+	"link_text": "texte du lien",
+	"link_url": "url du lien",
+	"picture_text": "text alternatif",
+	"picture_url": "url de l'image",
+	"help_text": "Ce forum utilise la syntaxe Markdown. Pour accéder à la documentation, suivre ce [lien](http://commonmark.org/help/)"
+}

package/public/languages/he/markdown.json

@@ -1,12 +1,12 @@
-{
-	"bold": "טקסט מודגש",
-	"italic": "טקסט נטוי",
-	"list_item": "פריט רשימה",
-	"strikethrough_text": "קו חוצה",
-	"code_text": "קוד",
-	"link_text": "טקסט קישור",
-	"link_url": "כתובת קישור",
-	"picture_text": "כיתוב בבעיות טעינה",
-	"picture_url": "כתובת תמונה",
-	"help_text": "הפורום עובד עם Markdown. להסבר מלא, [לחץ כאן](http://commonmark.org/help/)"
-}
+{
+	"bold": "טקסט מודגש",
+	"italic": "טקסט נטוי",
+	"list_item": "פריט רשימה",
+	"strikethrough_text": "קו חוצה",
+	"code_text": "קוד",
+	"link_text": "טקסט קישור",
+	"link_url": "כתובת קישור",
+	"picture_text": "כיתוב בבעיות טעינה",
+	"picture_url": "כתובת תמונה",
+	"help_text": "הפורום עובד עם Markdown. להסבר מלא, [לחץ כאן](http://commonmark.org/help/)"
+}

package/public/languages/pl/markdown.json

@@ -1,11 +1,11 @@
-{
-	"bold": "pogrubienie",
-	"italic": "pochylenie",
-	"list_item": "wypunktowanie",
-	"strikethrough_text": "przekreślenie",
-	"link_text": "tekst odnośnika",
-	"link_url": "url odnośnika",
-	"picture_text": "text alternatywny",
-	"picture_url": "url obrazu",
-	"help_text": "Forum działa dzięki Markdown. By uzyskać pełną dokumentację, [kliknij tutaj](http://commonmark.org/help/)"
-}
+{
+	"bold": "pogrubienie",
+	"italic": "pochylenie",
+	"list_item": "wypunktowanie",
+	"strikethrough_text": "przekreślenie",
+	"link_text": "tekst odnośnika",
+	"link_url": "url odnośnika",
+	"picture_text": "text alternatywny",
+	"picture_url": "url obrazu",
+	"help_text": "Forum działa dzięki Markdown. By uzyskać pełną dokumentację, [kliknij tutaj](http://commonmark.org/help/)"
+}

package/public/languages/tr/markdown.json

@@ -1,11 +1,11 @@
-{
-	"bold": "kalın yazı",
-	"italic": "İtalik yazı",
-	"list_item": "liste madde",
-	"strikethrough_text": "Üstü çizili metin",
-	"link_text": "bağlantı metni",
-	"link_url": "link url",
-	"picture_text": "alt metni",
-	"picture_url": "görsel url",
-	"help_text": "This forum is powered by Markdown. For full documentation, [click here](http://commonmark.org/help/)"
-}
+{
+	"bold": "kalın yazı",
+	"italic": "İtalik yazı",
+	"list_item": "liste madde",
+	"strikethrough_text": "Üstü çizili metin",
+	"link_text": "bağlantı metni",
+	"link_url": "link url",
+	"picture_text": "alt metni",
+	"picture_url": "görsel url",
+	"help_text": "This forum is powered by Markdown. For full documentation, [click here](http://commonmark.org/help/)"
+}

package/public/languages/zh-CN/markdown.json

@@ -1,11 +1,11 @@
-{
-	"bold": "粗体字",
-	"italic": "斜体字",
-	"list_item": "列表",
-	"strikethrough_text": "删除线",
-	"link_text": "链接文本",
-	"link_url": "链接地址",
-	"picture_text": "替代文字",
-	"picture_url": "图片地址",
-	"help_text": "该论坛使用 Markdown 语法。[点此查看](http://commonmark.org/help/) 语法说明。"
-}
+{
+	"bold": "粗体字",
+	"italic": "斜体字",
+	"list_item": "列表",
+	"strikethrough_text": "删除线",
+	"link_text": "链接文本",
+	"link_url": "链接地址",
+	"picture_text": "替代文字",
+	"picture_url": "图片地址",
+	"help_text": "该论坛使用 Markdown 语法。[点此查看](http://commonmark.org/help/) 语法说明。"
+}