# all files / lighthouse-core/formatters/ formatter.js

100% Statements 19/19
100% Branches 8/8
100% Functions 7/7
100% Lines 19/19

    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

    5×

    17×
    1×

    17×
    1×

    17×

    2×

    1×
    1×

    5×
    5×
    5×

    43×
    1×

    43×
    1×

    42×

    1×

    1×
     /**
     * @license
     * Copyright 2016 Google Inc. All rights reserved.
     *
     * Licensed under the Apache License, Version 2.0 (the "License");
     * you may not use this file except in compliance with the License.
     * You may obtain a copy of the License at
     *
     *     http://www.apache.org/licenses/LICENSE-2.0
     *
     * Unless required by applicable law or agreed to in writing, software
     * distributed under the License is distributed on an "AS IS" BASIS,
     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     * See the License for the specific language governing permissions and
     * limitations under the License.
     */

    'use strict';

    class Formatter {

      static get CAPITAL_LETTERS() {
        return /([A-Z])/g;
      }

      static get SUPPORTED_FORMATS() {
        // Get the available formatters if they don't already exist.
        if (!this._formatters) {
          this._getFormatters();
        }

        // From the formatters we can establish a master list of supported format names.
        if (!this._supportedFormatsNames) {
          this._generateSupportedFormats();
        }

        return this._supportedFormatsNames;
      }

      static _getFormatters() {
        this._formatters = {
          accessibility: require('./accessibility'),
          criticalRequestChains: require('./critical-request-chains'),
          null: require('./null-formatter'),
          speedline: require('./speedline-formatter'),
          userTimings: require('./user-timings')
        };
      }

      static _generateSupportedFormats() {
        const formatNames = Object.keys(this._formatters);
        this._supportedFormatsNames = formatNames.reduce((prev, format) => {
          // Reformulates names like criticalNetworkChains to CRITICAL_NETWORK_CHAINS so they appear
          // like a bunch of constants.
          const formatName = format.replace(Formatter.CAPITAL_LETTERS, '_$1').toUpperCase();
          prev[formatName] = format;
          return prev;
        }, {});
      }

      static getByName(name) {
        if (!this._formatters) {
          this._getFormatters();
        }

        if (!this._formatters[name]) {
          throw new Error(`Unknown formatter: ${name}`);
        }

        return this._formatters[name];
      }

      static getFormatter() {
        throw new Error('Formatter must implement getPrettyFormatter()');
      }

      /**
       * Optional function to get any Handlebars helpers this formatter expects to need.
       */
      static getHelpers() {}
    }

    module.exports = Formatter;