From 4c05b7da1fef6998c66274672e850924c4244907 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C5=A0imon=20Brandner?= <simon.bra.ag@gmail.com>
Date: Fri, 4 Mar 2022 08:23:26 +0100
Subject: [PATCH] Make trailing `:` into a setting (#6711)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* Make trailing `:` into a setting

Signed-off-by: Šimon Brandner <simon.bra.ag@gmail.com>

* Make traling comma opt-out

Signed-off-by: Šimon Brandner <simon.bra.ag@gmail.com>

* Write `insertTrailingComma` when reading for future opt-in setting

Signed-off-by: Šimon Brandner <simon.bra.ag@gmail.com>

* Update src/editor/parts.ts

* Fix line length

Signed-off-by: Šimon Brandner <simon.bra.ag@gmail.com>

Co-authored-by: Travis Ralston <travpc@gmail.com>
---
 .../tabs/user/PreferencesUserSettingsTab.tsx        |  1 +
 src/editor/parts.ts                                 |  6 +++++-
 src/i18n/strings/en_EN.json                         |  1 +
 src/settings/Settings.tsx                           |  5 +++++
 src/settings/handlers/AccountSettingsHandler.ts     | 13 +++++++++++++
 5 files changed, 25 insertions(+), 1 deletion(-)

diff --git a/src/components/views/settings/tabs/user/PreferencesUserSettingsTab.tsx b/src/components/views/settings/tabs/user/PreferencesUserSettingsTab.tsx
index ffc217dcf9..433e7728c1 100644
--- a/src/components/views/settings/tabs/user/PreferencesUserSettingsTab.tsx
+++ b/src/components/views/settings/tabs/user/PreferencesUserSettingsTab.tsx
@@ -162,6 +162,7 @@ export default class PreferencesUserSettingsTab extends React.Component<IProps,
         'MessageComposerInput.ctrlEnterToSend',
         'MessageComposerInput.surroundWith',
         'MessageComposerInput.showStickersButton',
+        'MessageComposerInput.insertTrailingComma',
     ];
 
     static TIME_SETTINGS = [
diff --git a/src/editor/parts.ts b/src/editor/parts.ts
index 9eb11c8d23..000080a09c 100644
--- a/src/editor/parts.ts
+++ b/src/editor/parts.ts
@@ -30,6 +30,7 @@ import { unicodeToShortcode } from "../HtmlUtils";
 import * as Avatar from "../Avatar";
 import defaultDispatcher from "../dispatcher/dispatcher";
 import { Action } from "../dispatcher/actions";
+import SettingsStore from "../settings/SettingsStore";
 
 interface ISerializedPart {
     type: Type.Plain | Type.Newline | Type.Emoji | Type.Command | Type.PillCandidate;
@@ -650,7 +651,10 @@ export class PartCreator {
         userId: string,
     ): [UserPillPart, PlainPart] {
         const pill = this.userPill(displayName, userId);
-        const postfix = this.plain(insertTrailingCharacter ? ": " : " ");
+        const postfix = this.plain(
+            insertTrailingCharacter &&
+            (SettingsStore.getValue("MessageComposerInput.insertTrailingComma") ? ": " : " "),
+        );
         return [pill, postfix];
     }
 }
diff --git a/src/i18n/strings/en_EN.json b/src/i18n/strings/en_EN.json
index 4f7f7cdf04..e83234efc1 100644
--- a/src/i18n/strings/en_EN.json
+++ b/src/i18n/strings/en_EN.json
@@ -906,6 +906,7 @@
     "Use custom size": "Use custom size",
     "Enable Emoji suggestions while typing": "Enable Emoji suggestions while typing",
     "Show stickers button": "Show stickers button",
+    "Insert a trailing colon after user mentions at the start of a message": "Insert a trailing colon after user mentions at the start of a message",
     "Use a more compact 'Modern' layout": "Use a more compact 'Modern' layout",
     "Show a placeholder for removed messages": "Show a placeholder for removed messages",
     "Show join/leave messages (invites/removes/bans unaffected)": "Show join/leave messages (invites/removes/bans unaffected)",
diff --git a/src/settings/Settings.tsx b/src/settings/Settings.tsx
index a57235065b..a57a88ab28 100644
--- a/src/settings/Settings.tsx
+++ b/src/settings/Settings.tsx
@@ -429,6 +429,11 @@ export const SETTINGS: {[setting: string]: ISetting} = {
         default: true,
         controller: new UIFeatureController(UIFeature.Widgets, false),
     },
+    "MessageComposerInput.insertTrailingComma": {
+        supportedLevels: LEVELS_ACCOUNT_SETTINGS,
+        displayName: _td('Insert a trailing colon after user mentions at the start of a message'),
+        default: true,
+    },
     // TODO: Wire up appropriately to UI (FTUE notifications)
     "Notifications.alwaysShowBadgeCounts": {
         supportedLevels: LEVELS_ROOM_OR_ACCOUNT,
diff --git a/src/settings/handlers/AccountSettingsHandler.ts b/src/settings/handlers/AccountSettingsHandler.ts
index 0edfddc869..39999a1cd6 100644
--- a/src/settings/handlers/AccountSettingsHandler.ts
+++ b/src/settings/handlers/AccountSettingsHandler.ts
@@ -121,6 +121,19 @@ export default class AccountSettingsHandler extends MatrixClientBackedSettingsHa
             return content[settingName];
         }
 
+        if (settingName === "MessageComposerInput.insertTrailingComma") {
+            const content = this.getSettings() || {};
+            const value = content[settingName];
+            if (value === null || value === undefined) {
+                // Write true as it is the default. This will give us the option
+                // of making this opt-in in the future, without affecting old
+                // users
+                this.setValue(settingName, roomId, true);
+                return true;
+            }
+            return value;
+        }
+
         const settings = this.getSettings() || {};
         let preferredValue = settings[settingName];