Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-03-06 03:34:09 +01:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Provide doc-comments with makeHandler(); cleanup

Browse source
This commit is contained in:
Kitsune Ral 2017-11-15 07:28:25 +09:00
parent 33463e3907
commit 868af0a7a1
1 changed files with 14 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
api/validator.js
View file

@ -34,10 +34,20 @@ var errFn = function(err, api) {
process.exit(1); process.exit(1);
}; };
/**
* @brief Produce a handler for parser.validate().
* Recommended usage: `parser.validate(filename, makeHandler(filename));`
* or `parser.validate(schema, makeHandler());`.
* @param scope - usually a filename, this will be used to denote
* an (in)valid schema in console output; "Schema" if undefined
* @returns {function} the handler that can be passed to parser.validate
*/
function makeHandler(scope) { function makeHandler(scope) {
if (!scope)
scope = "Schema";
return function(err, api, metadata) { return function(err, api, metadata) {
if (err) { if (err) {
console.error("%s is not valid.", scope); console.error("%s is not valid.", scope || "Schema");
errFn(err, api, metadata); // Won't return errFn(err, api, metadata); // Won't return
} }
@ -45,7 +55,7 @@ function makeHandler(scope) {
var operationsMap = api.paths[endpoint]; var operationsMap = api.paths[endpoint];
Object.keys(operationsMap).forEach(function (verb) { Object.keys(operationsMap).forEach(function (verb) {
if (!operationsMap[verb]["operationId"]) { if (!operationsMap[verb]["operationId"]) {
console.log("%s is not valid", scope); console.error("%s is not valid", scope);
errFn("operationId is missing in " + endpoint + ", verb " + verb, api); errFn("operationId is missing in " + endpoint + ", verb " + verb, api);
} }
}) })
@ -66,11 +76,11 @@ if (isDir) {
var suffix = ".yaml"; var suffix = ".yaml";
if (f.indexOf(suffix, f.length - suffix.length) > 0) { if (f.indexOf(suffix, f.length - suffix.length) > 0) {
parser.validate(path.join(opts.schema, f), makeHandler(f)); parser.validate(path.join(opts.schema, f), makeHandler(f));
} }
}); });
}); });
} }
else{ else{
parser.validate(opts.schema, makeHandler(opt.schema)); parser.validate(opts.schema, makeHandler(opts.schema));
} }