Skip to content

Rename misleading coverage variables in jsdoc-validation workflow #419

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pethers merged 2 commits into from
Feb 21, 2026
Merged

Rename misleading coverage variables in jsdoc-validation workflow #419

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
02ec091
Initial plan
Copilot Feb 21, 2026
cc9010f
rename TOTAL_JS→TOTAL_SOURCE_FILES and FILES_WITH_JSDOC→FILES_WITH_DO…
Copilot Feb 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .github/workflows/jsdoc-validation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,15 +146,15 @@ jobs:
echo "📊 Checking documentation coverage in source files..."

# Count source files (JS + TS) across all source directories
TOTAL_JS=$(find src/browser scripts \( -name "*.js" -o -name "*.ts" \) | grep -v node_modules | grep -v lib/ | grep -v ".min." | grep -v ".d.ts" | wc -l)
TOTAL_SOURCE_FILES=$(find src/browser scripts \( -name "*.js" -o -name "*.ts" \) | grep -v node_modules | grep -v lib/ | grep -v ".min." | grep -v ".d.ts" | wc -l)

# Count files with doc comments (/** */)
FILES_WITH_JSDOC=$(find src/browser scripts \( -name "*.js" -o -name "*.ts" \) ! -name "*.min.*" ! -name "*.d.ts" ! -path "*/lib/*" -exec grep -l "/\*\*" {} \; | wc -l)
FILES_WITH_DOC_COMMENTS=$(find src/browser scripts \( -name "*.js" -o -name "*.ts" \) ! -name "*.min.*" ! -name "*.d.ts" ! -path "*/lib/*" -exec grep -l "/\*\*" {} \; | wc -l)

echo "📈 Documentation Coverage: $FILES_WITH_JSDOC / $TOTAL_JS files"
echo "📈 Documentation Coverage: $FILES_WITH_DOC_COMMENTS / $TOTAL_SOURCE_FILES files"

if [ "$TOTAL_JS" -gt 0 ]; then
COVERAGE_PERCENT=$((FILES_WITH_JSDOC * 100 / TOTAL_JS))
if [ "$TOTAL_SOURCE_FILES" -gt 0 ]; then
COVERAGE_PERCENT=$((FILES_WITH_DOC_COMMENTS * 100 / TOTAL_SOURCE_FILES))
echo "📊 Coverage: ${COVERAGE_PERCENT}%"

if [ "$COVERAGE_PERCENT" -lt 50 ]; then
Expand Down