[CHORE]: Warn on config values that do not match the schema

Abierto Apto para principiantes
#8,064 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
77/100
Tipo de issue
Nueva funcionalidad
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
javascript
Área
data-visualization

Línea de trabajo

Comienza en src/plot_api/plot_api.js, en setPlotContext, y luego lee src/plot_api/plot_config.js para entender configAttributes y sus metadatos de valType. Comprueba cada valor aplicable con Lib.validate y muestra una advertencia cuando no coincida, omitiendo los atributos con valType: 'any'. Se considera terminado cuando los valores tipados no válidos producen advertencias sin convertir ni reemplazar valores.

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

Descripción

chore P3 plotly-internal size: 3 task
Description

Validate config values in setPlotContext against configAttributes and call Lib.warn on a mismatch.

Why should this change be made?

src/plot_api/plot_config.js says valType and values are documentation only, so a bad config value lands in _context in silence and fails somewhere else later.

Full coercion would replace bad values with defaults, which silently changes charts that work today. A warning gives the diagnostic benefit with no behavior change, and the hit rate tells us whether coercion is worth it later.

The metadata supports it: every typed config attribute is self-consistent, with no dflt outside its own values.

Scope
  • src/plot_api/plot_api.js - in setPlotContext, run Lib.validate(value, attr) per key and warn on false
  • Skip the valType: 'any' attributes. Lib.validate accepts anything for them.
Lenguaje dominante
JavaScript
Estrellas
18.3k
Forks
2k
Merge medio
2 d 10 h
PR fusionados (30 d)
30

Guía de contribución

Abrir la 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 plotly/plotly.js

Todos los issues de plotly/plotly.js

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.