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

Aperta Adatta ai principianti
#8,064 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
77/100
Tipo di issue
Funzionalità
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
javascript
Ambito
data-visualization

Direzione di ricerca

Inizia in src/plot_api/plot_api.js da setPlotContext, quindi leggi src/plot_api/plot_config.js per comprendere configAttributes e i relativi metadati valType. Controlla ogni valore applicabile con Lib.validate e mostra un avviso in caso di mancata corrispondenza, ignorando gli attributi con valType: 'any'. Il lavoro è completato quando i valori tipizzati non validi producono avvisi senza convertire o sostituire i valori.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.
Lingua principale
JavaScript
Stelle
18.3k
Fork
2k
Merge medio
2g 10h
PR unite (30g)
30

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di plotly/plotly.js

Tutte le issue di plotly/plotly.js

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.