Add setting to display voter name instead of username (#25)

Author: PatriceG

PollApp.ts

@@ -3,6 +3,7 @@ import { App } from '@rocket.chat/apps-engine/definition/App';
 import { IAppInfo } from '@rocket.chat/apps-engine/definition/metadata';
 
 // Commands
+import { SettingType } from '@rocket.chat/apps-engine/definition/settings';
 import { PollCommand } from './src/PollCommand';
 import { VoteCommand } from './src/VoteCommand';
 
@@ -15,5 +16,15 @@ export class PollApp extends App {
     public async initialize(configuration: IConfigurationExtend): Promise<void> {
         await configuration.slashCommands.provideSlashCommand(new PollCommand());
         await configuration.slashCommands.provideSlashCommand(new VoteCommand(this));
+        await configuration.settings.provideSetting({
+            id : 'use-user-name',
+            i18nLabel: 'Use name attribute to display voters, instead of username',
+            i18nDescription: 'When checked, display voters as full user names instead of @name',
+            required: false,
+            type: SettingType.BOOLEAN,
+            public: true,
+            packageValue: false,
+        });
     }
+
 }

package-lock.json

@@ -42,9 +42,11 @@ export class VoteCommand implements ISlashCommand {
 
         const poll = polls[0] as IPoll;
 
-        const { username } = context.getSender();
+        const useUserName = await read.getEnvironmentReader().getSettings().getById('use-user-name');
 
-        const hasVoted = poll.votes[voteIndex].voters.indexOf(username);
+        const displayedName = useUserName.value ? context.getSender().name : '@' + context.getSender().username;
+
+        const hasVoted = poll.votes[voteIndex].voters.indexOf(displayedName);
 
         if (hasVoted !== -1) {
             poll.totalVotes--;
@@ -53,7 +55,7 @@ export class VoteCommand implements ISlashCommand {
         } else {
             poll.totalVotes++;
             poll.votes[voteIndex].quantity++;
-            poll.votes[voteIndex].voters.push(username);
+            poll.votes[voteIndex].voters.push(displayedName);
         }
         await persis.updateByAssociation(association, poll);
 

src/VoteCommand.ts

@@ -23,7 +23,7 @@ function addVoters(votes: IVoter, totalVotes: IPoll['totalVotes']) {
     let voters = ` \`${ votes.quantity }\``;
 
     if (votes.voters.length > 0) {
-        voters += `\n_@${ votes.voters.join('_, _@') }_`;
+        voters += `\n_${ votes.voters.join('_, _') }_`;
     }
 
     return voters;