Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

check-openapi: Check that descriptions are formatted with Prettier. 

Signed-off-by: Anders Kaseorg <anders@zulip.com>
This commit is contained in:
Anders Kaseorg 2021-09-08 16:34:30 -07:00 committed by Tim Abbott
parent b7b4c033a5
commit b45548e85a
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
tools/check-openapi
View File

@ -5,6 +5,7 @@
const fs = require("fs"); const fs = require("fs");
const ExampleValidator = require("openapi-examples-validator"); const ExampleValidator = require("openapi-examples-validator");
const Prettier = require("prettier");
const SwaggerParser = require("swagger-parser"); const SwaggerParser = require("swagger-parser");
const {LineCounter, Scalar, YAMLMap, YAMLSeq, parseDocument, visit} = require("yaml"); const {LineCounter, Scalar, YAMLMap, YAMLSeq, parseDocument, visit} = require("yaml");
@ -49,6 +50,23 @@ async function checkFile(file) {
console.error("%s:%d:%d: Too many inline allOf subschemas", file, line, col); console.error("%s:%d:%d: Too many inline allOf subschemas", file, line, col);
ok = false; ok = false;
} }
if (
node.key instanceof Scalar &&
node.key.value === "description" &&
node.value instanceof Scalar &&
typeof node.value.value === "string"
) {
let formatted = Prettier.format(node.value.value, {parser: "markdown"});
if (![Scalar.BLOCK_FOLDED, Scalar.BLOCK_LITERAL].includes(node.value.type)) {
formatted = formatted.replace(/\n$/, "");
}
if (formatted !== node.value.value) {
ok = false;
const {line, col} = lineCounter.linePos(node.value.range[0]);
console.error("%s:%d:%d: Format description with Prettier", file, line, col);
}
}
}, },
}); });