mdn / mdn/browser-compat-data

Linter does not complain about API split up into multiple files

Open
#29,047 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

linter
Dominant language
JSON
Stars
5.8k
Forks
2.6k
Avg merge
1d 21h
Merged PRs (30d)
186

Description

What type of issue is this?

Linter issue

What is the issue?

Example: https://github.com/mdn/browser-compat-data/pull/29040

  • webassembly/api.json had webassembly.api.Memory.toFixedLengthBuffer()
  • webassembly/api/Memory.json has webassembly.api.Memory with sub-features
What behavior were you expecting?

My expectation is that if webassembly.api.Memory has its own file, then all sub-features must be in there (or in webassembly/api/Memory/*.json for that matter).

What version(s) of BCD is the issue present in?
  • The current BCD release
  • The current version of the main branch
Do you have anything more you want to share?

No response

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

Compare webassembly/api.json with webassembly/api/Memory.json and review the example in pull request 29040 to understand the split feature layout. Trace the linter behavior that checks these files, then verify that it reports sub-features placed outside the file containing their parent feature.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.