/
no-document-write.js
71 lines (62 loc) · 2.07 KB
/
no-document-write.js
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
/**
* @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.
*/
/**
* @fileoverview Audit a page to see if it's using document.write()
*/
'use strict';
const Audit = require('../audit');
const Formatter = require('../../formatters/formatter');
class NoDocWriteAudit extends Audit {
/**
* @return {!AuditMeta}
*/
static get meta() {
return {
category: 'Performance',
name: 'no-document-write',
description: 'Site does not use document.write()',
helpText: 'Consider using <code><script async></code> to load scripts. <code>document.write()</code> is considered <a href="https://developers.google.com/web/updates/2016/08/removing-document-write" target="_blank">harmful for performance</a>.',
requiredArtifacts: ['URL', 'DocWriteUse']
};
}
/**
* @param {!Artifacts} artifacts
* @return {!AuditResult}
*/
static audit(artifacts) {
if (typeof artifacts.DocWriteUse === 'undefined' ||
artifacts.DocWriteUse === -1) {
return NoDocWriteAudit.generateAuditResult({
rawValue: -1,
debugString: 'DocWriteUse gatherer did not run'
});
}
const results = artifacts.DocWriteUse.usage.map(err => {
return Object.assign({
misc: `(line: ${err.line}, col: ${err.col})`
}, err);
});
return NoDocWriteAudit.generateAuditResult({
rawValue: results.length === 0,
extendedInfo: {
formatter: Formatter.SUPPORTED_FORMATS.URLLIST,
value: results
}
});
}
}
module.exports = NoDocWriteAudit;