mui / mui/material-ui

[DX] Rename error prefix to use open-source project name?

Open
#39,351 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

discussion scope: all components
Dominant language
JavaScript
Stars
99.1k
Forks
32.5k
Avg merge
2d 17h
Merged PRs (30d)
106

Description

What's the problem? 🤔

Most of the codebase (MUI X included) throws errors with this convention: throw new MuiError('MUI: . This feels strange. Even if we make MUI the UI library, that has a Joy Design theme, and a Material Design theme, it still feels strange to have an error about Base UI or MUI X prefixed with MUI.

So my proposal would be to replace these prefixes to be more specific. The side benefit is that it will train developers to learn about these different projects.

I was inspired to open this issue from https://github.com/mui/mui-x/issues/10611, which was opened on the wrong repository.

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

The issue names no files, tests, or entry points. Start by reviewing the MuiError call sites and the related MUI X issue, then determine the project-specific naming scheme and the full scope across MUI, Base UI, and MUI X. Done would require an agreed convention and consistent error prefixes.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
developer-experience
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.