Skip to content

beta: JSDoc completeness ratchet red across ~12 components #333

Description

@rubenvdlinde

Problem

beta's Code Quality job (the check:jsdoc completeness ratchet) is failing because ~12 components have dropped below their recorded baseline. This blocks every PR into beta on Code Quality, forcing admin merges (e.g. #332, the configuration-over-code docs publish).

Components below baseline (current → baseline)

  • CnCopyDialog 55% → 82%
  • CnDeleteDialog 55% → 82%
  • CnMassCopyDialog 62% → 92%
  • CnMassDeleteDialog 62% → 92%
  • CnMassExportDialog 45% → 82%
  • CnMassImportDialog 35% → 87%
  • CnMassActionBar 44% → 69%
  • CnNotesCard 40% → 80%
  • CnSchemaFormDialog 51% → 79%
  • CnFormBuilder 67% → 100%
  • CnFileManager 95% → 100%
  • CnMarkdownEditor 92% → 100%
  • CnDashboardPage 65% → 67%
  • CnTreeView 83% → 100% (events update:expanded-ids / update:selected-id not picked up by vue-docgen despite @event JSDoc — likely an extraction quirk worth investigating)

(CnTimelineView and CnUserActionMenu were restored to 100% in #332.)

Likely cause

These regressed during the work that landed on beta ahead of development (beta is ~52 commits of its own + behind development by ~567). The baselines expect higher coverage than the current SFCs carry.

Fix

Add the missing JSDoc (prop/event/slot) per .claude "Documenting components" until each component returns to its baseline, then confirm with npm run check:jsdoc. The CnTreeView case may need a vue-docgen extraction fix rather than added comments.

Why it matters

Until this is green, beta PRs can't pass Code Quality and must be admin-merged, which defeats the gate.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions