mapbox / mapbox/assembly

Create ESLint plugin for using Assembly with React

Open
#1,028 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

2 architecture enhancement estimate-4 icebox jira-sync-complete needs research p2 p3
Dominant language
CSS
Stars
138
Forks
26
Avg merge
1d 7h
Merged PRs (30d)
3

Description

Description

Ideally in projects like Studio we'd only use Assembly classes, or a small amount of custom CSS. Sadly sometimes things in className={} are misnamed or don't actually exist.

I think we should make an ESLint plugin that checks all className={} and classnames statements to ensure all classes are valid in MBX Assembly.

An escape hatch could be an ESLint option that accepts additional class names.

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 by reviewing how Assembly class names are defined and how React projects use className and classnames; the issue names no files or tests. Define the plugin’s validation scope for those statements and the additional-class escape hatch. Done means invalid or nonexistent Assembly classes are reported while permitted custom classes are accepted.

Written by the indexing model from the issue text.

Assessment

Tech stack
eslint, react
Domain
frontend, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.