All files / istanbul-lib-report/src xml-writer.ts

100% Statements 25/25
100% Branches 8/8
100% Functions 10/10
100% Lines 24/24

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96            11x           450x 1101x                           16x 16x       3160x                 175x 175x 175x                 176x 1x   175x 175x   175x 1x   174x                   275x 275x 13x   262x   275x 275x             12x       23x            
/*
 Copyright 2012-2015, Yahoo Inc.
 Copyrights licensed under the New BSD License. See the accompanying LICENSE file for terms.
 */
import type { ContentWriter } from "./file-writer";
 
const INDENT = "  ";
 
/** attributes for an XML tag, keyed by attribute name */
export type XmlAttributes = Record<string, string | number>;
 
function attrString(attrs?: XmlAttributes): string {
  return Object.entries(attrs || {})
    .map(([k, v]) => ` ${k}="${v}"`)
    .join("");
}
 
/**
 * a utility class to produce well-formed, indented XML
 * @param {ContentWriter} contentWriter the content writer that this utility wraps
 * @constructor
 */
class XMLWriter {
  declare cw: ContentWriter;
  declare stack: string[];
 
  constructor(contentWriter: ContentWriter) {
    this.cw = contentWriter;
    this.stack = [];
  }
 
  indent(str: string): string {
    return this.stack.map(() => INDENT).join("") + str;
  }
 
  /**
   * writes the opening XML tag with the supplied attributes
   * @param {String} name tag name
   * @param {Object} [attrs=null] attrs attributes for the tag
   */
  openTag(name: string, attrs?: XmlAttributes): void {
    const str = this.indent(`<${name + attrString(attrs)}>`);
    this.cw.println(str);
    this.stack.push(name);
  }
 
  /**
   * closes an open XML tag.
   * @param {String} name - tag name to close. This must match the writer's
   *  notion of the tag that is currently open.
   */
  closeTag(name: string): void {
    if (this.stack.length === 0) {
      throw new Error(`Attempt to close tag ${name} when not opened`);
    }
    const stashed = this.stack.pop();
    const str = `</${name}>`;
 
    if (stashed !== name) {
      throw new Error(`Attempt to close tag ${name} when ${stashed} was the one open`);
    }
    this.cw.println(this.indent(str));
  }
 
  /**
   * writes a tag and its value opening and closing it at the same time
   * @param {String} name tag name
   * @param {Object} [attrs=null] attrs tag attributes
   * @param {String} [content=null] content optional tag content
   */
  inlineTag(name: string, attrs?: XmlAttributes, content?: string): void {
    let str = "<" + name + attrString(attrs);
    if (content) {
      str += `>${content}</${name}>`;
    } else {
      str += "/>";
    }
    str = this.indent(str);
    this.cw.println(str);
  }
 
  /**
   * closes all open tags and ends the document
   */
  closeAll(): void {
    this.stack
      .slice()
      .reverse()
      .forEach((name) => {
        this.closeTag(name);
      });
  }
}
 
export default XMLWriter;