[FEATURE]: Validate config options

Offen

#8,067 erstellt am 22.9.2026 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 3/5
Geschätzter Aufwand: 1-2 Tage
Anfängerfreundlichkeit: 65/100

Issue-Typ: Feature
Klarheit: Klar beschrieben
Aktivitätsstatus: Aktiv
Tech-Stack: javascript
Bereich: tooling

Rechercherichtung

Look at the config object definition in src/plot_api/plot_config.js and the configAttributes schema. Use Lib.validate and Lib.warn from lib/index.js to check incoming config keys and values against the schema, skipping valType: 'any'. Test by creating a plot with an invalid config key like 'shapePositon' and verifying a warning appears in the console.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

enhancement feature P3 plotly-internal size: 3

Description

Validate the config object against configAttributes and warn on anything that does not match. Do not change the value.

Why should this feature be added?

Config is the only user-facing input plotly.js never checks. Plotly.validate takes data and layout only. A typo like edits: { shapePositon: true } does nothing, reports nothing, and costs the user an afternoon.

plotly.py already wants this. plotly/offline/offline.py warns on unknown keys from a hardcoded tuple, with the comment: "we don't have code generation logic in place yet to guarantee that the config options in plotly.py are up to date". Schema-driven validation in plotly.js gives every port the list.

Notes

An unknown key gets dropped with no notice
A value that fails its valType doesn't get stopped
We should warn on invalid values. Coercion would replace bad values with defaults and silently change charts that work today.
Utilize the existing Lib.validate and Lib.warn
Skip the five attributes whose valType is any. Lib.validate accepts anything for them.
This should only validate the incoming config, not the resolved _context
This might be noisy for users until configs are corrected

Vorherrschende Sprache: JavaScript
Sterne: 18.3k
Forks: 2k
Ø Merge: 2 T. 10 Std.
Gemergte PRs (30 T.): 30

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus plotly/plotly.js

[BUG]: incorrect `downloadImage` type definition Offen

bug

Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 85/100

plotly/plotly.js#8072 · Erstellt am 24.9.2026
[CHORE]: Warn on config values that do not match the schema Offen

chore P3 plotly-internal size: 3 task

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 77/100

plotly/plotly.js#8064 · Erstellt am 21.9.2026
[CHORE]: Change default to `true` for `responsive` config attribute Offen

chore P1 plotly-internal size: 1 task

Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 82/100

plotly/plotly.js#8034 · Erstellt am 10.9.2026
[CHORE]: Deprecate plotly.js-mapbox* npm packages Offen

chore P3 plotly-internal size: 1 task

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100

plotly/plotly.js#8029 · Erstellt am 08.9.2026
[mkdocs] Update link in Edit this Page button Offen

bug

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100

plotly/plotly.js#7648 · 3 Kommentare · Erstellt am 18.11.2025

Alle Issues in plotly/plotly.js