MetaMask / MetaMask/snaps

Run TypeScript type checking alongside the current build process to provide errors to the user

Open
#709 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
853
Forks
662
Avg merge
2d 8h
Merged PRs (30d)
8

Description

Currently the CLI doesn't inform the user of typing errors in TypeScript input and builds successfully even with typing errors. Instead we should probably show the typing errors to the user.

Potentially we could add a flag to skip the errors and build regardless.

This happens because we use a Babel plugin for TypeScript support, which simply strips the types without checking them. Instead, we should probably run TypeScript type checking (without emitting) alongside our build process.

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 locating the CLI build process and the Babel plugin configuration that strips TypeScript types without checking them. Run the current build with TypeScript input containing a typing error, then define completion as reporting those errors during the build without emitting output; whether an opt-out flag is needed remains open in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
babel, typescript
Domain
build-system, cli
Issue type
Feature
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.