Skip to content

Run

What you need, the scopes you can scan, and the two config files that change behaviour.

What you need

What you need to run Angular Doctor
NeedDetail
Node.js 20.19+The angular-doctor package requires Node.js 20.19.0 or newer.
An Angular workspaceangular.json or nx.json in the directory you scan, or in a parent, up to 12 levels up.
Angular 15+Angular 17 and newer get every check. Angular 15 and 16 scan in compat mode, with checks that need newer Angular switched off instead of flagging old code. Older than 15 stops with a clear message.
A terminalnpx @abiramcodes/angular-doctor@latest runs a one-off scan without adding a dependency. Pass a path to scan another folder.
No extra installConfig is optional. Add angular-doctor.config.json, or an angularDoctor field in package.json, only when you want to change the report path, ignore files, or override a rule.

Configuration

Those two config sources are read together. When both set the same field, package.json wins. A .ts config file is not loaded.

Two config sources

Put the JSON in angular-doctor.config.json, or under the angularDoctor key in package.json. When both set the same field, package.json wins.

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