From 550a5220d9e9958e1838a3b2aa2f2b81eb879c0b Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Mon, 7 Dec 2020 15:12:26 -0700 Subject: [PATCH] Undocumented linter cleanup --- src/components/structures/RoomView.tsx | 4 ++-- .../views/elements/EffectsOverlay.tsx | 12 +++++------- .../views/rooms/SendMessageComposer.js | 2 +- src/effects/ICanvasEffect.ts | 17 +++++++++-------- src/effects/confetti/index.ts | 2 -- src/effects/index.ts | 1 - src/effects/{effectUtilities.ts => utils.ts} | 1 - 7 files changed, 17 insertions(+), 22 deletions(-) rename src/effects/{effectUtilities.ts => utils.ts} (99%) diff --git a/src/components/structures/RoomView.tsx b/src/components/structures/RoomView.tsx index 0dec6d30df..d2d473fd3d 100644 --- a/src/components/structures/RoomView.tsx +++ b/src/components/structures/RoomView.tsx @@ -70,8 +70,8 @@ import RoomHeader from "../views/rooms/RoomHeader"; import {XOR} from "../../@types/common"; import { IThreepidInvite } from "../../stores/ThreepidInviteStore"; import EffectsOverlay from "../views/elements/EffectsOverlay"; -import {containsEmoji} from '../../effects/effectUtilities'; -import {CHAT_EFFECTS} from '../../effects' +import {containsEmoji} from '../../effects/utils'; +import {CHAT_EFFECTS} from '../../effects'; import { CallState, MatrixCall } from "matrix-js-sdk/src/webrtc/call"; import WidgetStore from "../../stores/WidgetStore"; import {UPDATE_EVENT} from "../../stores/AsyncStore"; diff --git a/src/components/views/elements/EffectsOverlay.tsx b/src/components/views/elements/EffectsOverlay.tsx index 684b647365..6297d80768 100644 --- a/src/components/views/elements/EffectsOverlay.tsx +++ b/src/components/views/elements/EffectsOverlay.tsx @@ -2,7 +2,6 @@ Copyright 2020 Nurjin Jafar Copyright 2020 Nordeck IT + Consulting GmbH. - Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at @@ -17,14 +16,14 @@ */ import React, { FunctionComponent, useEffect, useRef } from 'react'; import dis from '../../../dispatcher/dispatcher'; -import ICanvasEffect, { ICanvasEffectConstructable } from '../../../effects/ICanvasEffect.js'; +import ICanvasEffect from '../../../effects/ICanvasEffect'; import {CHAT_EFFECTS} from '../../../effects' -export type EffectsOverlayProps = { +interface IProps { roomWidth: number; } -const EffectsOverlay: FunctionComponent = ({ roomWidth }) => { +const EffectsOverlay: FunctionComponent = ({ roomWidth }) => { const canvasRef = useRef(null); const effectsRef = useRef>(new Map()); @@ -34,12 +33,11 @@ const EffectsOverlay: FunctionComponent = ({ roomWidth }) = if (effect === null) { const options = CHAT_EFFECTS.find((e) => e.command === name)?.options try { - const { default: Effect }: { default: ICanvasEffectConstructable } - = await import(`../../../effects/${name}`); + const { default: Effect } = await import(`../../../effects/${name}`); effect = new Effect(options); effectsRef.current[name] = effect; } catch (err) { - console.warn('Unable to load effect module at \'../../../effects/${name}\'.', err) + console.warn('Unable to load effect module at \'../../../effects/${name}\'.', err); } } return effect; diff --git a/src/components/views/rooms/SendMessageComposer.js b/src/components/views/rooms/SendMessageComposer.js index 6a7270c3d6..8171da7eca 100644 --- a/src/components/views/rooms/SendMessageComposer.js +++ b/src/components/views/rooms/SendMessageComposer.js @@ -42,7 +42,7 @@ import {Key, isOnlyCtrlOrCmdKeyEvent} from "../../../Keyboard"; import MatrixClientContext from "../../../contexts/MatrixClientContext"; import RateLimitedFunc from '../../../ratelimitedfunc'; import {Action} from "../../../dispatcher/actions"; -import {containsEmoji} from "../../../effects/effectUtilities"; +import {containsEmoji} from "../../../effects/utils"; import {CHAT_EFFECTS} from '../../../effects'; import SettingsStore from "../../../settings/SettingsStore"; import CountlyAnalytics from "../../../CountlyAnalytics"; diff --git a/src/effects/ICanvasEffect.ts b/src/effects/ICanvasEffect.ts index dbbde3dbe7..9bf3e9293d 100644 --- a/src/effects/ICanvasEffect.ts +++ b/src/effects/ICanvasEffect.ts @@ -2,7 +2,6 @@ Copyright 2020 Nurjin Jafar Copyright 2020 Nordeck IT + Consulting GmbH. - Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at @@ -20,10 +19,10 @@ */ export interface ICanvasEffectConstructable { /** - * @param {{[key:string]:any}} options? Optional animation options + * @param {{[key:string]:any}} options? Optional animation options * @returns ICanvasEffect Returns a new instance of the canvas effect */ - new(options?: { [key: string]: any }): ICanvasEffect + new(options?: { [key: string]: any }): ICanvasEffect; } /** @@ -31,16 +30,18 @@ export interface ICanvasEffectConstructable { */ export default interface ICanvasEffect { /** - * @param {HTMLCanvasElement} canvas The canvas instance as the render target of the animation - * @param {number} timeout? A timeout that defines the runtime of the animation (defaults to false) + * @param {HTMLCanvasElement} canvas The canvas instance as the render target of the animation + * @param {number} timeout? A timeout that defines the runtime of the animation (defaults to false) */ - start: (canvas: HTMLCanvasElement, timeout?: number) => Promise, + start: (canvas: HTMLCanvasElement, timeout?: number) => Promise; + /** * Stops the current animation */ - stop: () => Promise, + stop: () => Promise; + /** * Returns a value that defines if the animation is currently running */ - isRunning: boolean + isRunning: boolean; } diff --git a/src/effects/confetti/index.ts b/src/effects/confetti/index.ts index 646ac30524..8c4b2d2616 100644 --- a/src/effects/confetti/index.ts +++ b/src/effects/confetti/index.ts @@ -2,7 +2,6 @@ Copyright 2020 Nurjin Jafar Copyright 2020 Nordeck IT + Consulting GmbH. - Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at @@ -17,7 +16,6 @@ */ import ICanvasEffect from '../ICanvasEffect'; - export type ConfettiOptions = { /** * max confetti count diff --git a/src/effects/index.ts b/src/effects/index.ts index 067bd6848c..16a0851070 100644 --- a/src/effects/index.ts +++ b/src/effects/index.ts @@ -2,7 +2,6 @@ Copyright 2020 Nurjin Jafar Copyright 2020 Nordeck IT + Consulting GmbH. - Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at diff --git a/src/effects/effectUtilities.ts b/src/effects/utils.ts similarity index 99% rename from src/effects/effectUtilities.ts rename to src/effects/utils.ts index e708f4864e..c2b499b154 100644 --- a/src/effects/effectUtilities.ts +++ b/src/effects/utils.ts @@ -2,7 +2,6 @@ Copyright 2020 Nurjin Jafar Copyright 2020 Nordeck IT + Consulting GmbH. - Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at