mapbox / mapbox/mapbox-gl-js

Missing type definitions for the `diff` function

Open
#8,128 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

In our codebase we use:

import { diff } from '@mapbox/mapbox-gl-style-spec';

but it doesn't come with a flow type definition. It would be great to publish that. I could be something like:

declare export function diff(before: ?StyleSpecification, after: StyleSpecification): Array<Command>;

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

Start at the @mapbox/mapbox-gl-style-spec import entry point and inspect how the diff export is exposed. Add and publish its Flow declaration with the before, after, and Command types shown in the issue; done means consumers can import diff without a missing type definition.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.