This repository has been archived by the owner on Sep 7, 2021. It is now read-only.
U - Lint ingredient order #338
Labels
js-linting
All issues that concern linting of JS docs
Milestone
A follow up to #320 .
We should lint for the order of ingredients in pages.
Implementation notes
This is a little bit tricky. Some ingredients are only meaningful in order (e.g.,
prose.short_description
) and linting the ingredient in-depth is the only meaningful check on it. But others can exist anywhere in a page (most prose sections).A possible route to implementation might be to use
html-require-recipe-ingredients
. After linting ingredients, it could check to see if any new messages were logged to a file. If not (i.e., if all ingredients matched), then it could check the order of section headings. This might be good enough for many, maybe even most, pages.Acceptance criteria
The linter is able to check that all ingredients appear in the correct order, according to the specification agreed in mdn/sprints#3075.
The text was updated successfully, but these errors were encountered: