akash-network / akash-network/console

Turn on explicit-module-boundary-types

Open
#958 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
264
Forks
94
Avg merge
18h 49m
Merged PRs (30d)
297

Description

Why

Explicit types for function return values and arguments makes it clear to any calling code what is the module boundary's input and output. Adding explicit type annotations for those types can help improve code readability. It can also improve TypeScript type checking performance on larger codebases. Also it helps to avoid mistakes on early stage, because after refactoring the return type of function may not be the same as callers expect

What

Enable https://typescript-eslint.io/rules/explicit-module-boundary-types

This is a hard migration, so very likely we will need to do it iteratively, per package, per app and with separate eslint config

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the ESLint configuration for each package or app and the explicit-module-boundary-types rule documentation. Enable the rule incrementally with separate ESLint configurations where needed, then resolve the resulting violations; the migration is done when the targeted packages pass lint with the rule enabled.

Written by the indexing model from the issue text.

Assessment

Tech stack
eslint, typescript
Domain
developer-experience, tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.