Skip to content

Commit 3a67d11

Browse files
davidfischerdavidfischer
committed
Merge branch 'master' into use-sustainability-api
2 parents 5d1d8f0 + e923c0c commit 3a67d11

File tree

22 files changed

+329
-283
lines changed

22 files changed

+329
-283
lines changed

‎.eslintrc

+9-9
Original file line numberDiff line numberDiff line change
@@ -4,32 +4,32 @@
44
"$": true
55
},
66
"rules": {
7-
"array-callback-return": "off",
7+
"array-callback-return": "warn",
88
"brace-style": "off",
99
"camelcase": "off",
1010
"comma-dangle": "off",
1111
"consistent-return": "off",
1212
"dot-notation": "off",
13-
"eqeqeq": "off",
13+
"eqeqeq": "error",
1414
"func-names": "off",
15-
"guard-for-in": "off",
15+
"guard-for-in": "warn",
1616
"indent": "off",
1717
"keyword-spacing": "off",
1818
"no-console": "off",
19-
"no-inner-declarations": "off",
20-
"no-loop-func": "off",
21-
"no-mixed-operators": "off",
19+
"no-inner-declarations": "warn",
20+
"no-loop-func": "warn",
21+
"no-mixed-operators": "warn",
2222
"no-multi-assign": "off",
2323
"no-param-reassign": "off",
2424
"no-redeclare": "off",
2525
"no-restricted-syntax": "off",
2626
"no-shadow": "off",
27-
"no-undef": "off",
27+
"no-undef": "warn",
2828
"no-underscore-dangle": "off",
2929
"no-unused-vars": "off",
30-
"no-use-before-define": "off",
30+
"no-use-before-define": "error",
3131
"object-curly-spacing": "off",
32-
"one-var": "off",
32+
"one-var": "error",
3333
"padded-blocks": "off",
3434
"quote-props": "off",
3535
"quotes": "off",

‎readthedocs/builds/static-src/builds/js/detail.js

+13-11
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Build detail view
22

3-
var ko = require('knockout'),
4-
$ = require('jquery');
3+
var ko = require('knockout');
4+
var $ = require('jquery');
55

66

77
function BuildCommand (data) {
@@ -10,7 +10,7 @@ function BuildCommand (data) {
1010
self.command = ko.observable(data.command);
1111
self.output = ko.observable(data.output);
1212
self.exit_code = ko.observable(data.exit_code || 0);
13-
self.successful = ko.observable(self.exit_code() == 0);
13+
self.successful = ko.observable(self.exit_code() === 0);
1414
self.run_time = ko.observable(data.run_time);
1515
self.is_showing = ko.observable(!self.successful());
1616

@@ -26,23 +26,24 @@ function BuildCommand (data) {
2626
}
2727

2828
function BuildDetailView (instance) {
29-
var self = this,
30-
instance = instance || {};
29+
var self = this;
30+
var instance = instance || {};
3131

3232
/* Instance variables */
3333
self.state = ko.observable(instance.state);
3434
self.state_display = ko.observable(instance.state_display);
3535
self.finished = ko.computed(function () {
36-
return self.state() == 'finished';
36+
return self.state() === 'finished';
3737
});
3838
self.date = ko.observable(instance.date);
3939
self.success = ko.observable(instance.success);
4040
self.error = ko.observable(instance.error);
4141
self.length = ko.observable(instance.length);
4242
self.commands = ko.observableArray(instance.commands);
4343
self.display_commands = ko.computed(function () {
44-
var commands_display = [],
45-
commands_raw = self.commands();
44+
var commands_display = [];
45+
var commands_raw = self.commands();
46+
var n;
4647
for (n in commands_raw) {
4748
var command = new BuildCommand(commands_raw[n]);
4849
commands_display.push(command)
@@ -69,12 +70,13 @@ function BuildDetailView (instance) {
6970
self.error(data.error);
7071
self.length(data.length);
7172
self.commit(data.commit);
73+
var n;
7274
for (n in data.commands) {
7375
var command = data.commands[n];
7476
var match = ko.utils.arrayFirst(
7577
self.commands(),
7678
function(command_cmp) {
77-
return (command_cmp.id == command.id);
79+
return (command_cmp.id === command.id);
7880
}
7981
);
8082
if (!match) {
@@ -90,8 +92,8 @@ function BuildDetailView (instance) {
9092
}
9193

9294
BuildDetailView.init = function (instance, domobj) {
93-
var view = new BuildDetailView(instance),
94-
domobj = domobj || $('#build-detail')[0];
95+
var view = new BuildDetailView(instance);
96+
var domobj = domobj || $('#build-detail')[0];
9597
ko.applyBindings(view, domobj);
9698
return view;
9799
};

‎readthedocs/core/static-src/core/js/autocomplete.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
var $ = require('jquery'),
2-
jqueryui = require('jquery-ui');
1+
var $ = require('jquery');
2+
var jqueryui = require('jquery-ui');
33

44
module.exports = function (selector, url) {
55
$(selector).autocomplete({
66
source: url,
77
minLength: 2,
88
open: function(event, ui) {
9-
ac_top = $('.ui-autocomplete').css('top');
9+
var ac_top = $('.ui-autocomplete').css('top');
1010
$('.ui-autocomplete').css({'width': '233px', 'top': ac_top + 10 });
1111
}
1212
});

‎readthedocs/core/static-src/core/js/doc-embed/footer.js

+36-38
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,41 @@
1-
var rtddata = require('./rtd-data'),
2-
versionCompare = require('./version-compare');
1+
var rtddata = require('./rtd-data');
2+
var versionCompare = require('./version-compare');
33

44

5+
function injectFooter(data) {
6+
var config = rtddata.get();
7+
8+
// If the theme looks like ours, update the existing badge
9+
// otherwise throw a a full one into the page.
10+
if (config.is_rtd_theme()) {
11+
$("div.rst-other-versions").html(data['html']);
12+
} else {
13+
$("body").append(data['html']);
14+
}
15+
16+
if (!data['version_active']) {
17+
$('.rst-current-version').addClass('rst-out-of-date');
18+
} else if (!data['version_supported']) {
19+
//$('.rst-current-version').addClass('rst-active-old-version')
20+
}
21+
}
22+
23+
24+
function setupBookmarkCSRFToken() {
25+
function csrfSafeMethod(method) {
26+
// these HTTP methods do not require CSRF protection
27+
return (/^(GET|HEAD|OPTIONS|TRACE)$/.test(method));
28+
}
29+
30+
$.ajaxSetup({
31+
beforeSend: function(xhr, settings) {
32+
if (!csrfSafeMethod(settings.type)) {
33+
xhr.setRequestHeader("X-CSRFToken", $('a.bookmark[token]').attr('token'));
34+
}
35+
}
36+
});
37+
}
38+
539
function init() {
640
var rtd = rtddata.get();
741

@@ -47,42 +81,6 @@ function init() {
4781
});
4882
}
4983

50-
51-
function injectFooter(data) {
52-
var config = rtddata.get();
53-
54-
// If the theme looks like ours, update the existing badge
55-
// otherwise throw a a full one into the page.
56-
if (config.is_rtd_theme()) {
57-
$("div.rst-other-versions").html(data['html']);
58-
} else {
59-
$("body").append(data['html']);
60-
}
61-
62-
if (!data['version_active']) {
63-
$('.rst-current-version').addClass('rst-out-of-date');
64-
} else if (!data['version_supported']) {
65-
//$('.rst-current-version').addClass('rst-active-old-version')
66-
}
67-
}
68-
69-
70-
function setupBookmarkCSRFToken() {
71-
function csrfSafeMethod(method) {
72-
// these HTTP methods do not require CSRF protection
73-
return (/^(GET|HEAD|OPTIONS|TRACE)$/.test(method));
74-
}
75-
76-
$.ajaxSetup({
77-
beforeSend: function(xhr, settings) {
78-
if (!csrfSafeMethod(settings.type)) {
79-
xhr.setRequestHeader("X-CSRFToken", $('a.bookmark[token]').attr('token'));
80-
}
81-
}
82-
});
83-
}
84-
85-
8684
module.exports = {
8785
init: init
8886
};

‎readthedocs/core/static-src/core/js/doc-embed/mkdocs.js

+5-5
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ function init() {
1010
var rtd = rtddata.get();
1111

1212
// Override MkDocs styles
13-
if ("builder" in rtd && rtd["builder"] == "mkdocs") {
13+
if ("builder" in rtd && rtd["builder"] === "mkdocs") {
1414
$('<input>').attr({
1515
type: 'hidden',
1616
name: 'project',
@@ -30,10 +30,10 @@ function init() {
3030
$("#rtd-search-form").prop("action", rtd.api_host + "/search/");
3131

3232
// Apply stickynav to mkdocs builds
33-
var nav_bar = $('nav.wy-nav-side:first'),
34-
win = $(window),
35-
sticky_nav_class = 'stickynav',
36-
apply_stickynav = function () {
33+
var nav_bar = $('nav.wy-nav-side:first');
34+
var win = $(window);
35+
var sticky_nav_class = 'stickynav';
36+
var apply_stickynav = function () {
3737
if (nav_bar.height() <= win.height()) {
3838
nav_bar.addClass(sticky_nav_class);
3939
} else {

‎readthedocs/core/static-src/core/js/doc-embed/rtd-data.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ var configMethods = {
1616
},
1717

1818
is_sphinx_builder: function () {
19-
return (!('builder' in this) || this.builder != 'mkdocs');
19+
return (!('builder' in this) || this.builder !== 'mkdocs');
2020
},
2121

2222
get_theme_name: function () {

‎readthedocs/core/static-src/core/js/doc-embed/search.js

+24-24
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,8 @@
22
* Sphinx search overrides
33
*/
44

5-
var rtddata = require('./rtd-data'),
6-
xss = require('xss/lib/index');
7-
8-
9-
function init() {
10-
var data = rtddata.get();
11-
attach_elastic_search_query(data);
12-
}
5+
var rtddata = require('./rtd-data');
6+
var xss = require('xss/lib/index');
137

148

159
/*
@@ -18,14 +12,14 @@ function init() {
1812
* failure,
1913
*/
2014
function attach_elastic_search_query(data) {
21-
var project = data.project,
22-
version = data.version,
23-
language = data.language || 'en',
24-
api_host = data.api_host;
15+
var project = data.project;
16+
var version = data.version;
17+
var language = data.language || 'en';
18+
var api_host = data.api_host;
2519

2620
var query_override = function (query) {
27-
var search_def = $.Deferred(),
28-
search_url = document.createElement('a');
21+
var search_def = $.Deferred();
22+
var search_url = document.createElement('a');
2923

3024
search_url.href = api_host;
3125
search_url.pathname = '/api/v2/docsearch/';
@@ -34,16 +28,16 @@ function attach_elastic_search_query(data) {
3428

3529
search_def
3630
.then(function (results) {
37-
var hits = results.hits || {},
38-
hit_list = hits.hits || [];
31+
var hits = results.hits || {};
32+
var hit_list = hits.hits || [];
3933

4034
if (hit_list.length) {
4135
for (var n in hit_list) {
42-
var hit = hit_list[n],
43-
fields = hit.fields || {},
44-
list_item = $('<li style="display: none;"></li>'),
45-
item_url = document.createElement('a'),
46-
highlight = hit.highlight;
36+
var hit = hit_list[n];
37+
var fields = hit.fields || {};
38+
var list_item = $('<li style="display: none;"></li>');
39+
var item_url = document.createElement('a');
40+
var highlight = hit.highlight;
4741

4842
item_url.href += fields.link +
4943
DOCUMENTATION_OPTIONS.FILE_SUFFIX;
@@ -55,7 +49,7 @@ function attach_elastic_search_query(data) {
5549
.attr('href', item_url)
5650
.html(fields.title)
5751
);
58-
if (fields.project != project) {
52+
if (fields.project !== project) {
5953
list_item.append(
6054
$('<span>')
6155
.text(" (from project " + fields.project + ")")
@@ -101,8 +95,8 @@ function attach_elastic_search_query(data) {
10195
withCredentials: true,
10296
},
10397
complete: function(resp, status_code) {
104-
if (typeof(resp.responseJSON) == 'undefined' ||
105-
typeof(resp.responseJSON.results) == 'undefined') {
98+
if (typeof(resp.responseJSON) === 'undefined' ||
99+
typeof(resp.responseJSON.results) === 'undefined') {
106100
return search_def.reject();
107101
}
108102
return search_def.resolve(resp.responseJSON.results);
@@ -125,6 +119,12 @@ function attach_elastic_search_query(data) {
125119
});
126120
}
127121

122+
123+
function init() {
124+
var data = rtddata.get();
125+
attach_elastic_search_query(data);
126+
}
127+
128128
module.exports = {
129129
init: init
130130
};

‎readthedocs/core/static-src/core/js/doc-embed/sphinx.js

+5-5
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
*/
44

55

6-
var rtddata = require('./rtd-data'),
7-
sphinx_theme = require('sphinx-rtd-theme');
6+
var rtddata = require('./rtd-data');
7+
var sphinx_theme = require('sphinx-rtd-theme');
88

99

1010
function init() {
@@ -27,7 +27,7 @@ function init() {
2727
});
2828

2929
/// Read the Docs Sphinx theme code
30-
if (!("builder" in rtd) || "builder" in rtd && rtd["builder"] != "mkdocs") {
30+
if (!("builder" in rtd) || "builder" in rtd && rtd["builder"] !== "mkdocs") {
3131
var theme = sphinx_theme.ThemeNav;
3232

3333
// TODO dont do this, the theme should explicitly check when it has be
@@ -47,8 +47,8 @@ function init() {
4747
// dynamically.
4848
var navBar = jquery('div.wy-side-scroll:first');
4949
if (! navBar.length) {
50-
var navInner = jquery('nav.wy-nav-side:first'),
51-
navScroll = $('<div />')
50+
var navInner = jquery('nav.wy-nav-side:first');
51+
var navScroll = $('<div />')
5252
.addClass('wy-side-scroll');
5353

5454
navInner

0 commit comments

Comments
 (0)