UI5 / cli / 27620244988

94%

push

github

fix(documentation): Make API sidebar generation deterministic and order-safe

The API sidebar in .vitepress/config.ts is built by walking
fs.readdirSync("docs/api") and merging entries into a tree. Two issues
were causing failures and inconsistencies:

- readdirSync returns entries in filesystem order (insertion order on
  Linux, alphabetical on macOS APFS). When a "module-..." leaf file
  was processed before a sibling that needed to nest under the same
  name (e.g. module-@ui5_logger.md before @ui5_logger_Logger.md), the
  recursion crashed with "Cannot read properties of undefined (reading
  'push')" because the leaf had no items array. This broke the
  build:vitepress step on GitHub Actions.
- Even when it succeeded, sibling order in the generated sidebar
  varied across platforms.

Fixes:
- Sort the readdir result so the input order — and therefore the
  resulting tree — is identical across filesystems.
- Make appendToTree defensive: when a leaf and a branch share a name,
  merge them by promoting the leaf to a branch and attaching the
  module doc as a 'main' child, in either order. This keeps the build
  working even if the sort is removed or the file set changes.

6427 of 7105 branches covered (90.46%)

Branch coverage included in aggregate %.

12279 of 12822 relevant lines covered (95.77%)

5814.27 hits per line