nodebb-plugin-markdown 13.1.0 → 13.1.2

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/eslint.config.mjs

@@ -0,0 +1,10 @@
+'use strict';
+
+import serverConfig from 'eslint-config-nodebb';
+import publicConfig from 'eslint-config-nodebb/public';
+
+export default [
+	...publicConfig,
+	...serverConfig,
+];
+

package/index.js

@@ -167,6 +167,7 @@ const Markdown = {
 		({ env } = await plugins.hooks.fire('filter:markdown.beforeParse', { env, data: Object.freeze({ ...data }) }));
 
 		if (data.type === 'markdown') {
+			// core is expecting markdown to come back, bypass parsing
 			env.parse = false;
 		} else if (activitypub.helpers.isUri(data.postData.pid)) {
 			if (data.postData.sourceContent) {
@@ -282,15 +283,12 @@ const Markdown = {
 
 		// Update renderer to add some classes to all images
 		const renderImage = parser.renderer.rules.image || function (tokens, idx, options, env, self) {
-			// eslint-disable-next-line prefer-spread,prefer-rest-params
 			return self.renderToken.apply(self, arguments);
 		};
 		const renderLink = parser.renderer.rules.link_open || function (tokens, idx, options, env, self) {
-			// eslint-disable-next-line prefer-spread,prefer-rest-params
 			return self.renderToken.apply(self, arguments);
 		};
 		const renderTable = parser.renderer.rules.table_open || function (tokens, idx, options, env, self) {
-			// eslint-disable-next-line prefer-spread,prefer-rest-params
 			return self.renderToken.apply(self, arguments);
 		};
 

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "nodebb-plugin-markdown",
-  "version": "13.1.0",
+  "version": "13.1.2",
   "description": "A Markdown parser for NodeBB",
   "main": "index.js",
   "repository": {
     "type": "git",
     "url": "https://github.com/julianlam/nodebb-plugin-markdown"
   },
+  "scripts": {
+    "lint": "eslint ."
+  },
   "keywords": [
     "nodebb",
     "plugin",
@@ -41,9 +44,9 @@
   "devDependencies": {
     "@commitlint/cli": "16.2.1",
     "@commitlint/config-angular": "16.2.1",
-    "eslint": "8.x",
-    "eslint-config-nodebb": "0.1.1",
-    "eslint-plugin-import": "2.x",
+    "eslint": "^9.25.1",
+    "eslint-config-nodebb": "^1.1.4",
+    "eslint-plugin-import": "^2.31.0",
     "husky": "7.0.4",
     "lint-staged": "12.3.5"
   }

package/public/js/admin.js

@@ -1,6 +1,6 @@
 'use strict';
 
-define('admin/plugins/markdown', ['settings', 'alerts'], function (Settings, alerts) {
+define('admin/plugins/markdown', ['settings'], function (Settings) {
 	var Markdown = {};
 
 	Markdown.init = function () {
@@ -31,7 +31,7 @@ define('admin/plugins/markdown', ['settings', 'alerts'], function (Settings, ale
 			};
 
 			// Set defaults
-			for (var setting in defaults) {
+			for (const setting of Object.keys(defaults)) {
 				if (!settings.hasOwnProperty(setting)) {
 					if (typeof defaults[setting] === 'boolean') {
 						$('#' + setting).prop('checked', defaults[setting]);

package/public/js/client.js

@@ -47,7 +47,7 @@
 			selector: '.composer .preview pre code',
 		}, async (params) => {
 			await initHljs();
-			markdown.highlight(params)
+			markdown.highlight(params);
 		});
 
 		$(window).on('action:posts.loaded action:topic.loaded action:posts.edited', async function (ev, data) {

package/public/js/markdown.js

@@ -58,13 +58,19 @@ export function prepareFormattingTools() {
 						controls.insertIntoTextarea(textarea, `${heading} ${strings.heading}`);
 
 						controls.updateTextareaSelection(
-							textarea, selectionStart + heading.length + 1, selectionStart + strings.heading.length + heading.length + 1
+							textarea,
+							selectionStart + heading.length + 1,
+							selectionStart + strings.heading.length + heading.length + 1
 						);
 					} else {
 						const selectedText = $(textarea).val().substring(selectionStart, selectionEnd);
 						const newText = `${heading} ${selectedText}`;
 						controls.replaceSelectionInTextareaWith(textarea, newText);
-						controls.updateTextareaSelection(textarea, selectionStart + (heading.length + 1), selectionEnd + (newText.length - selectedText.length));
+						controls.updateTextareaSelection(
+							textarea,
+							selectionStart + (heading.length + 1),
+							selectionEnd + (newText.length - selectedText.length)
+						);
 					}
 				}
 
@@ -115,7 +121,7 @@ export function prepareFormattingTools() {
 					formatting.addButtonDispatch(`heading${size}`, function (textarea, selectionStart, selectionEnd) {
 						formatHeading(new Array(size).fill('#').join(''), textarea, selectionStart, selectionEnd);
 					});
-				})
+				});
 
 				formatting.addButtonDispatch('list', function (textarea, selectionStart, selectionEnd) {
 					if (selectionStart === selectionEnd) {
@@ -129,7 +135,9 @@ export function prepareFormattingTools() {
 						const selectedText = $(textarea).val().substring(selectionStart, selectionEnd);
 						const newText = '* ' + selectedText.split('\n').join('\n* ');
 						controls.replaceSelectionInTextareaWith(textarea, newText);
-						controls.updateTextareaSelection(textarea, selectionStart + 2, selectionEnd + (newText.length - selectedText.length));
+						controls.updateTextareaSelection(
+							textarea, selectionStart + 2, selectionEnd + (newText.length - selectedText.length)
+						);
 					}
 				});
 
@@ -223,7 +231,7 @@ export function markExternalLinks() {
 			iconEl.classList.add('fa', 'fa-external-link', 'small');
 			anchorEl.append(' ', iconEl);
 		}
-	})
+	});
 }
 
 export function enhanceCheckbox(ev, data) {

package/public/languages/de/markdown.json

@@ -1,12 +1,12 @@
-{
-	"bold": "Fettschrift",
-	"italic": "Kursivschrift",
-	"list-item": "Listenpunkt",
-	"strikethrough-text": "Durchgestrichen",
-	"code-text": "code_text",
-	"link-text": "Link Text",
-	"link-url": "Link Adresse",
-	"picture-text": "Bild Text",
-	"picture-url": "Bild Link",
-	"help-text": "Dieses Forum unterstützt Markdown. <a href=\"http://commonmark.org/help/\" class=\"text-decoration-underline\">Für mehr Informationen, hier klicken.</a>"
-}
+{
+	"bold": "Fettschrift",
+	"italic": "Kursivschrift",
+	"list-item": "Listenpunkt",
+	"strikethrough-text": "Durchgestrichen",
+	"code-text": "code_text",
+	"link-text": "Link Text",
+	"link-url": "Link Adresse",
+	"picture-text": "Bild Text",
+	"picture-url": "Bild Link",
+	"help-text": "Dieses Forum unterstützt Markdown. <a href=\"http://commonmark.org/help/\" class=\"text-decoration-underline\">Für mehr Informationen, hier klicken.</a>"
+}

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

@@ -1,13 +1,13 @@
-{
-	"bold": "bolded text",
-	"italic": "italicised text",
-	"list-item": "list item",
-	"heading": "heading",
-	"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. <a href=\"http://commonmark.org/help/\" class=\"text-decoration-underline\">For full documentation, click here.</a>"
+{
+	"bold": "bolded text",
+	"italic": "italicised text",
+	"list-item": "list item",
+	"heading": "heading",
+	"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. <a href=\"http://commonmark.org/help/\" class=\"text-decoration-underline\">For full documentation, click here.</a>"
 }

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. <a href=\"http://commonmark.org/help/\" class=\"text-decoration-underline\">Pour accéder à la documentation, suivre ce lien.</a>"
-}
+{
+	"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. <a href=\"http://commonmark.org/help/\" class=\"text-decoration-underline\">Pour accéder à la documentation, suivre ce lien.</a>"
+}

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. <a href=\"http://commonmark.org/help/\" class=\"text-decoration-underline\">By uzyskać pełną dokumentację, kliknij tutaj.</a>"
-}
+{
+	"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. <a href=\"http://commonmark.org/help/\" class=\"text-decoration-underline\">By uzyskać pełną dokumentację, kliknij tutaj.</a>"
+}

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. <a href=\"http://commonmark.org/help/\" class=\"text-decoration-underline\">For full documentation, click here.</a>"
-}
+{
+	"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. <a href=\"http://commonmark.org/help/\" class=\"text-decoration-underline\">For full documentation, click here.</a>"
+}

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/) 语法说明。"
+}

package/websockets.js

@@ -1,12 +1,12 @@
 'use strict';
 
 const privileges = require.main.require('./src/privileges');
-const SocketPosts = require.main.require('./src/socket.io/posts');
+const postsAPI = require.main.require('./src/api/posts');
 const posts = require.main.require('./src/posts');
 
 module.exports.checkbox = {
 	edit: async function (socket, data) {
-		const canEdit = await privileges.posts.canEdit(parseInt(data.pid, 10), socket.uid);
+		const canEdit = await privileges.posts.canEdit(data.pid, socket.uid);
 		if (!canEdit) {
 			throw new Error('[[error:no-privileges]]');
 		}
@@ -16,12 +16,12 @@ module.exports.checkbox = {
 		const checkboxRegex = /\[[\sx]?\]/g;
 		let match;
 		const indices = [];
-		// eslint-disable-next-line
+
 		while ((match = checkboxRegex.exec(content)) !== null) {
 			indices.push(match.index);
 		}
 
-		content = content.replace(checkboxRegex, function (match, idx) {
+		content = content.replace(checkboxRegex, (match, idx) => {
 			if (idx !== indices[data.index]) {
 				return match;
 			}
@@ -29,7 +29,7 @@ module.exports.checkbox = {
 			return data.state ? '[x]' : '[ ]';
 		});
 
-		await SocketPosts.edit(socket, {
+		await postsAPI.edit(socket, {
 			pid: data.pid,
 			content: content,
 		});

package/.eslintrc

@@ -1,3 +0,0 @@
-{
-	"extends": "nodebb"
-}

package/.jshintrc

@@ -1,86 +0,0 @@
-{
-    // 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
-}