Fix SC findings & Update README

skychatorg · Nov 26, 2023 · d1e7f15 · d1e7f15
1 parent b281e11
commit d1e7f15
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -155,6 +155,11 @@ When the source files change, the build processes re-runs automatically.
 
 ### Add features
 
+Refer to [the Wiki](https://github.com/skychatorg/skychat/wiki) guides to contribute:
+- [Write a plugin](https://github.com/skychatorg/skychat/wiki/SkyChat-Plugin-Development-Documentation)
+- [Example: Write the TypingList Plugin](https://github.com/skychatorg/skychat/wiki/Room-Plugin-Example:-Writing-the-TypingList-Plugin)
+- [Plugin hooks](https://github.com/skychatorg/skychat/wiki/SkyChat-Plugin-Hooks-Documentation)
+
 Please use only one of the following to suggest new features (or bug fixes):
 - Create a pull request
 - Open an issue with your proposal 
diff --git a/app/server/plugins/RoomPlugin.ts b/app/server/plugins/RoomPlugin.ts
@@ -36,7 +36,7 @@ export abstract class RoomPlugin extends Plugin {
     /**
      * Get a summary of this plugin state to include in the room list
      */
-    public getRoomSummary(): null | undefined | any {
+    public getRoomSummary(): unknown {
         return null;
     }
 

diff --git a/app/server/plugins/core/room/HelpPlugin.ts b/app/server/plugins/core/room/HelpPlugin.ts
@@ -46,7 +46,7 @@ export class HelpPlugin extends RoomPlugin {
                 <td>${alias}</td>
                 <td>${command.minRight}</td>
                 <td>${coolDown}s</td>
-                <td>${(rules.params || []).map((param) => param.name).join(', ')}</td>
+                <td>${(rules.params ?? []).map((param) => param.name).join(', ')}</td>
             </tr>            
             `;
         }

diff --git a/app/server/plugins/player/PlayerPlugin.ts b/app/server/plugins/player/PlayerPlugin.ts
@@ -477,12 +477,10 @@ export class PlayerPlugin extends GlobalPlugin {
                     throw new Error('You are not authorized to perform this action');
                 }
                 // Vote skip
-                // eslint-disable-next-line no-case-declarations
-                const playerData = channel.getPlayerData();
-                if (this.manager.getPlugin('poll') && playerData.current) {
+                if (this.manager.getPlugin('poll') && channel.getPlayerData().current) {
                     const poll = await (this.manager.getPlugin('poll') as PollPlugin).poll(
                         `${channel.name}: Skip media?`,
-                        `${connection.session.identifier} wants to skip ${playerData.current.video.title}. Skip media?`,
+                        `${connection.session.identifier} wants to skip ${channel.getPlayerData().current?.video.title}. Skip media?`,
                         {
                             audience: channel.sessions,
                             defaultValue: false,

diff --git a/app/server/plugins/security_extra/MessageLimiterPlugin.ts b/app/server/plugins/security_extra/MessageLimiterPlugin.ts
@@ -53,7 +53,7 @@ export class MessageLimiterPlugin extends RoomPlugin {
 
         // Send message to connection
         const message = new Message({
-            content: 'Message limit: ' + (this.storage.maxSuccessiveChars === null ? 'off' : this.storage.maxSuccessiveChars),
+            content: 'Message limit: ' + (this.storage.maxSuccessiveChars ?? 'off'),
             user: UserController.getNeutralUser(),
         });
         connection.send('message', message.sanitized());

diff --git a/app/server/skychat/Room.ts b/app/server/skychat/Room.ts
@@ -455,7 +455,7 @@ export class Room implements IBroadcaster {
     public sanitized(): SanitizedRoom {
         const lastMessage: Message | null = this.messages.length === 0 ? null : this.messages[this.messages.length - 1];
         // Merge summary data from every plugin
-        const plugins: { [pluginName: string]: string } = {};
+        const plugins: { [pluginName: string]: unknown } = {};
         for (const plugin of this.plugins) {
             const summary = plugin.getRoomSummary();
             if (summary === null || typeof summary === 'undefined') {