vscode-xml/src/formatting/formatters/v2-xml-formatter.ts

import { XmlFormatter } from "../xml-formatter";
import { XmlFormattingOptions } from "../xml-formatting-options";
import { ClassicXmlFormatter } from "./classic-xml-formatter";

const MagicalStringOfWonders = "~::~MAAAGIC~::~";

/* tslint:disable no-use-before-declare */
export class V2XmlFormatter implements XmlFormatter {
    formatXml(xml: string, options: XmlFormattingOptions): string {
        // this replaces all "<" brackets inside of comments to a magical string
        // so the following minification steps don't mess with comment formatting
        xml = this._sanitizeComments(xml);

        // remove whitespace from between tags, except for line breaks
        xml = xml.replace(/>\s{0,}</g, (match: string) => {
            return match.replace(/[^\S\r\n]/g, "");
        });

        // do some light minification to get rid of insignificant whitespace
        xml = xml.replace(/"\s+(?=[^\s]+=)/g, "\" "); // spaces between attributes
        xml = xml.replace(/"\s+(?=>)/g, "\""); // spaces between the last attribute and tag close (>)
        xml = xml.replace(/"\s+(?=\/>)/g, "\" "); // spaces between the last attribute and tag close (/>)
        xml = xml.replace(/[^ <>="]\s+[^ <>="]+=/g, (match: string) => { // spaces between the node name and the first attribute
            return match.replace(/\s+/g, " ");
        });

        // the coast is clear - we can drop those "<" brackets back in
        xml = this._unsanitizeComments(xml);

        let output = "";

        let indentLevel = 0;
        let location = Location.Text;
        let lastNonTextLocation = Location.Text; // hah

        // NOTE: all "exiting" checks should appear after their associated "entering" checks
        for (let i = 0; i < xml.length; i++) {
            const cc = xml[i];
            const nc = xml.charAt(i + 1);
            const nnc = xml.charAt(i + 2);
            const pc = xml.charAt(i - 1);
            const ppc = xml.charAt(i - 2);

            // entering CData
            if (location === Location.Text && cc === "<" && nc === "!" && nnc === "[") {
                output += `${this._getIndent(options, indentLevel)}<`;
                location = Location.CData;
            }

            // exiting CData
            else if (location === Location.CData && cc === "]" && nc === "]" && nnc === ">") {
                output += "]]>";

                i += 2;
                lastNonTextLocation = location;
                location = Location.Text;
            }

            // entering Comment
            else if (location === Location.Text && cc === "<" && nc === "!" && nnc === "-") {
                output += `${this._getIndent(options, indentLevel)}<`;
                location = Location.Comment;
            }

            // exiting Comment
            else if (location === Location.Comment && cc === "-" && nc === "-" && nnc === ">") {
                output += "-->";

                i += 2;
                lastNonTextLocation = location;
                location = Location.Text;
            }

            // entering SpecialTag
            else if (location === Location.Text && cc === "<" && (nc === "!" || nc === "?")) {
                output += `${this._getIndent(options, indentLevel)}<`;
                location = Location.SpecialTag;
            }

            // exiting SpecialTag
            else if (location === Location.SpecialTag && cc === ">") {
                output += `>`;
                lastNonTextLocation = location;
                location = Location.Text;
            }

            // entering StartTag.StartTagName
            else if (location === Location.Text && cc === "<" && ["/", "!"].indexOf(nc) === -1) {
                // if this occurs after another tag, prepend a line break
                // but do not add one if the previous tag was self-closing (it already adds its own)
                if (pc === ">" && ppc !== "/") {
                    output += `${options.newLine}${this._getIndent(options, indentLevel)}<`;
                }

                else {
                    output += `${this._getIndent(options, indentLevel)}<`;
                }

                indentLevel++;
                location = Location.StartTagName;
            }

            // exiting StartTag.StartTagName, enter StartTag
            else if (location === Location.StartTagName && cc === " ") {
                output += " ";
                lastNonTextLocation = location;
                location = Location.StartTag;
            }

            // entering StartTag.Attribute
            else if (location === Location.StartTag && [" ", "/", ">"].indexOf(cc) === -1) {
                if (lastNonTextLocation === Location.AttributeValue
                    && ((options.splitXmlnsOnFormat
                        && xml.substr(i, 5).toLowerCase() === "xmlns")
                        || options.splitAttributesOnFormat)) {
                    output += `${options.newLine}${this._getIndent(options, indentLevel)}`;
                }

                output += cc;
                lastNonTextLocation = location;
                location = Location.Attribute;
            }

            // entering StartTag.Attribute.AttributeValue
            else if (location === Location.Attribute && (cc === "\"" || cc === "'")) {
                output += cc;
                lastNonTextLocation = location;
                location = Location.AttributeValue;
            }

            // exiting StartTag.Attribute.AttributeValue, entering StartTag
            else if (location === Location.AttributeValue && (cc === "\"" || cc === "'")) {
                output += cc;
                lastNonTextLocation = location;
                location = Location.StartTag;
            }

            // exiting StartTag or StartTag.StartTagName, entering Text
            else if ((location === Location.StartTag || location === Location.StartTagName) && cc === ">") {
                // if this was a self-closing tag, we need to decrement the indent level and add a newLine
                if (pc === "/") {
                    indentLevel--;
                    output += ">";

                    // only add a newline here if one doesn't already exist (issue #147)
                    if (nc !== "\r" && nc !== "\n") {
                        output += options.newLine;
                    }
                }

                else {
                    output += ">";
                }

                lastNonTextLocation = location;
                location = Location.Text;
            }

            // entering EndTag
            else if (location === Location.Text && cc === "<" && nc === "/") {
                indentLevel--;

                // if the end tag immediately follows a line break, just add an indentation
                // if the end tag immediately follows another end tag, add a line break and indent
                // otherwise, this should be treated as a same-line end tag(ex. <element>text</element>)
                if (pc === "\n") {
                    output += `${this._getIndent(options, indentLevel)}<`;
                }

                else if (lastNonTextLocation === Location.EndTag) {
                    output += `${options.newLine}${this._getIndent(options, indentLevel)}<`;
                }

                else {
                    output += "<";
                }

                location = Location.EndTag;
            }

            // exiting EndTag, entering Text
            else if (location === Location.EndTag && cc === ">") {
                output += ">";
                lastNonTextLocation = location;
                location = Location.Text;
            }

            // Text
            else {
                output += cc;
            }
        }

        return output;
    }

    minifyXml(xml: string, options: XmlFormattingOptions): string {
        return new ClassicXmlFormatter().minifyXml(xml, options);
    }

    private _getIndent(options: XmlFormattingOptions, indentLevel: number): string {
        return ((options.editorOptions.insertSpaces) ? " ".repeat(options.editorOptions.tabSize) : "\t").repeat(indentLevel);
    }

    private _sanitizeComments(xml: string): string {
        let output = "";
        let inComment = false;

        for (let i = 0; i < xml.length; i++) {
            const cc = xml[i];
            const nc = xml.charAt(i + 1);
            const nnc = xml.charAt(i + 2);
            const pc = xml.charAt(i - 1);

            if (!inComment && cc === "<" && nc === "!" && nnc === "-") {
                inComment = true;
                output += "<!--";

                i += 3;
            }

            else if (inComment && cc === "<") {
                output += MagicalStringOfWonders;
            }

            else if (inComment && cc === "-" && nc === "-" && nnc === ">") {
                inComment = false;
                output += "-->";

                i += 2;
            }

            else {
                output += cc;
            }
        }

        return output;
    }

    private _unsanitizeComments(xml: string): string {
        return xml.replace(new RegExp(MagicalStringOfWonders, "g"), "<");
    }
}

enum Location {
    Attribute,
    AttributeValue,
    CData,
    Comment,
    EndTag,
    SpecialTag,
    StartTag,
    StartTagName,
    Text
}