docutils-ts/dist/src/newDocument.js

Port of the Python Docutils library to TypeScript

import { document } from './nodes.js';
import newReporter from './newReporter.js';
import { OptionParser } from './frontend.js';
import { RSTParser } from './parsers/restructuredtext.js';
import { InvalidStateError } from './exceptions.js';
/**
 * Return a new empty document object.
 *
 * :Parameters:
 * `source_path` : string
 * The path to or description of the source text of the document.
 * `settings` : optparse.Values object
 * Runtime settings.  If none are provided, a default core set will
 * be used.  If you will use the document object with any Docutils
 * components, you must provide their default settings as well.  For
 * example, if parsing, at least provide the parser settings,
 * obtainable as follows::
 *
 * settings = docutils.frontend.OptionParser(
 * components=(docutils.parsers.rst.Parser,)
 * ).get_default_values()
 * {@link module:nodes~document}
 * @returns {module:nodes~document} New document
 * @see module:newDocument~newDocument
 */
function newDocument(args, settings) {
    const { sourcePath } = args;
    if (settings === undefined) {
        settings = new OptionParser({ logger: args.logger, settingsSpecs: RSTParser.settingsSpec }).getDefaultValues();
    }
    if (settings === undefined) {
        throw new InvalidStateError('settings should not be undefined');
    }
    const reporter = newReporter({ sourcePath }, settings);
    const attrs = {};
    if (typeof sourcePath !== 'undefined') {
        attrs.source = sourcePath;
    }
    const myDocument = new document(settings, reporter, args.logger, '', [], attrs);
    myDocument.noteSource(sourcePath, -1);
    return myDocument;
}
export { newDocument };
export default newDocument;