nodebb-plugin-mentions 4.0.6 → 4.1.0

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;
@@ -293,8 +298,8 @@ 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;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodebb-plugin-mentions",
-  "version": "4.0.6",
+  "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/test/index.js

@@ -1,6 +1,6 @@
 'use strict';
 
-/* globals describe, it, before */
+/* globals describe, it, beforeEach */
 
 const assert = require('assert');
 
@@ -16,23 +16,28 @@ const regex = main._regex;
 // use core slugify module
 const slugify = require.main.require('./src/slugify');
 
+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');
 		});
 	});
@@ -152,19 +157,35 @@ describe('splitter', () => {
 
 describe('parser', () => {
 	let slug;
+	let uid;
 
-	before(async () => {
+	beforeEach(async () => {
 		slug = utils.generateUUID().slice(0, 10);
-		await Promise.all([slug, `${slug}-two`].map(async (username) => {
-			await user.create({ username });
-		}));
+		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);
+		});
+	});
 });