chris48s
commented
2 weeks ago Here's an issue I didn't think of.
I need to output something sensible in getSingleResultLogMessage()
One way I could deal with this would be:
getSingleResultLogMessage(result, fileLocation, format) {
if (result.valid === false && format === "text") {
- return formatErrors(fileLocation, result.errors);
+ return formatErrors(`${fileLocation}[${result.documentIndex}]`, result.errors);
}
}
}That is simple and easy, but it means I'll switch from saying
./package.json#/version must be stringto
./package.json[0]#/version must be stringin all cases. It would be nice to avoid that given multiple documents in one file is quite an uncommon case.
I could do this:
let results = [];
for (const filename of filenames) {
const fileResults = await validateFile(filename, config, plugins, cache);
+ const multiDoc = fileResults.length > 1;
results = results.concat(fileResults);
for (const result of results) {
for (const plugin of plugins) {
+ const fileLocation = multiDoc
+ ? `${filename}[${result.documentIndex}]`
+ : filename;
const message = plugin.getSingleResultLogMessage(
result,
- filename,
+ fileLocation,
config.format,
);
if (message != null) {but it feels like a bit of a hack and means the content of fileLocation is inconsistent in different places.
I could make some kind of breaking change to getSingleResultLogMessage() that allows me to pass in a variable telling me if the file is a multi-doc.
Finally, I could indicate this in some way in the ValidationResult object. One way would be to add a specific property. The other thing I could do is say that documentIndex is null if the file only contains a single document and only populate it with a number when it contains >1. I think on balance that is probably the nicest approach.
codecov[bot]
Closes https://github.com/chris48s/v8r/issues/378
Changelog:
parseInputFile()may now returnDocument[]documentIndexproperty toValidationResulttype