Build system could be more helpful when reporting slug-folder naming discrepencies

[captainbrosset]

Summary

While working on PR mdn/content#31176 I got this error:

Error: The document's slug (Web/API/TextFormatUpdateEvent/getTextFormats) doesn't match its disk folder name (en-us/web/api/textformatupdateevent/getTextFormats)

I stayed blocked for a long time figuring out what was wrong. I read the two strings many many times, trying to find a typo that I, somehow, couldn't find.

It turns out the folder name was camelCase, when really it should have been lowercase.

The error message is misleading here. It's telling me that the folder name doesn't match the slug, but really it does.

Can we make the error message say something like "please lowercase the folder name" in this scenario?

URL

mdn/content#31176

Reproduction steps

1. Make the mistake of camelcasing a folder name
2. Push the branch and create a PR on mdn/content
3. Wait for the build to kick in and report the issue

Expected behavior

The error message should be more obvious. I'm sure this has already bitten many people in the past.

Actual behavior

The error message doesn't tell you what the actual problem is.

Device

Desktop

Browser

Other (specify below)

Browser version

Other version (specify below)

Operating system

Other (specify below)

Screenshot

No response

Anything else?

No response

Validations

• I have read the Community Participation Guidelines.
• I have verified that there isn't already an issue that reports the same bug to avoid creating a duplicate.
• I have checked that this is a concrete bug. For Q&A open a GitHub Discussion.