tracey-cli/build/Requirement/Collector.js

A markdown-based requirements tool

"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
    if (k2 === undefined) k2 = k;
    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
}) : (function(o, m, k, k2) {
    if (k2 === undefined) k2 = k;
    o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
    Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
    o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
    if (mod && mod.__esModule) return mod;
    var result = {};
    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
    __setModuleDefault(result, mod);
    return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.collect = void 0;
var fs = __importStar(require("fs"));
var path = __importStar(require("path"));
var Markdown_1 = require("./Markdown");
var Collector_1 = require("../Common/Collector");
/**
 * Check if the file is MarkDown
 * @param file The file
 * @requirement #[ Requirement.Collect ]# #( Requirements must be stored in markdown files )#
 */
var isMarkdownFile = function (file) { return path.parse(file).ext === '.md'; };
/**
 * Check if the file has a MarkDown frontmatter identifier
 * @param file The file
 * @requirement #[ Requirement.Identifier ]# #( Requirements must have a yaml frontmatter identifier )#
 */
var hasFrontmatterIdentifier = function (file) {
    var _a;
    var ast = Markdown_1.parse(fs.readFileSync(file, { encoding: 'utf-8' }));
    var output = Boolean((_a = Markdown_1.parseFrontmatter(ast)) === null || _a === void 0 ? void 0 : _a.id);
    if (!output) {
        console.log("\nWARNING: File " + file + " has no frontmatter identifier\nFix this warning by adding a frontmatter identifier or excluding the file in the configuration\n\n");
    }
    return output;
};
/**
 * Collect all requirement files that pass all conditions
 * @param configuration The configuration
 */
var collect = function (configuration) { return Collector_1.createCollector(configuration, [
    isMarkdownFile,
    hasFrontmatterIdentifier,
]); };
exports.collect = collect;