mapbox / mapbox/mapbox-gl-js

Allow sources to provide their own validation logic

Open
#3,003 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

feature :green_apple:
Dominant language
TypeScript
Stars
12.4k
Forks
2.4k
PR merge metrics
No merged PRs in 30d

Description

Presently, it is not possible to do something like this:

``` js
map.addSourceType('my-custom-source-type', CustomSource, function () {
map.setStyle(stylesheet /* a style JSON that includes a source with { type: my-custom-source-type } */)
})
```

because when `stylesheet` is validated, `my-custom-source-type` registers as invalid.

Proposed fix: allow for dynamically relaxing/skipping validation based on the present set of known custom source types.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Trace the addSourceType and setStyle entry points, then follow stylesheet validation and the registry of known source types. Confirm how custom source types are registered before validation runs. Done means a stylesheet containing a registered custom source type validates while unknown source types remain rejected.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.