Make approach to defining enums consistent across the project

Abierto
#663 6 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 6 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
25/100
Tipo de issue
Refactorización
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
go
Área
tooling

Línea de trabajo

Comparar las definiciones de enum introducidas por #654 para Ecosystem con analysis.Mode, staticanalysis.Task y analysisrun.DynamicPhase. Revisar cómo gestiona cada una las cadenas, las listas, las flags, la serialización JSON y String(), y acordar después un único enfoque documentado que cubra las bases numéricas frente a las de tipo string y el comportamiento de marshaling requerido.

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

Descripción

go internal cleanup needs discussion

#654 introduces the enum type Ecosystem implemented differently to other enums (e.g. analysis.Mode and staticanalysis.Task and analysisrun.DynamicPhase)

We should develop a consistent approach to how we define enums:

Some areas that should be covered:

  • should the base type be string vs numeric
  • how do we handle lists of enums
  • how do enums interact with flags
  • how do enums handle serialization (JSON)

Both:

  • require String()

Numeric based enums:

  • can use iota
  • can consume as little as 8bits (byte)
  • very fast to compare equality
  • encoding.TextMarshaler and encoding.TextUnmarshaler needed to support flag.TextVar and json serialization
  • requires strings to be specified for marshaling and unmarshaling (although an array of strings may make this easier)

String based enums:

  • consume 128 bits per enum
  • simpler String() function and serialization
  • equality is more costly (at minimum two comparisons, maximum the size of the shortest string)
Lenguaje dominante
Go
Estrellas
925
Forks
75
Merge medio
4 d 2 h
PR fusionados (30 d)
3

Preparar el entorno

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 ossf/package-analysis

Todos los issues de ossf/package-analysis

Issues similares

Más issues de Go

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.