# all files / src/audits/manifest/ short-name-length.js

100% Statements 13/13
100% Branches 7/7
100% Functions 2/2
100% Lines 13/13

    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

    1×

    16×

    4×
    4×
    4×
    4×

    4×

    2×
    2×
    1×
    1×

    4×

    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';

    const Audit = require('../audit');

    class ManifestShortNameLength extends Audit {
      /**
       * @override
       */
      static get meta() {
        return {
          category: 'Manifest',
          name: 'manifest-short-name-length',
          description: 'Manifest\'s short_name won\'t be truncated when displayed on homescreen',
          requiredArtifacts: ['manifest']
        };
      }

      /**
       * @param {!Artifacts} artifacts
       * @return {!AuditResult}
       */
      static audit(artifacts) {
        let isShortNameShortEnough = false;
        let debugString;
        const manifest = artifacts.manifest.value;
        const suggestedLength = 12;

        if (manifest && manifest.short_name && manifest.short_name.value) {
          // Historically, Chrome recommended 12 chars as the maximum length to prevent truncation.
          // See #69 for more discussion.
          isShortNameShortEnough = (manifest.short_name.value.length <= suggestedLength);
          if (!isShortNameShortEnough) {
            debugString = `${suggestedLength} chars is the suggested maximum homescreen label length`;
            debugString += ` (Found: ${manifest.short_name.value.length} chars).`;
          }
        }

        return ManifestShortNameLength.generateAuditResult({
          value: isShortNameShortEnough,
          debugString
        });
      }
    }

    module.exports = ManifestShortNameLength;