repowisedotnet/docfx

dotnet / docfx

csharpmain96d08d882.5K linessynced 1w ago

Code health

9.1out of 10Excellent

This codebase scores 9.1 out of 10 for code health, which we rate excellent. It also scores maintainability 9.1 and static performance 9.9 out of 10. The three are scored separately and never blended into one number. Risk is concentrated, as it usually is: 3 of 1,462 files are git hotspots, and they average 7.0 — which is where the fixes pay off most.

Full health report
Documentation1,250pages
45 with model-written prose, 1,205 built from the indexScore validation4/203.4× baselineTop-ranked files that did go on to need a bug fixDead code56exportsUnused exports that nothing in the graph reaches

Do next

3 suggested

3 things worth doing in the week to Oct 4, the last indexed commit.

Worth planning

  • Break up CreatePdf (CCN 8, 221 lines)

    src/Docfx.App/PdfBuilder.cs:155

    CreatePdf nests deeply; easier to read and change once split; function changed in 10 commits; its file is imported by 3 files, changed 1 time in 90 days.

    gain
    up to +1.6 health on this file(inferred)
    finding
    Nested complexity
    size
    CCN 8, 221 lines, nests 5 deep
    severity
    high
    worth a check

  • Break up ResolveItemCore (CCN 44, 195 lines)

    src/Docfx.Build/TableOfContents/TocResolver.cs:134

    ResolveItemCore nests deeply; easier to read and change once split; its file is imported by 1 file.

    gain
    up to +1.1 health on this file(inferred)
    finding
    Nested complexity
    size
    CCN 44, 195 lines, nests 5 deep
    severity
    high
    worth a check

  • Start breaking up <anonymous> (CCN 34, 283 lines): first lift lines 57-67

    templates/common/RestApi.common.js:57

    <anonymous> nests deeply; easier to read and change once split.

    gain
    up to +1.6 health on this file(inferred)
    finding
    Nested complexity
    size
    CCN 34, 283 lines, nests 6 deep
    severity
    high
    worth a check

Improve what Repowise can see

  • Add a test coverage report

    Without one, Repowise cannot tell tested code from untested code, so every test-related action says “unknown”.

    line coverage
    Unknown, no report
Lines of code
82.5K
Files
1,462
Symbols
8,846
Modules
6
Languages
5

Recent activity

All commits

Commits

Decisions

Everything we found

907 open

Every detector's open count by area, each with its worst example. An inventory, not a to-do list: the actions above are the part worth doing.

Composition

Open the graph
  • csharp94%
  • javascript4%
  • typescript1%
  • dockerfile<1%
  • vbnet<1%

Explore this codebase