ecmarkup/lib/lint/lint.js

"use strict";
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
    return new (P || (P = Promise))(function (resolve, reject) {
        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
        step((generator = generator.apply(thisArg, _arguments || [])).next());
    });
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.lint = void 0;
const collect_nodes_1 = require("./collect-nodes");
const collect_grammar_diagnostics_1 = require("./collect-grammar-diagnostics");
const collect_spelling_diagnostics_1 = require("./collect-spelling-diagnostics");
const collect_algorithm_diagnostics_1 = require("./collect-algorithm-diagnostics");
const collect_header_diagnostics_1 = require("./collect-header-diagnostics");
const collect_tag_diagnostics_1 = require("./collect-tag-diagnostics");
/*
Currently this checks
- grammarkdown's built-in sanity checks
- the productions in the definition of each early error and SDO are defined in the main grammar
- those productions do not include `[no LineTerminator here]` restrictions or `[+flag]` gating
- the algorithm linting rules imported above
- headers of abstract operations have consistent spacing
- certain common spelling errors

There's more to do:
https://github.com/tc39/ecmarkup/issues/173
*/
function lint(report, sourceText, spec, document) {
    return __awaiter(this, void 0, void 0, function* () {
        collect_spelling_diagnostics_1.collectSpellingDiagnostics(report, sourceText, spec.imports);
        collect_tag_diagnostics_1.collectTagDiagnostics(report, spec, document);
        const collection = collect_nodes_1.collectNodes(report, sourceText, spec, document);
        if (!collection.success) {
            return;
        }
        const { mainGrammar, headers, sdos, earlyErrors, algorithms } = collection;
        const { grammar, oneOffGrammars } = yield collect_grammar_diagnostics_1.collectGrammarDiagnostics(report, spec, sourceText, mainGrammar, sdos, earlyErrors);
        collect_algorithm_diagnostics_1.collectAlgorithmDiagnostics(report, spec, sourceText, algorithms);
        collect_header_diagnostics_1.collectHeaderDiagnostics(report, headers);
        // Stash intermediate results for later use
        // This isn't actually necessary for linting, but we might as well avoid redoing work later when we can.
        yield grammar.emit(undefined, (file, source) => {
            const name = +file.split('.')[0];
            const node = mainGrammar[name].element;
            if ('grammarkdownOut' in node) {
                throw new Error('unexpectedly regenerating grammarkdown output for node ' + name);
            }
            // @ts-ignore we are intentionally adding a property here
            node.grammarkdownOut = source;
        });
        for (const { grammarEle, grammar } of oneOffGrammars) {
            yield grammar.emit(undefined, (file, source) => {
                if ('grammarkdownOut' in grammarEle) {
                    throw new Error('unexpectedly regenerating grammarkdown output');
                }
                // @ts-ignore we are intentionally adding a property here
                grammarEle.grammarkdownOut = source;
            });
        }
        for (const pair of algorithms) {
            if ('tree' in pair) {
                // @ts-ignore we are intentionally adding a property here
                pair.element.ecmarkdownTree = pair.tree;
            }
        }
    });
}
exports.lint = lint;