Skip to content

Commit

Permalink
add missing document for EndColumn template field at -format argu…
Browse files Browse the repository at this point in the history
…ment
  • Loading branch information
rhysd committed Jun 23, 2023
1 parent 73a6aee commit f4f8728
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,14 +122,15 @@ The sequence can be traversed with `range` statement, which is like `for ... = r

The error object has the following fields.

| Field | Description | Example |
|---------------------|----------------------------------------------------|------------------------------------------------------------------|
| `{{$err.Message}}` | Body of error message | `property "platform" is not defined in object type {os: string}` |
| `{{$err.Snippet}}` | Code snippet to indicate error position | ` node_version: 16.x\n ^~~~~~~~~~~~~` |
| `{{$err.Kind}}` | Name of rule the error belongs to | `expression` |
| `{{$err.Filepath}}` | Canonical relative file path of the error position | `.github/workflows/ci.yaml` |
| `{{$err.Line}}` | Line number of the error position (1-based) | `21` |
| `{{$err.Column}}` | Column number of the error position (1-based) | `20` |
| Field | Description | Example |
|----------------------|-------------------------------------------------------|------------------------------------------------------------------|
| `{{$err.Message}}` | Body of error message | `property "platform" is not defined in object type {os: string}` |
| `{{$err.Snippet}}` | Code snippet to indicate error position | ` node_version: 16.x\n ^~~~~~~~~~~~~` |
| `{{$err.Kind}}` | Name of rule the error belongs to | `expression` |
| `{{$err.Filepath}}` | Canonical relative file path of the error position | `.github/workflows/ci.yaml` |
| `{{$err.Line}}` | Line number of the error position (1-based) | `9` |
| `{{$err.Column}}` | Column number of the error's start position (1-based) | `11` |
| `{{$err.EndColumn}}` | Column number of the error's end position (1-based) | `23` |

For example, the following simple iteration body

Expand Down

0 comments on commit f4f8728

Please sign in to comment.