RocketChat / RocketChat/Rocket.Chat
Remove explicit-function-return-type suppressions in engagement dashboard hooks
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 46.1k
- Forks
- 13.9k
- Avg merge
- 3d 3h
- Merged PRs (30d)
- 130
Description
Several hooks inside the engagement dashboard disable the ESLint rule @typescript-eslint/explicit-function-return-type using inline suppressions.
This reduces type safety and introduces inconsistency with other hooks in the codebase that explicitly annotate their return types.
Affected Files
Located in:
apps/meteor/client/views/admin/engagementDashboard/
The following hooks currently suppress the rule:
useChannelsList.tsuseActiveUsers.tsuseMessageOrigins.tsuseMessagesSent.tsuseHourlyChatActivity.tsuseTopFivePopularChannels.tsuseUsersByTimeOfTheDay.tsuseWeeklyChatActivity.ts
Each file contains:
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the eight hooks in apps/meteor/client/views/admin/engagementDashboard/: useChannelsList.ts, useActiveUsers.ts, useMessageOrigins.ts, useMessagesSent.ts, useHourlyChatActivity.ts, useTopFivePopularChannels.ts, useUsersByTimeOfTheDay.ts, and useWeeklyChatActivity.ts. Inspect their inferred return types and surrounding hook conventions, then verify that each file passes @typescript-eslint/explicit-function-return-type without the inline suppression.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- frontend, tooling
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 65/100