Skip to content

Commit 7f7ea08

Browse files
tmcwtmcw
authored
style(prettier): Include declarations, bin, and default_theme in prettier scope (#747)
This ensures all our formatting everywhere is consistent
1 parent b595c8f commit 7f7ea08

File tree

8 files changed

+251
-180
lines changed

8 files changed

+251
-180
lines changed

‎bin/documentation.js

+11-9
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,14 @@
44

55
'use strict';
66

7-
var yargs = require('yargs'),
8-
commands = require('../lib/commands');
7+
var yargs = require('yargs'), commands = require('../lib/commands');
98

109
var argv = yargs
1110
.command(commands.serve)
1211
.command(commands.build)
1312
.command(commands.lint)
1413
.command(commands.readme)
15-
.fail(function (msg, error) {
14+
.fail(function(msg, error) {
1615
if (error) {
1716
throw error;
1817
} else {
@@ -21,10 +20,11 @@ var argv = yargs
2120
return yargs.exit(1);
2221
}
2322
})
24-
.version(function () {
23+
.version(function() {
2524
return require('../package').version;
2625
})
27-
.usage(`Usage:
26+
.usage(
27+
`Usage:
2828
2929
# generate markdown docs for index.js and files it references
3030
$0 build index.js -f md
@@ -46,13 +46,15 @@ var argv = yargs
4646
4747
# build docs for all values exported by index.js
4848
$0 build --document-exported index.js
49-
`)
49+
`
50+
)
5051
.recommendCommands()
51-
.help()
52-
.argv;
52+
.help().argv;
5353

5454
if (argv.private) {
55-
console.error('--private is deprecated, please use the --access (or -a) option instead');
55+
console.error(
56+
'--private is deprecated, please use the --access (or -a) option instead'
57+
);
5658
console.error('for example: -a public -a private -a protected -a undefined');
5759
}
5860

‎default_theme/assets/anchor.js

+44-43
Original file line numberDiff line numberDiff line change
@@ -6,31 +6,36 @@
66

77
function AnchorJS(options) {
88
'use strict';
9-
109
this.options = options || {};
1110

1211
this._applyRemainingDefaultOptions = function(opts) {
13-
this.options.icon = this.options.hasOwnProperty('icon') ? opts.icon : '\ue9cb'; // Accepts characters (and also URLs?), like '#', '¶', '❡', or '§'.
14-
this.options.visible = this.options.hasOwnProperty('visible') ? opts.visible : 'hover'; // Also accepts 'always'
15-
this.options.placement = this.options.hasOwnProperty('placement') ? opts.placement : 'right'; // Also accepts 'left'
12+
this.options.icon = this.options.hasOwnProperty('icon')
13+
? opts.icon
14+
: '\ue9cb'; // Accepts characters (and also URLs?), like '#', '¶', '❡', or '§'.
15+
this.options.visible = this.options.hasOwnProperty('visible')
16+
? opts.visible
17+
: 'hover'; // Also accepts 'always'
18+
this.options.placement = this.options.hasOwnProperty('placement')
19+
? opts.placement
20+
: 'right'; // Also accepts 'left'
1621
this.options.class = this.options.hasOwnProperty('class') ? opts.class : ''; // Accepts any class name.
1722
};
1823

1924
this._applyRemainingDefaultOptions(options);
2025

2126
this.add = function(selector) {
2227
var elements,
23-
elsWithIds,
24-
idList,
25-
elementID,
26-
i,
27-
roughText,
28-
tidyText,
29-
index,
30-
count,
31-
newTidyText,
32-
readableID,
33-
anchor;
28+
elsWithIds,
29+
idList,
30+
elementID,
31+
i,
32+
roughText,
33+
tidyText,
34+
index,
35+
count,
36+
newTidyText,
37+
readableID,
38+
anchor;
3439

3540
this._applyRemainingDefaultOptions(this.options);
3641

@@ -55,7 +60,6 @@ function AnchorJS(options) {
5560
});
5661

5762
for (i = 0; i < elements.length; i++) {
58-
5963
if (elements[i].hasAttribute('id')) {
6064
elementID = elements[i].getAttribute('id');
6165
} else {
@@ -65,12 +69,13 @@ function AnchorJS(options) {
6569
// spaces with hyphens, truncate to 32 characters, and make toLowerCase.
6670
//
6771
// Example string: // '⚡⚡⚡ Unicode icons are cool--but they definitely don't belong in a URL fragment.'
68-
tidyText = roughText.replace(/[^\w\s-]/gi, '') // ' Unicode icons are cool--but they definitely dont belong in a URL fragment'
69-
.replace(/\s+/g, '-') // '-Unicode-icons-are-cool--but-they-definitely-dont-belong-in-a-URL-fragment'
70-
.replace(/-{2,}/g, '-') // '-Unicode-icons-are-cool-but-they-definitely-dont-belong-in-a-URL-fragment'
71-
.substring(0, 64) // '-Unicode-icons-are-cool-but-they-definitely-dont-belong-in-a-URL'
72-
.replace(/^-+|-+$/gm, '') // 'Unicode-icons-are-cool-but-they-definitely-dont-belong-in-a-URL'
73-
.toLowerCase(); // 'unicode-icons-are-cool-but-they-definitely-dont-belong-in-a-url'
72+
tidyText = roughText
73+
.replace(/[^\w\s-]/gi, '') // ' Unicode icons are cool--but they definitely dont belong in a URL fragment'
74+
.replace(/\s+/g, '-') // '-Unicode-icons-are-cool--but-they-definitely-dont-belong-in-a-URL-fragment'
75+
.replace(/-{2,}/g, '-') // '-Unicode-icons-are-cool-but-they-definitely-dont-belong-in-a-URL-fragment'
76+
.substring(0, 64) // '-Unicode-icons-are-cool-but-they-definitely-dont-belong-in-a-URL'
77+
.replace(/^-+|-+$/gm, '') // 'Unicode-icons-are-cool-but-they-definitely-dont-belong-in-a-URL'
78+
.toLowerCase(); // 'unicode-icons-are-cool-but-they-definitely-dont-belong-in-a-url'
7479

7580
// Compare our generated ID to existing IDs (and increment it if needed)
7681
// before we add it to the page.
@@ -121,7 +126,8 @@ function AnchorJS(options) {
121126
anchor.style.marginLeft = '-1em';
122127
anchor.style.paddingRight = '0.5em';
123128
elements[i].insertBefore(anchor, elements[i].firstChild);
124-
} else { // if the option provided is `right` (or anything else).
129+
} else {
130+
// if the option provided is `right` (or anything else).
125131
anchor.style.paddingLeft = '0.375em';
126132
elements[i].appendChild(anchor);
127133
}
@@ -131,8 +137,7 @@ function AnchorJS(options) {
131137
};
132138

133139
this.remove = function(selector) {
134-
var domAnchor,
135-
elements = document.querySelectorAll(selector);
140+
var domAnchor, elements = document.querySelectorAll(selector);
136141
for (var i = 0; i < elements.length; i++) {
137142
domAnchor = elements[i].querySelector('.anchorjs-link');
138143
if (domAnchor) {
@@ -149,30 +154,26 @@ function AnchorJS(options) {
149154
}
150155

151156
var style = document.createElement('style'),
152-
linkRule =
153-
' .anchorjs-link {' +
154-
' opacity: 0;' +
155-
' text-decoration: none;' +
157+
linkRule = ' .anchorjs-link {' +
158+
' opacity: 0;' +
159+
' text-decoration: none;' +
156160
' -webkit-font-smoothing: antialiased;' +
157-
' -moz-osx-font-smoothing: grayscale;' +
161+
' -moz-osx-font-smoothing: grayscale;' +
158162
' }',
159-
hoverRule =
160-
' *:hover > .anchorjs-link,' +
161-
' .anchorjs-link:focus {' +
162-
' opacity: 1;' +
163+
hoverRule = ' *:hover > .anchorjs-link,' +
164+
' .anchorjs-link:focus {' +
165+
' opacity: 1;' +
163166
' }',
164-
anchorjsLinkFontFace =
165-
' @font-face {' +
166-
' font-family: "anchorjs-icons";' +
167-
' font-style: normal;' +
168-
' font-weight: normal;' + // Icon from icomoon; 10px wide & 10px tall; 2 empty below & 4 above
167+
anchorjsLinkFontFace = ' @font-face {' +
168+
' font-family: "anchorjs-icons";' +
169+
' font-style: normal;' +
170+
' font-weight: normal;' + // Icon from icomoon; 10px wide & 10px tall; 2 empty below & 4 above
169171
' src: url(data:application/x-font-ttf;charset=utf-8;base64,AAEAAAALAIAAAwAwT1MvMg8SBTUAAAC8AAAAYGNtYXAWi9QdAAABHAAAAFRnYXNwAAAAEAAAAXAAAAAIZ2x5Zgq29TcAAAF4AAABNGhlYWQEZM3pAAACrAAAADZoaGVhBhUDxgAAAuQAAAAkaG10eASAADEAAAMIAAAAFGxvY2EAKACuAAADHAAAAAxtYXhwAAgAVwAAAygAAAAgbmFtZQ5yJ3cAAANIAAAB2nBvc3QAAwAAAAAFJAAAACAAAwJAAZAABQAAApkCzAAAAI8CmQLMAAAB6wAzAQkAAAAAAAAAAAAAAAAAAAABEAAAAAAAAAAAAAAAAAAAAABAAADpywPA/8AAQAPAAEAAAAABAAAAAAAAAAAAAAAgAAAAAAADAAAAAwAAABwAAQADAAAAHAADAAEAAAAcAAQAOAAAAAoACAACAAIAAQAg6cv//f//AAAAAAAg6cv//f//AAH/4xY5AAMAAQAAAAAAAAAAAAAAAQAB//8ADwABAAAAAAAAAAAAAgAANzkBAAAAAAEAAAAAAAAAAAACAAA3OQEAAAAAAQAAAAAAAAAAAAIAADc5AQAAAAACADEARAJTAsAAKwBUAAABIiYnJjQ/AT4BMzIWFxYUDwEGIicmND8BNjQnLgEjIgYPAQYUFxYUBw4BIwciJicmND8BNjIXFhQPAQYUFx4BMzI2PwE2NCcmNDc2MhcWFA8BDgEjARQGDAUtLXoWOR8fORYtLTgKGwoKCjgaGg0gEhIgDXoaGgkJBQwHdR85Fi0tOAobCgoKOBoaDSASEiANehoaCQkKGwotLXoWOR8BMwUFLYEuehYXFxYugC44CQkKGwo4GkoaDQ0NDXoaShoKGwoFBe8XFi6ALjgJCQobCjgaShoNDQ0NehpKGgobCgoKLYEuehYXAAEAAAABAACiToc1Xw889QALBAAAAAAA0XnFFgAAAADRecUWAAAAAAJTAsAAAAAIAAIAAAAAAAAAAQAAA8D/wAAABAAAAAAAAlMAAQAAAAAAAAAAAAAAAAAAAAUAAAAAAAAAAAAAAAACAAAAAoAAMQAAAAAACgAUAB4AmgABAAAABQBVAAIAAAAAAAIAAAAAAAAAAAAAAAAAAAAAAAAADgCuAAEAAAAAAAEADgAAAAEAAAAAAAIABwCfAAEAAAAAAAMADgBLAAEAAAAAAAQADgC0AAEAAAAAAAUACwAqAAEAAAAAAAYADgB1AAEAAAAAAAoAGgDeAAMAAQQJAAEAHAAOAAMAAQQJAAIADgCmAAMAAQQJAAMAHABZAAMAAQQJAAQAHADCAAMAAQQJAAUAFgA1AAMAAQQJAAYAHACDAAMAAQQJAAoANAD4YW5jaG9yanMtaWNvbnMAYQBuAGMAaABvAHIAagBzAC0AaQBjAG8AbgBzVmVyc2lvbiAxLjAAVgBlAHIAcwBpAG8AbgAgADEALgAwYW5jaG9yanMtaWNvbnMAYQBuAGMAaABvAHIAagBzAC0AaQBjAG8AbgBzYW5jaG9yanMtaWNvbnMAYQBuAGMAaABvAHIAagBzAC0AaQBjAG8AbgBzUmVndWxhcgBSAGUAZwB1AGwAYQByYW5jaG9yanMtaWNvbnMAYQBuAGMAaABvAHIAagBzAC0AaQBjAG8AbgBzRm9udCBnZW5lcmF0ZWQgYnkgSWNvTW9vbi4ARgBvAG4AdAAgAGcAZQBuAGUAcgBhAHQAZQBkACAAYgB5ACAASQBjAG8ATQBvAG8AbgAuAAAAAwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA==) format("truetype");' +
170172
' }',
171-
pseudoElContent =
172-
' [data-anchorjs-icon]::after {' +
173-
' content: attr(data-anchorjs-icon);' +
173+
pseudoElContent = ' [data-anchorjs-icon]::after {' +
174+
' content: attr(data-anchorjs-icon);' +
174175
' }',
175-
firstStyleEl;
176+
firstStyleEl;
176177

177178
style.className = 'anchorjs';
178179
style.appendChild(document.createTextNode('')); // Necessary for Webkit.

‎default_theme/assets/site.js

+40-38
Original file line numberDiff line numberDiff line change
@@ -5,56 +5,55 @@ anchors.options.placement = 'left';
55
anchors.add('h3');
66

77
// Filter UI
8-
var tocElements = document.getElementById('toc')
9-
.getElementsByTagName('li');
10-
11-
document.getElementById('filter-input')
12-
.addEventListener('keyup', function (e) {
13-
14-
var i, element, children;
15-
16-
// enter key
17-
if (e.keyCode === 13) {
18-
// go to the first displayed item in the toc
19-
for (i = 0; i < tocElements.length; i++) {
20-
element = tocElements[i];
21-
if (!element.classList.contains('display-none')) {
22-
location.replace(element.firstChild.href);
23-
return e.preventDefault();
24-
}
8+
var tocElements = document.getElementById('toc').getElementsByTagName('li');
9+
10+
document.getElementById('filter-input').addEventListener('keyup', function(e) {
11+
var i, element, children;
12+
13+
// enter key
14+
if (e.keyCode === 13) {
15+
// go to the first displayed item in the toc
16+
for (i = 0; i < tocElements.length; i++) {
17+
element = tocElements[i];
18+
if (!element.classList.contains('display-none')) {
19+
location.replace(element.firstChild.href);
20+
return e.preventDefault();
2521
}
2622
}
23+
}
2724

28-
var match = function () {
29-
return true;
30-
};
25+
var match = function() {
26+
return true;
27+
};
3128

32-
var value = this.value.toLowerCase();
29+
var value = this.value.toLowerCase();
3330

34-
if (!value.match(/^\s*$/)) {
35-
match = function (element) {
36-
return element.firstChild.innerHTML.toLowerCase().indexOf(value) !== -1;
37-
};
38-
}
31+
if (!value.match(/^\s*$/)) {
32+
match = function(element) {
33+
return element.firstChild.innerHTML.toLowerCase().indexOf(value) !== -1;
34+
};
35+
}
3936

40-
for (i = 0; i < tocElements.length; i++) {
41-
element = tocElements[i];
42-
children = Array.from(element.getElementsByTagName('li'));
43-
if (match(element) || children.some(match)) {
44-
element.classList.remove('display-none');
45-
} else {
46-
element.classList.add('display-none');
47-
}
37+
for (i = 0; i < tocElements.length; i++) {
38+
element = tocElements[i];
39+
children = Array.from(element.getElementsByTagName('li'));
40+
if (match(element) || children.some(match)) {
41+
element.classList.remove('display-none');
42+
} else {
43+
element.classList.add('display-none');
4844
}
49-
});
45+
}
46+
});
5047

5148
var toggles = document.getElementsByClassName('toggle-step-sibling');
5249
for (var i = 0; i < toggles.length; i++) {
5350
toggles[i].addEventListener('click', toggleStepSibling);
5451
}
5552

5653
function toggleStepSibling() {
57-
var stepSibling = this.parentNode.parentNode.parentNode.getElementsByClassName('toggle-target')[0];
54+
var stepSibling = this.parentNode.parentNode.parentNode.getElementsByClassName(
55+
'toggle-target'
56+
)[0];
5857
var klass = 'display-none';
5958
if (stepSibling.classList.contains(klass)) {
6059
stepSibling.classList.remove(klass);
@@ -86,8 +85,11 @@ function toggleSibling() {
8685
function showHashTarget(targetId) {
8786
var hashTarget = document.getElementById(targetId);
8887
// new target is hidden
89-
if (hashTarget && hashTarget.offsetHeight === 0 &&
90-
hashTarget.parentNode.parentNode.classList.contains('display-none')) {
88+
if (
89+
hashTarget &&
90+
hashTarget.offsetHeight === 0 &&
91+
hashTarget.parentNode.parentNode.classList.contains('display-none')
92+
) {
9193
hashTarget.parentNode.parentNode.classList.remove('display-none');
9294
}
9395
}

0 commit comments

Comments
 (0)