Add workflow for pana score

cadivus · cadivus · commit 93335dd1140c · 2026-03-11T00:53:15.000+01:00
diff --git a/.github/composite_actions/package_score/action.yaml b/.github/composite_actions/package_score/action.yaml
@@ -0,0 +1,67 @@
+name: Package Score
+description: |
+  Run pana (pub.dev package analyzer) to compute the package score,
+  print a readable report to the workflow log, and upload an HTML
+  report as a workflow artifact.
+
+inputs:
+  working-directory:
+    description: The working directory of the package (relative to repo root)
+    required: true
+  package-name:
+    description: The name of the package being scored
+    required: true
+  exit-code-threshold:
+    description: |
+      Fail the step if (maxPoints - grantedPoints) exceeds this value.
+      Set to -1 to never fail. Default 160 means score must be >= 0/160.
+    required: false
+    default: "160"
+
+runs:
+  using: "composite"
+  steps:
+    - name: Install pana
+      shell: bash
+      run: dart pub global activate pana
+
+    - name: Run pana
+      id: pana
+      shell: bash
+      working-directory: ${{ inputs.working-directory }}
+      run: |
+        # Run pana with threshold; capture markdown output and exit code.
+        set +e
+        if [ "${{ inputs.exit-code-threshold }}" != "-1" ]; then
+          dart pub global run pana \
+            --exit-code-threshold ${{ inputs.exit-code-threshold }} \
+            --no-warning . > "$RUNNER_TEMP/pana_score.md" 2>&1
+        else
+          dart pub global run pana \
+            --no-warning . > "$RUNNER_TEMP/pana_score.md" 2>&1
+        fi
+        PANA_EXIT=$?
+        set -e
+        echo "pana_exit=$PANA_EXIT" >> "$GITHUB_OUTPUT"
+        echo "score_md=$RUNNER_TEMP/pana_score.md" >> "$GITHUB_OUTPUT"
+
+    - name: Render score report
+      shell: bash
+      run: |
+        python3 "$GITHUB_ACTION_PATH/render_score.py" \
+          "${{ steps.pana.outputs.score_md }}" \
+          --html "$RUNNER_TEMP/score_report.html"
+
+    - name: Upload HTML score report
+      if: always()
+      uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # 7.0.0
+      with:
+        name: score_report-${{ inputs.package-name }}-${{ github.run_id }}
+        path: ${{ runner.temp }}/score_report.html
+
+    - name: Enforce score threshold
+      if: steps.pana.outputs.pana_exit != '0'
+      shell: bash
+      run: |
+        echo "::error::Pana score is below the required threshold (exit-code-threshold: ${{ inputs.exit-code-threshold }})"
+        exit ${{ steps.pana.outputs.pana_exit }}
diff --git a/.github/composite_actions/package_score/render_score.py b/.github/composite_actions/package_score/render_score.py
@@ -0,0 +1,213 @@
+#!/usr/bin/env python3
+"""Render pana score output as a readable ASCII terminal report and generate an HTML report."""
+import html
+import re
+import sys
+import textwrap
+
+
+def _bar_ascii(label, got, total):
+    pct = got / total if total else 0
+    filled = int(pct * 20)
+    return f"  {label:<45} [{'█' * filled + '░' * (20 - filled)}] {got}/{total}"
+
+
+def _bar_html(label, got, total):
+    pct = got / total if total else 0
+    pct_int = int(pct * 100)
+    color = "#4caf50" if pct >= 0.8 else "#ff9800" if pct >= 0.5 else "#f44336"
+    return (
+        f'<div class="bar-row">'
+        f'<span class="bar-label">{html.escape(label)}</span>'
+        f'<div class="bar-track"><div class="bar-fill" style="width:{pct_int}%;background:{color};"></div></div>'
+        f'<span class="bar-score">{got}/{total}</span>'
+        f'</div>'
+    )
+
+
+def render_ascii(text):
+    """Render score markdown as ASCII terminal output."""
+    W = 72
+    lines = []
+
+    def bar(label, got, total):
+        return _bar_ascii(label, got, total)
+
+    lines.append("=" * W)
+    lines.append("  PACKAGE SCORE REPORT".center(W))
+    lines.append("=" * W)
+
+    m = re.search(r'Points:\s*(\d+)\s*/\s*(\d+)', text)
+    if m:
+        got, total = int(m.group(1)), int(m.group(2))
+        lines.append(f"\n  Total: {got} / {total} points")
+        lines.append(bar("Overall", got, total))
+        lines.append("")
+
+    for sm in re.finditer(r'^## (✓|✗)\s+(.+?)\s*\((\d+)\s*/\s*(\d+)\)', text, re.M):
+        icon = "✓" if sm.group(1) == "✓" else "✗"
+        name, got, total = sm.group(2), int(sm.group(3)), int(sm.group(4))
+        lines.append("-" * W)
+        lines.append(f"  {icon}  {name}")
+        lines.append(bar(name, got, total))
+
+        sec_start = sm.end()
+        sec_end = text.find("\n## ", sec_start)
+        if sec_end == -1:
+            sec_end = len(text)
+        section = text[sec_start:sec_end]
+
+        for sub in re.finditer(r'^### \[(.)\]\s+(\d+)/(\d+) points:\s+(.+)', section, re.M):
+            mark = sub.group(1)
+            sg, st, label = int(sub.group(2)), int(sub.group(3)), re.sub(r'\*\*([^*]+)\*\*', r'\1', sub.group(4))
+            sym = {"*": "✓", "x": "✗", "~": "~"}.get(mark, mark)
+            lines.append(f"    {sym} {sg:>2}/{st:<2}  {label}")
+
+        if "platform" in name.lower():
+            if re.search(r'\*\*WASM-ready:\*\*', section):
+                lines.append(f"    ✓  WASM compatible")
+            elif re.search(r'not WASM-compatible', section):
+                lines.append(f"    ✗  WASM not compatible (partial Web score)")
+
+    lines.append("-" * W)
+
+    issues = re.findall(
+        r'The constraint `([^`]+)` on (\w+) does not support the stable version `([^`]+)`', text
+    )
+    if issues:
+        lines.append(f"\n  ⚠  Dependency issues ({len(issues)}):")
+        for constraint, pkg, ver in issues:
+            lines.append(f"    • {pkg}: {constraint} doesn't support {ver}")
+
+    lines.append("")
+    return "\n".join(lines)
+
+
+def render_html(text):
+    """Render score markdown as an HTML report."""
+    parts = []
+    parts.append(textwrap.dedent("""\
+    <!DOCTYPE html>
+    <html lang="en">
+    <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>Package Score Report</title>
+    <style>
+      * { box-sizing: border-box; margin: 0; padding: 0; }
+      body { font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
+             background: #f5f5f5; color: #333; padding: 2rem; max-width: 900px; margin: 0 auto; }
+      h1 { text-align: center; margin-bottom: 0.5rem; }
+      .total { text-align: center; font-size: 1.4rem; margin-bottom: 1.5rem; color: #555; }
+      .section { background: #fff; border-radius: 8px; padding: 1.2rem 1.5rem;
+                 margin-bottom: 1rem; box-shadow: 0 1px 3px rgba(0,0,0,0.1); }
+      .section-header { display: flex; align-items: center; gap: 0.5rem;
+                        font-size: 1.1rem; font-weight: 600; margin-bottom: 0.8rem; }
+      .icon-pass { color: #4caf50; } .icon-fail { color: #f44336; }
+      .bar-row { display: flex; align-items: center; gap: 0.8rem; margin: 0.4rem 0; }
+      .bar-label { flex: 1; font-size: 0.9rem; }
+      .bar-track { width: 200px; height: 14px; background: #e0e0e0; border-radius: 7px; overflow: hidden; }
+      .bar-fill { height: 100%; border-radius: 7px; transition: width 0.3s; }
+      .bar-score { font-size: 0.9rem; font-weight: 600; min-width: 50px; }
+      .sub-item { padding: 0.2rem 0 0.2rem 1.5rem; font-size: 0.9rem; }
+      .sub-item .icon-pass, .sub-item .icon-fail { font-weight: bold; }
+      .details { margin-top: 0.5rem; padding: 0.8rem; background: #fafafa;
+                 border-radius: 4px; font-size: 0.85rem; border-left: 3px solid #ddd; }
+      .dep-issues { background: #fff3e0; border-left-color: #ff9800; }
+      footer { text-align: center; margin-top: 2rem; font-size: 0.8rem; color: #999; }
+    </style>
+    </head>
+    <body>
+    <h1>📊 Package Score Report</h1>
+    """))
+
+    # Total score
+    m = re.search(r'Points:\s*(\d+)\s*/\s*(\d+)', text)
+    if m:
+        got, total = int(m.group(1)), int(m.group(2))
+        parts.append(f'<div class="total">{got} / {total} points</div>')
+        parts.append(_bar_html("Overall", got, total))
+
+    # Sections
+    for sm in re.finditer(r'^## (✓|✗)\s+(.+?)\s*\((\d+)\s*/\s*(\d+)\)', text, re.M):
+        passed = sm.group(1) == "✓"
+        icon_cls = "icon-pass" if passed else "icon-fail"
+        icon_char = "✓" if passed else "✗"
+        name, got, total = sm.group(2), int(sm.group(3)), int(sm.group(4))
+
+        parts.append('<div class="section">')
+        parts.append(f'<div class="section-header"><span class="{icon_cls}">{icon_char}</span> {html.escape(name)}</div>')
+        parts.append(_bar_html(name, got, total))
+
+        sec_start = sm.end()
+        sec_end = text.find("\n## ", sec_start)
+        if sec_end == -1:
+            sec_end = len(text)
+        section = text[sec_start:sec_end]
+
+        for sub in re.finditer(r'^### \[(.)\]\s+(\d+)/(\d+) points:\s+(.+)', section, re.M):
+            mark = sub.group(1)
+            sg, st = int(sub.group(2)), int(sub.group(3))
+            label = re.sub(r'\*\*([^*]+)\*\*', r'\1', sub.group(4))
+            sub_passed = mark == "*"
+            si_cls = "icon-pass" if sub_passed else "icon-fail"
+            si_char = "✓" if sub_passed else "✗"
+            parts.append(f'<div class="sub-item"><span class="{si_cls}">{si_char}</span> {sg}/{st} — {html.escape(label)}</div>')
+
+        # WASM status
+        if "platform" in name.lower():
+            if re.search(r'\*\*WASM-ready:\*\*', section):
+                parts.append('<div class="sub-item"><span class="icon-pass">✓</span> WASM compatible</div>')
+            elif re.search(r'not WASM-compatible', section):
+                parts.append('<div class="sub-item"><span class="icon-fail">✗</span> WASM not compatible</div>')
+
+        # Extract detail blocks (content within <details>)
+        for detail in re.finditer(r'<details>\s*<summary>\s*(.*?)\s*</summary>\s*(.*?)\s*</details>', section, re.S):
+            summary_text = re.sub(r'<[^>]+>', '', detail.group(1)).strip()
+            detail_body = re.sub(r'<[^>]+>', '', detail.group(2)).strip()
+            if summary_text or detail_body:
+                parts.append(f'<div class="details"><strong>{html.escape(summary_text)}</strong><br>{html.escape(detail_body)}</div>')
+
+        parts.append('</div>')
+
+    # Dependency issues
+    issues = re.findall(
+        r'The constraint `([^`]+)` on (\w+) does not support the stable version `([^`]+)`', text
+    )
+    if issues:
+        parts.append('<div class="section">')
+        parts.append(f'<div class="section-header"><span class="icon-fail">⚠</span> Dependency issues ({len(issues)})</div>')
+        for constraint, pkg, ver in issues:
+            parts.append(f'<div class="sub-item dep-issues">• {html.escape(pkg)}: <code>{html.escape(constraint)}</code> doesn\'t support {html.escape(ver)}</div>')
+        parts.append('</div>')
+
+    parts.append('<footer>Generated by pana — <a href="https://pub.dev/packages/pana">pub.dev/packages/pana</a></footer>')
+    parts.append('</body></html>')
+    return "\n".join(parts)
+
+
+def main():
+    if len(sys.argv) < 2:
+        print("Usage: render_score.py <score.md> [--html <output.html>]", file=sys.stderr)
+        sys.exit(1)
+
+    score_path = sys.argv[1]
+    text = open(score_path).read()
+
+    # Always print ASCII to stdout
+    print(render_ascii(text))
+
+    # Generate HTML if --html flag is given
+    if "--html" in sys.argv:
+        idx = sys.argv.index("--html")
+        if idx + 1 < len(sys.argv):
+            html_path = sys.argv[idx + 1]
+        else:
+            html_path = "score_report.html"
+        with open(html_path, "w") as f:
+            f.write(render_html(text))
+        print(f"HTML report written to {html_path}")
+
+
+if __name__ == "__main__":
+    main()
diff --git a/.github/workflows/dart_vm.yaml b/.github/workflows/dart_vm.yaml
@@ -106,6 +106,13 @@ jobs:
         run: dart analyze --fatal-infos --fatal-warnings .
         working-directory: ${{ inputs.working-directory }}
 
+      - name: Package Score
+        if: "always() && steps.bootstrap.conclusion == 'success' && matrix.sdk == 'stable'"
+        uses: ./.github/composite_actions/package_score
+        with:
+          working-directory: ${{ inputs.working-directory }}
+          package-name: ${{ inputs.package-name }}
+
       - name: Run Tests (stable)
         if: "always() && steps.bootstrap.conclusion == 'success' && steps.testCheck.outputs.hasTests == 'true' && matrix.sdk == 'stable'"
         run: dart test
diff --git a/.github/workflows/flutter_vm.yaml b/.github/workflows/flutter_vm.yaml
@@ -88,6 +88,13 @@ jobs:
         run: flutter analyze --fatal-infos --fatal-warnings .
         working-directory: ${{ inputs.working-directory }}
 
+      - name: Package Score
+        if: "always() && steps.bootstrap.conclusion == 'success' && matrix.channel == 'stable' && matrix.flutter-version == 'any'"
+        uses: ./.github/composite_actions/package_score
+        with:
+          working-directory: ${{ inputs.working-directory }}
+          package-name: ${{ inputs.package-name }}
+
       - name: Run Tests
         id: testJob
         if: "always() && steps.bootstrap.conclusion == 'success' && steps.testCheck.outputs.hasTests == 'true'"
