nodebb-plugin-mentions 4.3.6 → 4.4.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,7 +1,7 @@
-{
-	"mentions": "Mentions",
-	"user-mentioned-you-in": "<strong>%1</strong> mentioned you in <strong>%2</strong>",
-	"user_mentioned_you_in_room": "<strong>%1</strong> mentioned you in <strong class=\"text-nowrap\"><i class=\"fa %2\"></i>%3</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-you-in-room": "<strong>%1</strong> mentioned you in <strong class=\"text-nowrap\"><i class=\"fa %2\"></i>%3</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/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

@@ -3,7 +3,6 @@
 'use strict';
 
 const _ = require('lodash');
-const XRegExp = require('xregexp');
 const validator = require('validator');
 const entitiesDecode = require('html-entities').decode;
 
@@ -29,12 +28,12 @@ const SocketPlugins = require.main.require('./src/socket.io/plugins');
 const utility = require('./lib/utility');
 
 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
+	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)(?=[^-])|(?=[^\\p{L}\\d\\-_.@])|$)', // used to figure out where latin mentions end
 };
-const regex = XRegExp(`${parts.before}${parts.main}`, 'g');
-const isLatinMention = /@[\w\d\-_.]+$/;
+const regex = RegExp(`${parts.before}${parts.main}`, 'gu');
+const isLatinMention = /@[\w\d\-_.@]+$/;
 
 const Mentions = module.exports;
 
@@ -342,7 +341,6 @@ Mentions.parseRaw = async (content) => {
 	await Promise.all(matches.map(async (match) => {
 		const slug = slugify(match.slice(1));
 		match = removePunctuationSuffix(match);
-
 		const uid = await User.getUidByUserslug(slug);
 		const results = await utils.promiseParallel({
 			groupExists: Groups.existsBySlug(slug),
@@ -351,11 +349,9 @@ Mentions.parseRaw = async (content) => {
 
 		if (results.user.uid || results.groupExists) {
 			const regex = isLatinMention.test(match) ?
-				XRegExp(`${parts.before}${match}${parts.after}`, 'g') :
-				XRegExp(`${parts.before}${match}`, 'g');
-
+				RegExp(`${parts.before}${match}${parts.after}`, 'gu') :
+				RegExp(`${parts.before}${match}`, 'gu');
 			let skip = false;
-
 			splitContent = splitContent.map((c, i) => {
 				// *Might* not be needed anymore? Check pls...
 				if (skip || (i % 2) === 1) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodebb-plugin-mentions",
-  "version": "4.3.6",
+  "version": "4.4.0",
   "description": "NodeBB Plugin that allows users to mention other users by prepending an '@' sign to their username",
   "main": "library.js",
   "scripts": {
@@ -27,13 +27,12 @@
   "dependencies": {
     "html-entities": "^2.3.2",
     "lodash": "4.17.21",
-    "validator": "^13.0.0",
-    "xregexp": "^5.1.0"
+    "validator": "^13.0.0"
   },
   "devDependencies": {
-    "mocha": "10.2.0",
-    "eslint": "8.50.0",
+    "mocha": "10.3.0",
+    "eslint": "8.57.0",
     "eslint-config-nodebb": "0.2.1",
-    "eslint-plugin-import": "2.28.1"
+    "eslint-plugin-import": "2.29.1"
   }
 }

package/plugin.json

@@ -1,32 +1,32 @@
-{
-	"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": "action:messaging.save", "method": "notifyMessage" },
-		{ "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": "action:messaging.save", "method": "notifyMessage" },
+		{ "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/index.js

@@ -158,10 +158,12 @@ describe('splitter', () => {
 describe('parser', () => {
 	let slug;
 	let uid;
+	let emailUid;
 
 	beforeEach(async () => {
 		slug = utils.generateUUID().slice(0, 10);
 		uid = await user.create({ username: slug });
+		emailUid = await user.create({ username: `${slug}@test.nodebb.org` });
 	});
 
 	it('should properly parse both users even if one user\'s username is a subset of the other', async () => {
@@ -185,6 +187,20 @@ describe('parser', () => {
 
 			assert(html);
 
+			assert.strictEqual(html, check);
+		});
+		// re-enable this when NodeBB slugify doesn't strip out `@` from usernames
+		it.skip('should match correctly email-like 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/${emailUid}">@${slug}@test.nodebb.org</a>`);
+				string = string.replace(/testUser/g, `${slug}@test.nodebb.org`);
+			}
+			const html = await main.parseRaw(string);
+
+			assert(html);
+
 			assert.strictEqual(html, check);
 		});
 	});