react-type-snob
Version:
Encourages good typographic details in your React app
375 lines (374 loc) • 10.7 kB
HTML
<html lang="en">
<head>
<title>Code coverage report for index.js</title>
<meta charset="utf-8" />
<link rel="stylesheet" href="prettify.css" />
<link rel="stylesheet" href="base.css" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<style type='text/css'>
.coverage-summary .sorter {
background-image: url(sort-arrow-sprite.png);
}
</style>
</head>
<body>
<div class='wrapper'>
<div class='pad1'>
<h1>
<a href="index.html">All files</a> index.js
</h1>
<div class='clearfix'>
<div class='fl pad1y space-right2'>
<span class="strong">100% </span>
<span class="quiet">Statements</span>
<span class='fraction'>36/36</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">94.74% </span>
<span class="quiet">Branches</span>
<span class='fraction'>18/19</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">100% </span>
<span class="quiet">Functions</span>
<span class='fraction'>8/8</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">100% </span>
<span class="quiet">Lines</span>
<span class='fraction'>35/35</span>
</div>
</div>
</div>
<div class='status-line high'></div>
<pre><table class="coverage">
<tr><td class="line-count quiet">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
97
98
99
100
101
102
103
104</td><td class="line-coverage quiet"><span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">11x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">11x</span>
<span class="cline-any cline-yes">2x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">9x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">11x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">11x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">11x</span>
<span class="cline-any cline-yes">12x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">11x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">44x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">44x</span>
<span class="cline-any cline-yes">11x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">11x</span>
<span class="cline-any cline-yes">11x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">11x</span>
<span class="cline-any cline-yes">11x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">11x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">11x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">44x</span>
<span class="cline-any cline-yes">35x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">9x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">44x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">11x</span>
<span class="cline-any cline-yes">6x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">9x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">11x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">9x</span>
<span class="cline-any cline-yes">6x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">9x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">11x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span></td><td class="text"><pre class="prettyprint lang-js">import DocChomp from 'doc-chomp';
import getDisplayName from './get-display-name';
import consoleReporter from './console-reporter';
import verifyReact from './verify-react';
const SNOBBY_TESTS = [
{
name: 'ugly double quotes',
regexp: /"/g,
suggestion: '`“` or `”`'
},
{
name: 'ugly single quotes',
regexp: /'/g,
suggestion: '`‘` or `’`'
},
{
name: 'full-stops as ellipses',
regexp: /\.{2,}/g,
suggestion: '`…`'
},
{
name: 'space preceding ellipses',
regexp: /\s(?:\.{2,}|…)/g
}
];
const CONTEXT_LENGTH = 20;
export default function typeSnob(React, reporter = consoleReporter) {
verifyReact(React);
// keep original `createElement` method, as we intend to proxy it!
const createElement = React.createElement;
React.createElement = function typeSnobCreateElement(type, rawProps, ...rawChildren) {
const props = rawProps || {};
let children;
if (rawChildren.length === 0) {
children = props.children || [];
} else {
children = rawChildren;
}
// proxy out to the real `createElement` early so we don't try to test any invalid states!
const reactElement = createElement.call(this, type, rawProps, ...rawChildren);
let textContent = '';
React.Children.forEach(children, (child) => {
textContent += React.isValidElement(child) ? '[React Element]' : child;
});
const errors = SNOBBY_TESTS
.map((test) => {
const contexts = [];
textContent.replace(test.regexp, (match, ...args) => {
const fullText = args.pop();
const startOffset = args.pop();
const endOffset = startOffset + match.length;
const contextStartOffset = Math.max(startOffset - CONTEXT_LENGTH, 0);
const contextEndOffset = Math.min(endOffset + CONTEXT_LENGTH, fullText.length);
contexts.push(fullText.slice(contextStartOffset, contextEndOffset).replace(/\n/g, ' '));
// *do not* replace, as we may need to do further processing
return match;
});
if (contexts.length === 0) {
return;
}
return Object.assign({ contexts }, test);
})
.filter((returnedThing) => returnedThing);
if (errors.length > 0) {
reporter(DocChomp`
[React Type Snob] Problems detected in text content of \`${getDisplayName(type, rawProps)}\`${(reactElement._owner && reactElement._owner.getName) ? `. Please check the render method of \`${reactElement._owner.getName()}\`` : <span class="branch-1 cbranch-no" title="branch not covered" >''}</span>;
${errors.map(({ name, suggestion, contexts }) => {
let report = `* Found ${name};`;
contexts.forEach((context) => report += `\n * \`${context}\``);
if (suggestion) {
report += `\n Suggested replacements: ${suggestion}`;
}
return report;
}).join('\n\n')
}`
);
}
return reactElement;
};
}
</pre></td></tr>
</table></pre>
<div class='push'></div><!-- for sticky footer -->
</div><!-- /wrapper -->
<div class='footer quiet pad2 space-top1 center small'>
Code coverage
generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Mon Nov 14 2016 16:58:56 GMT+1100 (AEDT)
</div>
</div>
<script src="prettify.js"></script>
<script>
window.onload = function () {
if (typeof prettyPrint === 'function') {
prettyPrint();
}
};
</script>
<script src="sorter.js"></script>
</body>
</html>