TypeScript guidelines: Add Derive types from authoritative sources guideline#178
Open
MajorLift wants to merge 2 commits into
Open
TypeScript guidelines: Add Derive types from authoritative sources guideline#178MajorLift wants to merge 2 commits into
Derive types from authoritative sources guideline#178MajorLift wants to merge 2 commits into
Conversation
Derive types from authoritative sources guidelineDerive types from authoritative sources guideline
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a
Derive types from authoritative sources instead of re-declaring themsubsection to the Type Inference section.The section already covers preferring inference for values and avoiding accidental widening, but not the common case (especially with AI) of hand-writing a type that restates one an authoritative source already defines.
Includes counterexamples.
Note
Low Risk
Documentation-only change to
docs/typescript.md; no runtime or build behavior is affected.Overview
Adds a Type Inference subsection, Derive types from authoritative sources instead of re-declaring them, to
docs/typescript.md.It tells contributors to derive types from existing sources (controller state, returns,
@metamask/*exports, schemas) viaState['field'],typeof,ReturnType/Parameters, andPick/Omit/Partial, instead of hand-written duplicates that widen shapes and drift from the source. It links to the existing widening and inference guidelines and includes a permalinked counterexample:getMetaMaskState: () => Record<string, unknown>versus composing fromTokenListStateto avoid per-use-site casts andas never.Reviewed by Cursor Bugbot for commit ee26d36. Bugbot is set up for automated code reviews on this repo. Configure here.