Skip to content

Commit

Permalink
[editorial][CI] Ensure markdownlint has proper exit status (#210)
Browse files Browse the repository at this point in the history
Co-authored-by: Josh Suereth <[email protected]>
  • Loading branch information
chalin and jsuereth authored Jul 27, 2023
1 parent a5509c6 commit 73408c9
Showing 1 changed file with 13 additions and 9 deletions.
22 changes: 13 additions & 9 deletions gulpfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ const markdownlint = require("markdownlint");
const yaml = require("js-yaml");
const fs = require("fs");

let fileCount = 0,
issueCount = 0;
let numFilesProcessed = 0,
numFilesWithIssues = 0;

function markdownLintFile(file, encoding, callback) {
const config = yaml.load(fs.readFileSync("./.markdownlint.yaml", "utf8"));
Expand Down Expand Up @@ -33,9 +33,11 @@ function markdownLintFile(file, encoding, callback) {
.join("\n");
if (resultString) {
console.log(resultString);
issueCount++;
numFilesWithIssues++;
// Don't report an error yet so that other files can be checked:
// callback(new Error('...'));
}
fileCount++;
numFilesProcessed++;
callback(null, file);
});
}
Expand All @@ -47,11 +49,13 @@ function lintMarkdown() {
.src(markdownFiles)
.pipe(through2.obj(markdownLintFile))
.on("end", () => {
console.log(
`Processed ${fileCount} file${
fileCount == 1 ? "" : "s"
}, ${issueCount} had issues.`,
);
const fileOrFiles = "file" + (numFilesProcessed == 1 ? "" : "s");
const msg = `Processed ${numFilesProcessed} ${fileOrFiles}, ${numFilesWithIssues} had issues.`;
if (numFilesWithIssues > 0) {
throw new Error(msg);
} else {
console.log(msg);
}
});
}

Expand Down

0 comments on commit 73408c9

Please sign in to comment.