diff options
| -rw-r--r-- | README.md | 4 |
1 files changed, 2 insertions, 2 deletions
@@ -582,9 +582,9 @@ Run a given linter on the lint information provided by the given targets. | Field | Description | | ----- | ----------- | -| `"linter"` | Single artifact running the lint checks. This artifact with - argv`[1]` the file to lint, and - argv`[2:]` the original command line. This invocation happens in an environment with - CONFIG pointing to the directory with all the artifacts given by the field `"config"`. - OUT pointing to a directory to which files with the lint result can be written. The linter is supposed to indicate by the exit code whether the indicated file complies with the given linting policy, with 0 meaning compliant. Stdout and stderr, as well as the directory $`{OUT}` can be used to provide additional information. | +| `"linter"` | Single artifact running the lint checks. This program is invoked with - argv`[1]` the file to lint, and - argv`[2:]` the original command line. This invocation happens in an environment with - CONFIG pointing to the directory with all the artifacts given by the field `"config"`, and - OUT pointing to a directory to which files with the lint result can be written. It is supposed to indicate by the exit code whether the file to lint complies with the given linting policy, with 0 meaning compliant. Stdout and stderr, as well as the directory $`{OUT}` can be used to provide additional information. | | `"config"` | Any configuration or other files needed by the linter. | -| `"summarizer"` | Single artifact generating a summary of the individual lint results. It will be called in a directory where all subdirectories with names consisting entirely of digits are the results of the individual lint actions. Those are given as - a file result with content PASS if and only if the lint action exited 0, - files stdout and stderr with stdout and stderr of the lint action, and - a directory out with the additional information provided by the lint action. The summarizer is required to indicate the overall result by the exit code, produce a human-readable summary on stdout, and optionally additional information in the directory $`{OUT}`. | +| `"summarizer"` | Single artifact generating a summary of the individual lint results. It will be called in a directory where all subdirectories except . and .. represent the results of the individual lint actions. Those are given as - a file `"result"` with content `"PASS"` if and only if the lint action exited 0, - files `"stdout"` and `"stderr"` with stdout and stderr of the lint action, and - a directory `"out"` with the additional information provided by the lint action. The summarizer is required to indicate the overall result by the exit code, produce a human-readable summary on stdout, and optionally additional information in the directory $`{OUT}`. | ### Rule `["lint", "defaults"]` |