Skip to content

Output

The terminal summary, the Markdown and HTML reports, and how color and config change what you see.

A normal scan prints a text summary. --json and --score-only replace that summary. Color is added only when stdout or stderr is a terminal. A pipe, a redirect, or a CI log stays plain text.

The text summary has a dim header (project, Angular major.minor, duration), a health meter, then errors, warnings, and notes. Findings follow, grouped once per rule: the rule id without the angular-doctor/ prefix, the shared message, then up to five locations. When a report file was written, the last line is its path.

The sample on the landing page is the default printout. Colors recolors it.

Markdown report

  • Summary: score, error count, warning count, info count, project name and kind, Angular version, and duration.
  • Official Angular migrations, then the ng generate @angular/core commands that match this scan. Each command is shown with --dry-run first.
  • A short fix order: migrations, style-guide findings, everything else, then a re-scan.
  • Findings grouped once per rule under their category, with every location, the shared message, and a suggested fix when the rule has one.
  • Skipped checks, when a check could not finish. Each line starts with the file path to open.
  • A JSON block at the end with the score, totals, and the recommended commands.

Excerpt

Excerpt from the sample workspace. The real file groups findings once per rule with relative locations, and includes the migration commands. A clean scan does not write this file.

angular-doctor-report.mdmd
# Angular Doctor report

> Self-contained findings for coding agents. Re-run `npx @abiramcodes/angular-doctor@latest --verbose` after fixes.

## Summary

- **Health score:** 81/100
- **Errors:** 9
- **Warnings:** 15
- **Infos:** 5
- **Project:** angular-doctor (angular-cli)
- **Angular:** 22.2.0
- **Scan duration:** 299ms

### angular-doctor/prefer-host-bindings (error) — 1 occurrence

- **Message:** @HostListener is backwards-compatible. Use the host option instead.
- **Suggested fix:** Move the binding into the host object of @Component or @Directive.
- **Locations:**
  - `src/app/style-violations/host-slider.ts:8:3`

HTML report

Pass --html, or add "html" to reportFormats in config, and the scan also writes angular-doctor-report.html next to the Markdown report. One self-contained file: score, severity totals, and findings grouped once per rule. Category tabs switch views. The Show select filters to errors, warnings, or info, and tab counts update to match. Reference links open in a new tab.

Skipped checks

A check that cannot finish on one file is skipped. The summary still prints, and the other files are still scanned. Each skip is a path in your project, then the reason:

terminaltext
Skipped checks
  scripts/lib/emit.ts: Invalid regular expression: /\b${names.join('\b/g: Unterminated group

Open that path. The same lines are under Skipped checks in the report, and in the skippedChecks array when you pass --json. The scan reads strings and comments as text. Search the reported file for import { inside a quote or a comment. A name that is not an identifier, such as ${names.join(', ')}, is one shape that does this. The path in the message is the file to open.

Where the file goes

Put that JSON in angular-doctor.config.json, or under the angularDoctor key in package.json. reportPath replaces the default angular-doctor-report.md. reportDirectory sets the folder when reportPath is omitted. ignore adds glob patterns on top of the built-in skips. rules sets a rule to off, warning, error, or info. --category and --json still apply on top of this file.

angular-doctor.config.jsonjson
{
  "reportPath": "reports/angular-doctor-report.md",
  "ignore": ["**/legacy/**"],
  "rules": {
    "angular-doctor/zone-js": "off"
  }
}