nodebb-plugin-mentions 4.0.5 → 4.1.0

package/.eslintrc

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

package/LICENSE

@@ -1,8 +1,8 @@
-Copyright (c) 2013-2014, Julian Lam <julian@designcreateplay.com>
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
-Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+Copyright (c) 2013-2014, Julian Lam <julian@designcreateplay.com>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -1,14 +1,14 @@
-# Username/Group Mentions
-
-This NodeBB plugin allows posters to reference (or *mention*) other users or groups on a NodeBB by simply
-precluding the `@` symbol before a username.
-
-A link is automatically added to the post.
-
-## Installation
-
-This plugin is bundled with every NodeBB install. If not, you can install it via the Plugins page of the ACP.
-
-Alternatively,
-
+# Username/Group Mentions
+
+This NodeBB plugin allows posters to reference (or *mention*) other users or groups on a NodeBB by simply
+precluding the `@` symbol before a username.
+
+A link is automatically added to the post.
+
+## Installation
+
+This plugin is bundled with every NodeBB install. If not, you can install it via the Plugins page of the ACP.
+
+Alternatively,
+
     npm install nodebb-plugin-mentions

package/languages/ar/notifications.json

@@ -1,3 +1,3 @@
-{
-    "user_mentioned_you_in": "<strong>%1</strong> ذكرَ اسمك في <strong>%2</strong>"
+{
+    "user_mentioned_you_in": "<strong>%1</strong> ذكرَ اسمك في <strong>%2</strong>"
 }

package/languages/bg/notifications.json

@@ -1,3 +1,3 @@
-{
-    "user_mentioned_you_in": "<strong>%1</strong> Ви спомена в <strong>%2</strong>"
+{
+    "user_mentioned_you_in": "<strong>%1</strong> Ви спомена в <strong>%2</strong>"
 }

package/languages/bn/notifications.json

@@ -1,3 +1,3 @@
-{
-    "user_mentioned_you_in": "<strong>%1</strong>, <strong>%2</strong> এ আপনার নাম উল্লেখ করেছেন"
+{
+    "user_mentioned_you_in": "<strong>%1</strong>, <strong>%2</strong> এ আপনার নাম উল্লেখ করেছেন"
 }

package/languages/da/notifications.json

@@ -1,3 +1,3 @@
-{
-    "user_mentioned_you_in": "<strong>%1</strong> nævnte dig i <strong>%2</strong>"
+{
+    "user_mentioned_you_in": "<strong>%1</strong> nævnte dig i <strong>%2</strong>"
 }

package/languages/de/notifications.json

@@ -1,6 +1,6 @@
-{
-    "mentions": "Erwähnungen",
-    "user_mentioned_you_in": "<strong>%1</strong> erwähnte dich in <strong>%2</strong>",
-    "user_mentioned_group_in": "<strong>%1</strong> erwähnte <strong>%2</strong> in <strong>%3</strong>",
-    "notificationType_mention": "Wenn dich jemand erwähnt"
+{
+    "mentions": "Erwähnungen",
+    "user_mentioned_you_in": "<strong>%1</strong> erwähnte dich in <strong>%2</strong>",
+    "user_mentioned_group_in": "<strong>%1</strong> erwähnte <strong>%2</strong> in <strong>%3</strong>",
+    "notificationType_mention": "Wenn dich jemand erwähnt"
 }

package/languages/el/notifications.json

@@ -1,3 +1,3 @@
-{
-    "user_mentioned_you_in": "Ο/Η <strong>%1</strong> σε ανέφερε στο <strong>%2</strong>"
+{
+    "user_mentioned_you_in": "Ο/Η <strong>%1</strong> σε ανέφερε στο <strong>%2</strong>"
 }

package/languages/en@pirate/notifications.json

@@ -1,4 +1,4 @@
-{
-	"user_mentioned_you_in": "<strong>%1</strong> spoke yer name in <strong>%2</strong>",
-	"user_mentioned_group_in": "<strong>%1</strong> called fer <strong>%2</strong> in <strong>%3</strong>"
-}
+{
+	"user_mentioned_you_in": "<strong>%1</strong> spoke yer name in <strong>%2</strong>",
+	"user_mentioned_group_in": "<strong>%1</strong> called fer <strong>%2</strong> in <strong>%3</strong>"
+}

package/languages/en_GB/mentions.json

@@ -1,3 +1,3 @@
-{
-	"user_mentioned_you_in": "<strong>%1</strong> mentioned you in <strong>%2</strong>"
-}
+{
+	"user_mentioned_you_in": "<strong>%1</strong> mentioned you in <strong>%2</strong>"
+}

package/languages/en_GB/notifications.json

@@ -1,6 +1,6 @@
-{
-	"mentions": "Mentions",
-	"user_mentioned_you_in": "<strong>%1</strong> mentioned you in <strong>%2</strong>",
-	"user_mentioned_group_in": "<strong>%1</strong> mentioned <strong>%2</strong> in <strong>%3</strong>",
-	"notificationType_mention": "When someone mentions you"
-}
+{
+	"mentions": "Mentions",
+	"user_mentioned_you_in": "<strong>%1</strong> mentioned you in <strong>%2</strong>",
+	"user_mentioned_group_in": "<strong>%1</strong> mentioned <strong>%2</strong> in <strong>%3</strong>",
+	"notificationType_mention": "When someone mentions you"
+}

package/languages/en_US/notifications.json

@@ -1,4 +1,4 @@
-{
-	"user_mentioned_you_in": "<strong>%1</strong> mentioned you in <strong>%2</strong>",
-	"user_mentioned_group_in": "<strong>%1</strong> mentioned <strong>%2</strong> in <strong>%3</strong>"
-}
+{
+	"user_mentioned_you_in": "<strong>%1</strong> mentioned you in <strong>%2</strong>",
+	"user_mentioned_group_in": "<strong>%1</strong> mentioned <strong>%2</strong> in <strong>%3</strong>"
+}

package/languages/es/notifications.json

@@ -1,4 +1,4 @@
-{
-    "mentions": "Menciones",
-    "user_mentioned_you_in": "<strong>%1</strong> te mencionó en <strong>%2</strong>"
+{
+    "mentions": "Menciones",
+    "user_mentioned_you_in": "<strong>%1</strong> te mencionó en <strong>%2</strong>"
 }

package/languages/et/notifications.json

@@ -1,3 +1,3 @@
-{
-    "user_mentioned_you_in": "<strong>%1</strong> mainis sind postituses <strong>%2</strong>"
+{
+    "user_mentioned_you_in": "<strong>%1</strong> mainis sind postituses <strong>%2</strong>"
 }

package/languages/fa_IR/notifications.json

@@ -1,4 +1,4 @@
-{
-	"user_mentioned_you_in": "<strong>%1</strong> شما رو در <strong>%2</strong> منشن کرده",
-	"user_mentioned_group_in": "<strong>%1</strong> گروه <strong>%2</strong> رو در <strong>%3</strong> منشن کرده"
-}
+{
+	"user_mentioned_you_in": "<strong>%1</strong> شما رو در <strong>%2</strong> منشن کرده",
+	"user_mentioned_group_in": "<strong>%1</strong> گروه <strong>%2</strong> رو در <strong>%3</strong> منشن کرده"
+}

package/languages/fi/notifications.json

@@ -1,3 +1,3 @@
-{
-    "user_mentioned_you_in": "<strong>%1</strong> mainitsi sinut viestissä <strong>%2</strong>"
+{
+    "user_mentioned_you_in": "<strong>%1</strong> mainitsi sinut viestissä <strong>%2</strong>"
 }

package/languages/fr/notifications.json

@@ -1,6 +1,6 @@
-{
-	"mentions": "Mentions",
-	"user_mentioned_you_in": "<strong>%1</strong> vous a mentionné dans <strong>%2</strong>",
-	"user_mentioned_group_in": "<strong>%1</strong> a mentionné <strong>%2</strong> dans <strong>%3</strong>",
-	"notificationType_mention": "Lorsque quelqu'un vous mentionne"
+{
+	"mentions": "Mentions",
+	"user_mentioned_you_in": "<strong>%1</strong> vous a mentionné dans <strong>%2</strong>",
+	"user_mentioned_group_in": "<strong>%1</strong> a mentionné <strong>%2</strong> dans <strong>%3</strong>",
+	"notificationType_mention": "Lorsque quelqu'un vous mentionne"
 }

package/languages/gl/notifications.json

@@ -1,3 +1,3 @@
-{
-    "user_mentioned_you_in": "<strong>%1</strong> mencionóute en <strong>%2</strong>"
+{
+    "user_mentioned_you_in": "<strong>%1</strong> mencionóute en <strong>%2</strong>"
 }

package/languages/he/notifications.json

@@ -1,3 +1,3 @@
-{
-    "user_mentioned_you_in": "<strong>%1</strong> הזכיר אותך ב <strong>%2</strong>"
+{
+    "user_mentioned_you_in": "<strong>%1</strong> הזכיר אותך ב <strong>%2</strong>"
 }

package/languages/id/notifications.json

@@ -1,3 +1,3 @@
-{
-    "user_mentioned_you_in": "<strong>%1</strong> menyebut mu di <strong>%2</strong>"
+{
+    "user_mentioned_you_in": "<strong>%1</strong> menyebut mu di <strong>%2</strong>"
 }

package/languages/it/notifications.json

@@ -1,4 +1,4 @@
-{
-    "mentions": "Menzioni",
-    "user_mentioned_you_in": "<strong>%1</strong> ti ha menzionato in <strong>%2</strong>"
+{
+    "mentions": "Menzioni",
+    "user_mentioned_you_in": "<strong>%1</strong> ti ha menzionato in <strong>%2</strong>"
 }

package/languages/ja/notifications.json

@@ -1,5 +1,5 @@
-{
-	"mentions": "メンション",
-	"user_mentioned_you_in": "<strong>%1</strong> mentioned you in <strong>%2</strong>",
-	"user_mentioned_group_in": "<strong>%1</strong> mentioned <strong>%2</strong> in <strong>%3</strong>"
+{
+	"mentions": "メンション",
+	"user_mentioned_you_in": "<strong>%1</strong> mentioned you in <strong>%2</strong>",
+	"user_mentioned_group_in": "<strong>%1</strong> mentioned <strong>%2</strong> in <strong>%3</strong>"
 }

package/languages/jbo/notifications.json

@@ -1,4 +1,4 @@
-{
-	"user_mentioned_you_in": "la .<strong>%1</strong>. klacpe do la .<strong>%2</strong>.",
-	"user_mentioned_group_in": "la .<strong>%1</strong>. klacpe la .<strong>%2</strong>. la .<strong>%3</strong>."
-}
+{
+	"user_mentioned_you_in": "la .<strong>%1</strong>. klacpe do la .<strong>%2</strong>.",
+	"user_mentioned_group_in": "la .<strong>%1</strong>. klacpe la .<strong>%2</strong>. la .<strong>%3</strong>."
+}

package/languages/ko/notifications.json

@@ -1,3 +1,3 @@
-{
-    "user_mentioned_you_in": "<strong>%1</strong>님이 <strong>%2</strong>에서 나를 언급했습니다."
+{
+    "user_mentioned_you_in": "<strong>%1</strong>님이 <strong>%2</strong>에서 나를 언급했습니다."
 }

package/languages/lt/notifications.json

@@ -1,3 +1,3 @@
-{
-    "user_mentioned_you_in": "<strong>%1</strong> paminėjo Jus <strong>%2</strong>"
+{
+    "user_mentioned_you_in": "<strong>%1</strong> paminėjo Jus <strong>%2</strong>"
 }

package/languages/ms/notifications.json

@@ -1,3 +1,3 @@
-{
-    "user_mentioned_you_in": "<strong>%1</strong> sebut anda di <strong>%2</strong>"
+{
+    "user_mentioned_you_in": "<strong>%1</strong> sebut anda di <strong>%2</strong>"
 }

package/languages/nl/notifications.json

@@ -1,3 +1,3 @@
-{
-    "user_mentioned_you_in": "Onze naam is genoemd door <strong>%1</strong> in <strong>%2</strong>."
+{
+    "user_mentioned_you_in": "Onze naam is genoemd door <strong>%1</strong> in <strong>%2</strong>."
 }

package/languages/pl/mentions.json

@@ -1,3 +1,3 @@
-{
-	"user_mentioned_you_in": "<strong>%1</strong> wspomniał o Tobie w <strong>%2</strong>"
-}
+{
+	"user_mentioned_you_in": "<strong>%1</strong> wspomniał o Tobie w <strong>%2</strong>"
+}

package/languages/pl/notifications.json

@@ -1,6 +1,6 @@
-{
-	"mentions": "Wspomnienia",
-	"user_mentioned_you_in": "<strong>%1</strong> wspomniał o Tobie w <strong>%2</strong>",
-	"user_mentioned_group_in": "<strong>%1</strong> wspomniał <strong>%2</strong> w <strong>%3</strong>",
-	"notificationType_mention": "Kiedy ktoś o Tobie wspomni"
-}
+{
+	"mentions": "Wspomnienia",
+	"user_mentioned_you_in": "<strong>%1</strong> wspomniał o Tobie w <strong>%2</strong>",
+	"user_mentioned_group_in": "<strong>%1</strong> wspomniał <strong>%2</strong> w <strong>%3</strong>",
+	"notificationType_mention": "Kiedy ktoś o Tobie wspomni"
+}

package/languages/pt-PT/notifications.json

@@ -1,6 +1,6 @@
-{
-	"mentions": "Menções",
-	"user_mentioned_you_in": "<strong>%1</strong> mencionou-te no tópico <strong>%2</strong>",
-	"user_mentioned_group_in": "<strong>%1</strong> mencionou o grupo <strong>%2</strong> no tópico <strong>%3</strong>",
-	"notificationType_mention": "Quando alguém te menciona"
-}
+{
+	"mentions": "Menções",
+	"user_mentioned_you_in": "<strong>%1</strong> mencionou-te no tópico <strong>%2</strong>",
+	"user_mentioned_group_in": "<strong>%1</strong> mencionou o grupo <strong>%2</strong> no tópico <strong>%3</strong>",
+	"notificationType_mention": "Quando alguém te menciona"
+}

package/languages/pt_BR/notifications.json

@@ -1,4 +1,4 @@
-{
-    "mentions": "Menções",
-    "user_mentioned_you_in": "<strong>%1</strong> mencionou você em <strong>%2</strong>"
+{
+    "mentions": "Menções",
+    "user_mentioned_you_in": "<strong>%1</strong> mencionou você em <strong>%2</strong>"
 }

package/languages/ro/notifications.json

@@ -1,3 +1,3 @@
-{
-    "user_mentioned_you_in": "<strong>%1</strong> te-a menționat în <strong>%2</strong>"
+{
+    "user_mentioned_you_in": "<strong>%1</strong> te-a menționat în <strong>%2</strong>"
 }

package/languages/rw/notifications.json

@@ -1,3 +1,3 @@
-{
-    "user_mentioned_you_in": "<strong>%1</strong> yakuvuze muri <strong>%2</strong>"
+{
+    "user_mentioned_you_in": "<strong>%1</strong> yakuvuze muri <strong>%2</strong>"
 }

package/languages/sl/notifications.json

@@ -1,3 +1,3 @@
-{
-    "user_mentioned_you_in": "<strong>%1</strong> te je omenil v <strong>%2</strong>"
+{
+    "user_mentioned_you_in": "<strong>%1</strong> te je omenil v <strong>%2</strong>"
 }

package/languages/sr/notifications.json

@@ -1,3 +1,3 @@
-{
-    "user_mentioned_you_in": "<strong>%1</strong> вас помену у <strong>%2</strong>"
+{
+    "user_mentioned_you_in": "<strong>%1</strong> вас помену у <strong>%2</strong>"
 }

package/languages/sv/notifications.json

@@ -1,3 +1,3 @@
-{
-    "user_mentioned_you_in": "<strong>%1</strong> nämnde dig i <strong>%2</strong>"
+{
+    "user_mentioned_you_in": "<strong>%1</strong> nämnde dig i <strong>%2</strong>"
 }

package/languages/tr/notifications.json

@@ -1,6 +1,6 @@
-{
-	"mentions": "Bahsedilmeler",
-	"user_mentioned_you_in": "<strong>%1</strong> sizden şu konuda bahsetti: <strong>%2</strong>",
-	"user_mentioned_group_in": "<strong>%1</strong> kullanıcısı <strong>%2</strong> grubundan şu konuda bahsetti: <strong>%3</strong>",
-	"notificationType_mention": "Biri sizden bahsettiğinde"
-}
+{
+	"mentions": "Bahsedilmeler",
+	"user_mentioned_you_in": "<strong>%1</strong> sizden şu konuda bahsetti: <strong>%2</strong>",
+	"user_mentioned_group_in": "<strong>%1</strong> kullanıcısı <strong>%2</strong> grubundan şu konuda bahsetti: <strong>%3</strong>",
+	"notificationType_mention": "Biri sizden bahsettiğinde"
+}

package/languages/vi/notifications.json

@@ -1,3 +1,3 @@
-{
-    "user_mentioned_you_in": "<strong>%1</strong> nhắc đến bạn trong <strong>%2</strong>"
+{
+    "user_mentioned_you_in": "<strong>%1</strong> nhắc đến bạn trong <strong>%2</strong>"
 }

package/languages/zh-CN/mentions.json

@@ -1,3 +1,3 @@
-{
-	"user_mentioned_you_in": "<strong>%1</strong> 在 <strong>%2</strong> 中提到了您"
-}
+{
+	"user_mentioned_you_in": "<strong>%1</strong> 在 <strong>%2</strong> 中提到了您"
+}

package/languages/zh-CN/notifications.json

@@ -1,6 +1,6 @@
-{
-	"mentions": "提到",
-	"user_mentioned_you_in": "<strong>%1</strong> 在 <strong>%2</strong> 中提到了你",
-	"user_mentioned_group_in": "<strong>%1</strong> 在 <strong>%3</strong> 中提到了 <strong>%2</strong>",
-	"notificationType_mention": "当有人提到你时"
+{
+	"mentions": "提到",
+	"user_mentioned_you_in": "<strong>%1</strong> 在 <strong>%2</strong> 中提到了你",
+	"user_mentioned_group_in": "<strong>%1</strong> 在 <strong>%3</strong> 中提到了 <strong>%2</strong>",
+	"notificationType_mention": "当有人提到你时"
 }

package/languages/zh_TW/notifications.json

@@ -1,3 +1,3 @@
-{
-    "user_mentioned_you_in": "<strong>%1</strong> 在 <strong>%2</strong>提到你"
+{
+    "user_mentioned_you_in": "<strong>%1</strong> 在 <strong>%2</strong>提到你"
 }

package/library.js

@@ -27,7 +27,12 @@ const SocketPlugins = require.main.require('./src/socket.io/plugins');
 
 const utility = require('./lib/utility');
 
-const regex = XRegExp('(?:^|\\s|\\>|;)(@[\\p{L}\\d\\-_.]+)', 'g');
+const parts = {
+	before: '(?:(^|\\p{^L}))', // a single unicode non-letter character or start of line
+	main: '(@[\\p{L}\\d\\-_.]+)', // unicode letters, numbers, dashes, underscores, or periods
+	after: '((?=\\b)(?=[^-])|$)', // used to figure out where latin mentions end
+};
+const regex = XRegExp(`${parts.before}${parts.main}`, 'g');
 const isLatinMention = /@[\w\d\-_.]+$/;
 
 const Mentions = module.exports;
@@ -40,6 +45,7 @@ Mentions._defaults = {
 	overrideIgnores: 'off',
 	display: '',
 };
+Mentions._regex = regex;
 
 SocketPlugins.mentions = {};
 
@@ -272,9 +278,9 @@ Mentions.parseRaw = async (content) => {
 
 	matches = _.uniq(matches).map((match) => {
 		/**
-		 *	Javascript-favour of regex does not support lookaround,
-		 *	so need to clean up the cruft by discarding everthing
-		 *	before the @
+		 * Javascript-flavour of regex does not support lookaround,
+		 * so need to clean up the cruft by discarding everthing
+		 * before the @
 		 */
 		const atIndex = match.indexOf('@');
 		return atIndex !== 0 ? match.slice(atIndex) : match;
@@ -292,17 +298,18 @@ Mentions.parseRaw = async (content) => {
 
 		if (results.user.uid || results.groupExists) {
 			const regex = isLatinMention.test(match) ?
-				new RegExp(`(?:^|\\s|\>|;)${match}\\b`, 'g') :
-				new RegExp(`(?:^|\\s|\>|;)${match}`, 'g');
+				XRegExp(`${parts.before}${match}${parts.after}`, 'g') :
+				XRegExp(`${parts.before}${match}`, 'g');
 
 			let skip = false;
 
 			splitContent = splitContent.map((c, i) => {
 				// *Might* not be needed anymore? Check pls...
 				if (skip || (i % 2) === 1) {
-					skip = c === '<code>';	// if code block detected, skip the content inside of it
+					skip = c === '<code>'; // if code block detected, skip the content inside of it
 					return c;
 				}
+
 				return c.replace(regex, (match) => {
 					// Again, cleaning up lookaround leftover bits
 					const atIndex = match.indexOf('@');
@@ -357,7 +364,7 @@ async function filterPrivilegedUids(uids, cid, toPid) {
 
 		const [isAdmin, isMod] = await Promise.all([
 			User.isAdministrator(uid),
-			User.isModerator(uid, cid),	// covers gmod as well
+			User.isModerator(uid, cid), // covers gmod as well
 		]);
 
 		return isAdmin || isMod ? false : uid;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodebb-plugin-mentions",
-  "version": "4.0.5",
+  "version": "4.1.0",
   "description": "NodeBB Plugin that allows users to mention other users by prepending an '@' sign to their username",
   "main": "library.js",
   "scripts": {
@@ -32,7 +32,7 @@
   },
   "devDependencies": {
     "mocha": "10.2.0",
-    "eslint": "8.37.0",
+    "eslint": "8.39.0",
     "eslint-config-nodebb": "0.2.1",
     "eslint-plugin-import": "2.27.5"
   }

package/plugin.json

@@ -1,31 +1,31 @@
-{
-	"id": "nodebb-plugin-mentions",
-	"name": "Username Mentions",
-	"description": "NodeBB Plugin that allows users to mention other users by prepending an '@' sign to their username",
-	"url": "https://github.com/julianlam/nodebb-plugin-mentions",
-	"library": "./library.js",
-	"upgrades": [
-        "upgrades/mentions_delete_mentions_set_zset.js"
-    ],
-	"hooks": [
-		{ "hook": "static:app.load", "method": "init" },
-		{ "hook": "filter:admin.header.build", "method": "addAdminNavigation" },
-		{ "hook": "filter:parse.post", "method": "parsePost" },
-		{ "hook": "filter:parse.raw", "method": "parseRaw" },
-		{ "hook": "action:post.save", "method": "notify" },
-		{ "hook": "action:post.edit", "method": "notify" },
-		{ "hook": "action:posts.purge", "method": "actionPostsPurge" },
-		{ "hook": "filter:notifications.addFilters", "method": "addFilters" },
-		{ "hook": "filter:user.notificationTypes", "method": "notificationTypes" },
-		{ "hook": "filter:users.addFields", "method": "addFields" }
-	],
-	"scripts": [
-		"static/autofill.js"
-	],
-	"modules": {
-		"../admin/plugins/mentions.js": "./static/admin.js"
-	},
-	"languages": "languages",
-	"defaultLang": "en_GB",
-	"templates": "templates"
+{
+	"id": "nodebb-plugin-mentions",
+	"name": "Username Mentions",
+	"description": "NodeBB Plugin that allows users to mention other users by prepending an '@' sign to their username",
+	"url": "https://github.com/julianlam/nodebb-plugin-mentions",
+	"library": "./library.js",
+	"upgrades": [
+        "upgrades/mentions_delete_mentions_set_zset.js"
+    ],
+	"hooks": [
+		{ "hook": "static:app.load", "method": "init" },
+		{ "hook": "filter:admin.header.build", "method": "addAdminNavigation" },
+		{ "hook": "filter:parse.post", "method": "parsePost" },
+		{ "hook": "filter:parse.raw", "method": "parseRaw" },
+		{ "hook": "action:post.save", "method": "notify" },
+		{ "hook": "action:post.edit", "method": "notify" },
+		{ "hook": "action:posts.purge", "method": "actionPostsPurge" },
+		{ "hook": "filter:notifications.addFilters", "method": "addFilters" },
+		{ "hook": "filter:user.notificationTypes", "method": "notificationTypes" },
+		{ "hook": "filter:users.addFields", "method": "addFields" }
+	],
+	"scripts": [
+		"static/autofill.js"
+	],
+	"modules": {
+		"../admin/plugins/mentions.js": "./static/admin.js"
+	},
+	"languages": "languages",
+	"defaultLang": "en_GB",
+	"templates": "templates"
 }

package/static/.eslintrc

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

package/test/{regex.js → index.js}

@@ -1,33 +1,43 @@
 'use strict';
 
-/* globals describe, it, before */
+/* globals describe, it, beforeEach */
 
 const assert = require('assert');
-const XRegExp = require('xregexp');
-const regex = XRegExp('(?:^|\\s|\\>|;)(@[\\p{L}\\d\\-_.]+)', 'g');
 
-const db = require.main.require('./test/mocks/databasemock');
+const user = require.main.require('./src/user');
+const utils = require.main.require('./src/utils');
+
+const main = require('../library');
+
+const regex = main._regex;
+
+/* const db = */require.main.require('./test/mocks/databasemock');
 
 // use core slugify module
 const slugify = require.main.require('./src/slugify');
 
-describe('regex', function () {
+const strings = [
+	'@testUser',
+	'@testUser some text',
+	'some text @testUser',
+	'<a href="/user/testuser">@testUser</a>',
+	'<a href="/user/testuser">@testUser</a> some text',
+	'some text <a href="/user/testuser">@testUser</a>',
+	'end of sentence. @testUser',
+	'@testUser.',
+	'@testUser\'s some text',
+	'> @testUser blockquoted',
+	'(@testUser) bracketed',
+	'elon makes me think of this emoji: 💩@testUser',
+];
+
+describe('regex', () => {
 	const matcher = new RegExp(regex);
-	const strings = [
-		'@testUser',
-		'@testUser some text',
-		'some text @testUser',
-		'<a href="/user/testuser">@testUser</a>',
-		'<a href="/user/testuser">@testUser</a> some text',
-		'some text <a href="/user/testuser">@testUser</a>',
-		'end of sentence. @testUser',
-		'@testUser.',
-		'@testUser\'s some text',
-	]
-	it('should match a mention in all strings', () => {
-		strings.forEach(string => {
+
+	strings.forEach((string) => {
+		it('should match a mention in all test strings', () => {
 			const matches = string.match(matcher);
-			assert(matches);
+			assert(matches, `@testUser was not found in this string: ${string}`);
 			assert.equal(slugify(matches[0]), 'testuser');
 		});
 	});
@@ -36,7 +46,7 @@ describe('regex', function () {
 	// TODO: Ideally the regex matcher should be its own utility function in `lib/`
 });
 
-describe('splitter', function () {
+describe('splitter', () => {
 	const utility = require('../lib/utility');
 	const testHTMLText = 'this is a post with <code>stuff in code</code> and a\n\n<blockquote>blockquote or two</blockquote>';
 	const testMdText = 'this is a post with `stuff in code` and a \n\n>blockquote or two';
@@ -144,3 +154,38 @@ describe('splitter', function () {
 		});
 	});
 });
+
+describe('parser', () => {
+	let slug;
+	let uid;
+
+	beforeEach(async () => {
+		slug = utils.generateUUID().slice(0, 10);
+		uid = await user.create({ username: slug });
+	});
+
+	it('should properly parse both users even if one user\'s username is a subset of the other', async () => {
+		await user.create({ username: `${slug}-two` });
+		const md = `This sentence contains two mentions: @${slug} and @${slug}-two`;
+
+		const html = await main.parseRaw(md);
+
+		assert.strictEqual(html, `This sentence contains two mentions: <a class="plugin-mentions-user plugin-mentions-a" href="http://127.0.0.1:4567/uid/1">@${slug}</a> and <a class="plugin-mentions-user plugin-mentions-a" href="http://127.0.0.1:4567/uid/2">@${slug}-two</a>`);
+	});
+
+	strings.forEach((string) => {
+		it('should match correctly replace the mentions in all test strings', async () => {
+			const index = string.indexOf('@testUser');
+			let check = string;
+			if (!index || string[index - 1] !== '>') {
+				check = string.replace(/@testUser/g, `<a class="plugin-mentions-user plugin-mentions-a" href="http://127.0.0.1:4567/uid/${uid}">@${slug}</a>`);
+				string = string.replace(/testUser/g, slug);
+			}
+			const html = await main.parseRaw(string);
+
+			assert(html);
+
+			assert.strictEqual(html, check);
+		});
+	});
+});