Merge pull request matrix-org#4850 from matrix-org/travis/room-list/todo-cleanup

Clean up TODO comments for new room list

Author: turt2live

res/css/structures/_LeftPanel2.scss

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-// TODO: Rename to mx_LeftPanel during replacement of old component
+// TODO: Rename on launch: https://github.com/vector-im/riot-web/issues/14231
 
 $tagPanelWidth: 70px; // only applies in this file, used for calculations
 

res/css/views/rooms/_RoomBreadcrumbs2.scss

@@ -14,6 +14,8 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// TODO: Rename on launch: https://github.com/vector-im/riot-web/issues/14231
+
 .mx_RoomBreadcrumbs2 {
     width: 100%;
 

res/css/views/rooms/_RoomSublist2.scss

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-// TODO: Rename to mx_RoomSublist during replacement of old component
+// TODO: Rename on launch: https://github.com/vector-im/riot-web/issues/14231
 
 .mx_RoomSublist2 {
     // The sublist is a column of rows, essentially

res/css/views/rooms/_RoomTile2.scss

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-// TODO: Rename to mx_RoomTile during replacement of old component
+// TODO: Rename on launch: https://github.com/vector-im/riot-web/issues/14231
 
 // Note: the room tile expects to be in a flexbox column container
 .mx_RoomTile2 {
@@ -96,7 +96,8 @@ limitations under the License.
     // TODO: [Notifications] Use mx_RoomTile2_notificationsButton, similar to the following approach:
     // https://github.com/matrix-org/matrix-react-sdk/blob/2180a56074f3698fc0241c309a72ba6cad802d1c/res/css/views/rooms/_RoomSublist2.scss#L48-L76
     // You'll need to do the same down below on the &:hover selector for the tile.
-    // ... also remove this 4 line TODO comment.
+    // See https://github.com/vector-im/riot-web/issues/13961.
+    // ... also remove this 5 line TODO comment.
     .mx_RoomTile2_menuButton,
     .mx_RoomTile2_notificationsButton {
         width: 0;

src/components/structures/LeftPanel2.tsx

@@ -31,6 +31,9 @@ import { UPDATE_EVENT } from "../../stores/AsyncStore";
 import ResizeNotifier from "../../utils/ResizeNotifier";
 import SettingsStore from "../../settings/SettingsStore";
 
+// TODO: Remove banner on launch: https://github.com/vector-im/riot-web/issues/14231
+// TODO: Rename on launch: https://github.com/vector-im/riot-web/issues/14231
+
 /*******************************************************************
  *   CAUTION                                                       *
  *******************************************************************
@@ -45,7 +48,7 @@ interface IProps {
 }
 
 interface IState {
-    searchFilter: string; // TODO: Move search into room list?
+    searchFilter: string;
     showBreadcrumbs: boolean;
     showTagPanel: boolean;
 }
@@ -54,12 +57,7 @@ export default class LeftPanel2 extends React.Component<IProps, IState> {
     private listContainerRef: React.RefObject<HTMLDivElement> = createRef();
     private tagPanelWatcherRef: string;
 
-    // TODO: Properly support TagPanel
-    // TODO: Properly support searching/filtering
-    // TODO: Properly support breadcrumbs
-    // TODO: a11y
-    // TODO: actually make this useful in general (match design proposals)
-    // TODO: Fadable support (is this still needed?)
+    // TODO: a11y: https://github.com/vector-im/riot-web/issues/14180
 
     constructor(props: IProps) {
         super(props);
@@ -138,7 +136,7 @@ export default class LeftPanel2 extends React.Component<IProps, IState> {
         }
     }
 
-    // TODO: Apply this on resize, init, etc for reliability
+    // TODO: Improve header reliability: https://github.com/vector-im/riot-web/issues/14232
     private onScroll = (ev: React.MouseEvent<HTMLDivElement>) => {
         const list = ev.target as HTMLDivElement;
         this.handleStickyHeaders(list);
@@ -150,11 +148,6 @@ export default class LeftPanel2 extends React.Component<IProps, IState> {
     };
 
     private renderHeader(): React.ReactNode {
-        // TODO: Update when profile info changes
-        // TODO: Presence
-        // TODO: Breadcrumbs toggle
-        // TODO: Menu button
-
         let breadcrumbs;
         if (this.state.showBreadcrumbs) {
             breadcrumbs = (
@@ -173,8 +166,6 @@ export default class LeftPanel2 extends React.Component<IProps, IState> {
     }
 
     private renderSearchExplore(): React.ReactNode {
-        // TODO: Collapsed support
-
         return (
             <div className="mx_LeftPanel2_filterContainer">
                 <RoomSearch onQueryUpdate={this.onSearch} isMinimized={this.props.isMinimized} />
@@ -195,7 +186,7 @@ export default class LeftPanel2 extends React.Component<IProps, IState> {
             </div>
         );
 
-        // TODO: Improve props for RoomList2
+        // TODO: Determine what these onWhatever handlers do: https://github.com/vector-im/riot-web/issues/14180
         const roomList = <RoomList2
             onKeyDown={() => {/*TODO*/}}
             resizeNotifier={null}
@@ -206,7 +197,7 @@ export default class LeftPanel2 extends React.Component<IProps, IState> {
             isMinimized={this.props.isMinimized}
         />;
 
-        // TODO: Conference handling / calls
+        // TODO: Conference handling / calls: https://github.com/vector-im/riot-web/issues/14177
 
         const containerClasses = classNames({
             "mx_LeftPanel2": true,

src/components/structures/RoomSearch.tsx

@@ -25,6 +25,8 @@ import { Key } from "../../Keyboard";
 import AccessibleButton from "../views/elements/AccessibleButton";
 import { Action } from "../../dispatcher/actions";
 
+// TODO: Remove banner on launch: https://github.com/vector-im/riot-web/issues/14231
+
 /*******************************************************************
  *   CAUTION                                                       *
  *******************************************************************

src/components/structures/UserMenu.tsx

@@ -136,7 +136,7 @@ export default class UserMenu extends React.Component<IProps, IState> {
         ev.preventDefault();
         ev.stopPropagation();
 
-        // TODO: Archived room view (deferred)
+        // TODO: Archived room view: https://github.com/vector-im/riot-web/issues/14038
         console.log("TODO: Show archived rooms");
     };
 

src/components/views/rooms/NotificationBadge.tsx

@@ -35,7 +35,8 @@ export const NOTIFICATION_STATE_UPDATE = "update";
 export enum NotificationColor {
     // Inverted (None -> Red) because we do integer comparisons on this
     None, // nothing special
-    Bold, // no badge, show as unread // TODO: This goes away with new notification structures
+    // TODO: Remove bold with notifications: https://github.com/vector-im/riot-web/issues/14227
+    Bold, // no badge, show as unread
     Grey, // unread notified messages
     Red,  // unread pings
 }
@@ -141,6 +142,8 @@ export default class NotificationBadge extends React.PureComponent<IProps, IStat
     }
 }
 
+// TODO: Clean up these state classes: https://github.com/vector-im/riot-web/issues/14153
+
 export class StaticNotificationState extends EventEmitter implements INotificationState {
     constructor(public symbol: string, public count: number, public color: NotificationColor) {
         super();

src/components/views/rooms/RoomBreadcrumbs2.tsx

@@ -23,7 +23,10 @@ import { Room } from "matrix-js-sdk/src/models/room";
 import defaultDispatcher from "../../../dispatcher/dispatcher";
 import Analytics from "../../../Analytics";
 import { UPDATE_EVENT } from "../../../stores/AsyncStore";
-import { CSSTransition, TransitionGroup } from "react-transition-group";
+import { CSSTransition } from "react-transition-group";
+
+// TODO: Remove banner on launch: https://github.com/vector-im/riot-web/issues/14231
+// TODO: Rename on launch: https://github.com/vector-im/riot-web/issues/14231
 
 /*******************************************************************
  *   CAUTION                                                       *
@@ -86,7 +89,9 @@ export default class RoomBreadcrumbs2 extends React.PureComponent<IProps, IState
     };
 
     public render(): React.ReactElement {
-        // TODO: Decorate crumbs with icons
+        // TODO: Decorate crumbs with icons: https://github.com/vector-im/riot-web/issues/14040
+        // TODO: Scrolling: https://github.com/vector-im/riot-web/issues/14040
+        // TODO: Tooltips: https://github.com/vector-im/riot-web/issues/14040
         const tiles = BreadcrumbsStore.instance.rooms.map((r, i) => {
             return (
                 <AccessibleButton

src/components/views/rooms/RoomList2.tsx

@@ -30,6 +30,9 @@ import { ActionPayload } from "../../../dispatcher/payloads";
 import { NameFilterCondition } from "../../../stores/room-list/filters/NameFilterCondition";
 import { ListLayout } from "../../../stores/room-list/ListLayout";
 
+// TODO: Remove banner on launch: https://github.com/vector-im/riot-web/issues/14231
+// TODO: Rename on launch: https://github.com/vector-im/riot-web/issues/14231
+
 /*******************************************************************
  *   CAUTION                                                       *
  *******************************************************************
@@ -120,6 +123,8 @@ const TAG_AESTHETICS: {
         isInvite: false,
         defaultHidden: false,
     },
+
+    // TODO: Replace with archived view: https://github.com/vector-im/riot-web/issues/14038
     [DefaultTagID.Archived]: {
         sectionLabel: _td("Historical"),
         isInvite: false,
@@ -174,11 +179,11 @@ export default class RoomList2 extends React.Component<IProps, IState> {
         for (const orderedTagId of TAG_ORDER) {
             if (COMMUNITY_TAGS_BEFORE_TAG === orderedTagId) {
                 // Populate community invites if we have the chance
-                // TODO
+                // TODO: Community invites: https://github.com/vector-im/riot-web/issues/14179
             }
             if (CUSTOM_TAGS_BEFORE_TAG === orderedTagId) {
                 // Populate custom tags if needed
-                // TODO
+                // TODO: Custom tags: https://github.com/vector-im/riot-web/issues/14091
             }
 
             const orderedRooms = this.state.sublists[orderedTagId] || [];