---
url: 'https://adk.nht.io/api/@nhtio/adk/batteries/dev-tools/interfaces/Diagnostic.md'
description: A diagnostic returned by the pipeline.
---

# Interface: Diagnostic

Defined in: [src/batteries/dev\_tools/types.ts:37](https://github.com/NHTIO/ADK/blob/master/src/src/batteries/dev_tools/types.ts#L37)

A diagnostic returned by the pipeline.

## Extends

* [`RawDiagnostic`](RawDiagnostic.md)

## Properties

| Property                                      | Type                                      | Description                                                                                             | Inherited from                                                                         | Defined in                                                                                                               |
| --------------------------------------------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
|  `column?`        | `number`                                  | Optional one-based start column; requires a valid line.                                                 | [`RawDiagnostic`](RawDiagnostic.md).[`column`](RawDiagnostic.md#property-column)       | [src/batteries/dev\_tools/types.ts:30](https://github.com/NHTIO/ADK/blob/master/src/src/batteries/dev_tools/types.ts#L30) |
|  `endColumn?`  | `number`                                  | Optional one-based range end column.                                                                    | [`RawDiagnostic`](RawDiagnostic.md).[`endColumn`](RawDiagnostic.md#property-endcolumn) | [src/batteries/dev\_tools/types.ts:34](https://github.com/NHTIO/ADK/blob/master/src/src/batteries/dev_tools/types.ts#L34) |
|  `endLine?`      | `number`                                  | Optional one-based range end line.                                                                      | [`RawDiagnostic`](RawDiagnostic.md).[`endLine`](RawDiagnostic.md#property-endline)     | [src/batteries/dev\_tools/types.ts:32](https://github.com/NHTIO/ADK/blob/master/src/src/batteries/dev_tools/types.ts#L32) |
|  `engineId`     | `string` | `null`                        | Engine id stamped by dispatch; null identifies diagnostics produced by the runtime.                     | -                                                                                      | [src/batteries/dev\_tools/types.ts:39](https://github.com/NHTIO/ADK/blob/master/src/src/batteries/dev_tools/types.ts#L39) |
|  `line?`            | `number`                                  | Optional one-based start line; invalid values are removed during normalization.                         | [`RawDiagnostic`](RawDiagnostic.md).[`line`](RawDiagnostic.md#property-line)           | [src/batteries/dev\_tools/types.ts:28](https://github.com/NHTIO/ADK/blob/master/src/src/batteries/dev_tools/types.ts#L28) |
|  `message`       | `string`                                  | Human-readable finding text; it remains useful even when invalid coordinates are removed.               | [`RawDiagnostic`](RawDiagnostic.md).[`message`](RawDiagnostic.md#property-message)     | [src/batteries/dev\_tools/types.ts:24](https://github.com/NHTIO/ADK/blob/master/src/src/batteries/dev_tools/types.ts#L24) |
|  `outOfScope` | `boolean`                                 | True when the normalized file path is absent from the post-step workspace; always false for null paths. | -                                                                                      | [src/batteries/dev\_tools/types.ts:41](https://github.com/NHTIO/ADK/blob/master/src/src/batteries/dev_tools/types.ts#L41) |
|  `path`             | `string` | `null`                        | Workspace-relative file path; null identifies a workspace-level diagnostic with no single file.         | [`RawDiagnostic`](RawDiagnostic.md).[`path`](RawDiagnostic.md#property-path)           | [src/batteries/dev\_tools/types.ts:20](https://github.com/NHTIO/ADK/blob/master/src/src/batteries/dev_tools/types.ts#L20) |
|  `rule?`            | `string`                                  | Optional engine rule identifier.                                                                        | [`RawDiagnostic`](RawDiagnostic.md).[`rule`](RawDiagnostic.md#property-rule)           | [src/batteries/dev\_tools/types.ts:26](https://github.com/NHTIO/ADK/blob/master/src/src/batteries/dev_tools/types.ts#L26) |
|  `severity`     | [`Severity`](../type-aliases/Severity.md) | Diagnostic severity; only `error` makes a plan unsuccessful.                                            | [`RawDiagnostic`](RawDiagnostic.md).[`severity`](RawDiagnostic.md#property-severity)   | [src/batteries/dev\_tools/types.ts:22](https://github.com/NHTIO/ADK/blob/master/src/src/batteries/dev_tools/types.ts#L22) |