[utils] Ban enums, and replace them with alternatives

Abierto
#10,211 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
65/100
Tipo de issue
Refactorización
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
typescript
Área
tooling

Línea de trabajo

Empieza en packages/utils, en src/caip-types.ts:134, src/misc.ts:137 y src/time.ts:4, para inspeccionar los tres enums exportados y sus puntos de llamada. Sustitúyelos por objetos const y tipos unión derivados, conservando el comportamiento en los puntos de llamada, y adapta la regla de lint a la configuración compartida de core. Se considera terminado cuando las exportaciones de los enums sean estructurales y el breaking change esté preparado para una versión major.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Carried over from https://github.com/MetaMask/utils/pull/280, which was approved but still open when @metamask/utils moved into core.

TypeScript is structurally typed nearly everywhere, but enums are nominal. Two enums that look identical are not assignable to each other, so a value produced by one copy of a package fails to typecheck against a function from another copy. That bites hardest in a monorepo with duplicated versions in the tree.

packages/utils still exports three:

  • KnownCaipNamespace in src/caip-types.ts:134
  • JsonSize in src/misc.ts:137
  • Duration in src/time.ts:4

The original PR replaces them with const objects plus derived union types, which keeps the call sites working while making the types structural.

Note this is a breaking change for consumers who use the enum types nominally, so it wants a major. The PR's .eslintrc.js rule does not port directly since core has its own shared config.

Lenguaje dominante
TypeScript
Estrellas
422
Forks
313
Merge medio
1 d 8 h
PR fusionados (30 d)
414

Preparar el entorno

  • Sin Dockerfile ni archivo de Docker Compose
  • Tiene una plantilla de pull request
  • Sin guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de MetaMask/core

Todos los issues de MetaMask/core

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.