coreui / coreui-pro / 36727055497

96%

main: 94%

push

github

docs: document every public option, and a lint gate that keeps them documented (#1483)

* docs: document every public option, and a lint gate that keeps them documented

Nine options had no row in their component's Options table: allowList,
sanitize and sanitizeFn on Chip, searchNormalize on List Box, spinner
on Loading Button, menu on Menu and on Dropdown, id on Multi Select,
and strategy on Dropdown.

check-default-type.mjs kept Default in sync with DefaultType, but
nothing compared Default with the docs. build/check-docs-options.mjs
now reads the Default of every component exported from js/src/index.ts,
spreads of a parent's Default included, and fails on a key with no row
in the Options table of its page; it runs in `npm run lint`. The
reading of Default and DefaultType moves to build/component-options.mjs,
shared by both scripts.

Two lists carry a reason each. Waiting: the Calendar, Date Range Input
and Time Picker rows, which belong to the date and time docs still in
progress. Left out on purpose: the submenu options Dropdown inherits
from Menu, which its markup has nothing to act on, and the date-section
options Time Input inherits from SectionInput. An entry that gets a row
or leaves Default fails the check until it is removed.

* chore: raise three JS budgets the combined v6-dev went over

#1480, #1481 and #1482 each passed bundlewatch on its own branch, and
together they put v6-dev over the coreui.esm.min.js ceiling (98.51 KB
against 98.5 KB) and left coreui.bundle.min.js and coreui.js about
10 B under theirs. Growth since 8c6485a81, the base the three branched
from (zlib level 9): coreui.esm.min.js +244 B, coreui.bundle.min.js
+243 B, coreui.js +333 B. All three rise by 0.25 kB; this branch adds
no JS.

6371 of 6921 branches covered (92.05%)

Branch coverage included in aggregate %.

11473 of 11783 relevant lines covered (97.37%)

880.98 hits per line