docutils-ts/dist/src/transforms/frontmatter.js

Port of the Python Docutils library to TypeScript

import * as nodes from '../nodes.js';
import Transform from '../transform.js';
/**
 * TitlePromoter transform.
 * Base class for other transforms which promote section names to title and subtitle
 */
class TitlePromoter extends Transform {
    promoteTitle(node) {
        if (!(node instanceof nodes.Element)) {
            throw new TypeError('node must be of Element-derived type.');
        }
        // assert not (len(node) and isinstance(node[0], nodes.title))
        const [section, index] = this.candidateIndex(node);
        if (index == null) {
            return undefined;
        }
        node.updateAllAttsConcatenating(section, true, true);
        const newChildren = [
            ...section.children.slice(0, 1),
            ...node.getChildren().slice(0, index),
            ...section.children.slice(1)
        ];
        node.clearChildren();
        node.add(newChildren);
        // assert isinstance(node[0], nodes.title)
        return 1;
    }
    promoteSubtitle(node) {
        // console.log('promoteSubtitle');
        // Type check
        const x = this.candidateIndex(node);
        const subsection = x[0];
        const index = x[1];
        if (index == null) {
            return undefined;
        }
        const subtitle = new nodes.subtitle();
        // Transfer the subsection's attributes to the new subtitle
        // NOTE: Change second parameter to False to NOT replace
        //       attributes that already exist in node with those in
        //       section
        // NOTE: Remove third parameter to NOT copy the 'source'
        //       attribute from section
        subtitle.updateAllAttsConcatenating(subsection, true, true);
        // Transfer the contents of the subsection's title to the
        // subtitle:
        subtitle.add(subsection.getChild(0).getChildren());
        node.add([
            node.getChild(0), // title
            subtitle,
            ...node.getChildren().slice(1, index),
            ...subsection.getChildren().slice(1)
        ]);
        return 1;
    }
    candidateIndex(node) {
        const index = node.firstChildNotMatchingClass(nodes.PreBibliographic);
        if (index == null || node.getNumChildren() > (index + 1)
            || !(node.getChild(index) instanceof nodes.section)) {
            return [null, null];
        }
        return [node.getChild(index), index];
    }
}
export class DocTitle extends TitlePromoter {
    setMetadata() {
        if (!('title' in this.document.attributes)) {
            let title = this.document.settings.title;
            if (title != null) {
                this.document.attributes.title = title;
            }
            else if (this.document.hasChildren() && this.document.getChild(0) instanceof nodes.title) {
                this.document.attributes.title = this.document.getChild(0).astext();
            }
        }
    }
    apply() {
        if (this.document.settings.doctitleXform || typeof this.document.settings.doctitleXform === 'undefined') {
            if (this.promoteTitle(this.document)) {
                this.promoteSubtitle(this.document);
            }
        }
        this.setMetadata();
    }
}
DocTitle.defaultPriority = 320;
export class SectionSubTitle extends TitlePromoter {
    apply() {
        let reader = this.document.settings;
        if (!reader || (reader.sectsubtitleXform || typeof reader.sectsubtitleXform === 'undefined')) {
            this.document.traverse({ condition: nodes.section }).forEach((section) => {
                // On our way through the node tree, we are deleting
                // sections, but we call self.promote_subtitle for those
                // sections nonetheless.  To do: Write a test case which
                // shows the problem and discuss on Docutils-develop.
                this.promoteSubtitle(section);
            });
        }
    }
}
SectionSubTitle.defaultPriority = 350;
export class DocInfo extends Transform {
    _init(document, startNode) {
        super._init(document, startNode);
        this.biblioNodes = {
            author: nodes.author,
            authors: nodes.authors,
            organization: nodes.organization,
            address: nodes.address,
            contact: nodes.contact,
            version: nodes.version,
            revision: nodes.revision,
            status: nodes.status,
            date: nodes.date,
            copyright: nodes.copyright,
            dedication: nodes.topic,
            abstract: nodes.topic,
        };
    }
    apply() {
    }
    extractBibliographic(fieldList) {
    }
    checkEmptyBiblioField(field, name) {
    }
    checkCompoundBiblioField(field, name) {
    }
    // rcsKeywordSubstitutions = [] // todo fixme
    /*    rcs_keyword_substitutions = [
          (re.compile(r'\$' r'Date: (\d\d\d\d)[-/](\d\d)[-/](\d\d)[ T][\d:]+'
                      r'[^$]* \$', re.IGNORECASE), r'\1-\2-\3'),
          (re.compile(r'\$' r'RCSfile: (.+),v \$', re.IGNORECASE), r'\1'),
          (re.compile(r'\$[a-zA-Z]+: (.+) \$'), r'\1'),]
    */
    extractAuthors(field, name, docinfo) {
    }
    authorsFromOneParagraph(field) {
    }
    authorsFromBulletList(field) {
    }
    authorsFromParagraphs(field) {
    }
}
DocInfo.defaultPriority = 340;
export { TitlePromoter };