Function readVersionEntry

scripts/format-changelog.js:81–146

(ctx, rawEntry, versionInfo)

}

function readVersionEntry(ctx, rawEntry, versionInfo) {
    // Check for the '- ' prefix
    var text = rawEntry.text;
    if (!text.startsWith("- ")) {
        reportLineError(rawEntry, "Expected entry prefix '- '");
    }
    text = text.substr(2);

    // Extract the change type
    const changeTypeIdx = text.indexOf(":");
    if (changeTypeIdx == -1) {
        reportLineError(rawEntry, "Expected change type");
    }
    var changeType = text.substring(0, changeTypeIdx).trim();
    text = text.substring(changeTypeIdx + 1).trim();

    // Check if changeType is valid
    if (!ChangeTypes.includes(changeType)) {
        // Check for substitution
        if (changeType in ChangeTypeSubstitutions) {
            changeType = ChangeTypeSubstitutions[changeType];
        } else {
            reportLineError(rawEntry, `Invalid change type '${changeType}', types can be ${ChangeTypes.join(", ")}`);
        }
    }

    // Extract the references.
    var refs = [];
    if (text.startsWith("[")) {
        const refsEndIdx = text.indexOf("]");
        if (refsEndIdx == -1) {
            reportLineError(rawEntry, "Open reference bracket '[' without closing bracket ']'");
        }
        refs = text.substring(1, refsEndIdx).split(",").map(ref => ref.trim());
        text = text.substring(refsEndIdx + 1).trim();
    } else {
        // Text must start with '[', allow having this missing in older versions.
        if (versionInfo.date == "???") {
            reportLineError(rawEntry, "Expected reference [#REF]");
        }
    }

    // Make sure the message starts with text and not special characters.
    if (text.length == 0) {
        reportLineError(rawEntry, "Expected description text");
    }

    // Check that messages start correctly.
    if (text[0] == '-' || text[0] == ':') {
        reportLineError(rawEntry, `Description must start with text, '${text[0]}' is not allowed`);
    }

    // Check if reference is correct, can be '#123' or 'project#123'
    for (const ref of refs) {
        if (!isValidReference(ref)) {
            reportLineError(rawEntry, `Invalid reference '${ref}', must be '#123' or 'project#123'`);
        }
    }