STY: Add eslint and prettier config.

QuLogic · QuLogic · commit ba840a56b726 · 2020-04-04T00:23:37.000-04:00
These are setup similar to ipywidgets, but with slightly less newer
things, as our JavaScript parts are much older.
diff --git a/.gitignore b/.gitignore
@@ -104,3 +104,5 @@ lib/z.lib
 #########################
 
 jquery-ui-*/
+lib/matplotlib/backends/web_backend/node_modules/
+lib/matplotlib/backends/web_backend/package-lock.json
diff --git a/lib/matplotlib/backends/web_backend/.eslintrc.js b/lib/matplotlib/backends/web_backend/.eslintrc.js
@@ -0,0 +1,21 @@
+module.exports = {
+  root: true,
+  ignorePatterns: ["jquery-ui-*/", "node_modules/"],
+  env: {
+    browser: true,
+    jquery: true,
+  },
+  extends: ["eslint:recommended", "prettier"],
+  globals: {
+    IPython: "readonly",
+    MozWebSocket: "readonly",
+  },
+  rules: {
+    "no-unused-vars": [
+      "error",
+      {
+        argsIgnorePattern: "^_",
+      },
+    ],
+  },
+};
diff --git a/lib/matplotlib/backends/web_backend/.prettierignore b/lib/matplotlib/backends/web_backend/.prettierignore
@@ -0,0 +1,7 @@
+node_modules/
+
+# Vendored dependencies
+css/boilerplate.css
+css/fbm.css
+css/page.css
+jquery-ui-*/
diff --git a/lib/matplotlib/backends/web_backend/.prettierrc b/lib/matplotlib/backends/web_backend/.prettierrc
@@ -0,0 +1,11 @@
+{
+  "overrides": [
+    {
+      "files": "js/**/*.js",
+      "options": {
+        "singleQuote": true,
+        "tabWidth": 4,
+      }
+    }
+  ]
+}
diff --git a/lib/matplotlib/backends/web_backend/js/mpl.js b/lib/matplotlib/backends/web_backend/js/mpl.js
@@ -1,4 +1,5 @@
 /* Put everything inside the global mpl namespace */
+/* global mpl */
 window.mpl = {};
 
 
@@ -99,12 +100,12 @@ mpl.figure.prototype._init_header = function() {
 
 
 
-mpl.figure.prototype._canvas_extra_style = function(canvas_div) {
+mpl.figure.prototype._canvas_extra_style = function(_canvas_div) {
 
 }
 
 
-mpl.figure.prototype._root_extra_style = function(canvas_div) {
+mpl.figure.prototype._root_extra_style = function(_canvas_div) {
 
 }
 
@@ -147,13 +148,13 @@ mpl.figure.prototype._init_canvas = function() {
     var pass_mouse_events = true;
 
     canvas_div.resizable({
-        start: function(event, ui) {
+        start: function(_event, _ui) {
             pass_mouse_events = false;
         },
-        resize: function(event, ui) {
+        resize: function(_event, ui) {
             fig.request_resize(ui.size.width, ui.size.height);
         },
-        stop: function(event, ui) {
+        stop: function(_event, ui) {
             pass_mouse_events = true;
             fig.request_resize(ui.size.width, ui.size.height);
         },
@@ -210,7 +211,7 @@ mpl.figure.prototype._init_canvas = function() {
     this._resize_canvas(600, 600);
 
     // Disable right mouse context menu.
-    $(this.rubberband_canvas).bind("contextmenu",function(e){
+    $(this.rubberband_canvas).bind("contextmenu",function(_e){
         return false;
     });
 
@@ -316,7 +317,7 @@ mpl.figure.prototype.send_draw_message = function() {
 }
 
 
-mpl.figure.prototype.handle_save = function(fig, msg) {
+mpl.figure.prototype.handle_save = function(fig, _msg) {
     var format_dropdown = fig.format_dropdown;
     var format = format_dropdown.options[format_dropdown.selectedIndex].value;
     fig.ondownload(fig, format);
@@ -380,7 +381,7 @@ mpl.figure.prototype.handle_message = function(fig, msg) {
     fig.message.textContent = msg['message'];
 }
 
-mpl.figure.prototype.handle_draw = function(fig, msg) {
+mpl.figure.prototype.handle_draw = function(fig, _msg) {
     // Request the server to send over a new figure.
     fig.send_draw_message();
 }
@@ -506,7 +507,7 @@ mpl.figure.prototype.mouse_event = function(event, name) {
     return false;
 }
 
-mpl.figure.prototype._key_event_extra = function(event, name) {
+mpl.figure.prototype._key_event_extra = function(_event, _name) {
     // Handle any extra behaviour associated with a key event
 }
 
diff --git a/lib/matplotlib/backends/web_backend/js/mpl_tornado.js b/lib/matplotlib/backends/web_backend/js/mpl_tornado.js
@@ -2,6 +2,7 @@
    tornado-based server, that are not relevant when embedding WebAgg
    in another web application. */
 
+/* exported mpl_ondownload */
 function mpl_ondownload(figure, format) {
     window.open(figure.id + '/download.' + format, '_blank');
 }
diff --git a/lib/matplotlib/backends/web_backend/js/nbagg_mpl.js b/lib/matplotlib/backends/web_backend/js/nbagg_mpl.js
@@ -1,3 +1,5 @@
+/* global mpl */
+
 var comm_websocket_adapter = function(comm) {
     // Create a "websocket"-like object which calls the given IPython comm
     // object with the appropriate methods. Currently this is a non binary
@@ -30,7 +32,7 @@ mpl.mpl_figure_comm = function(comm, msg) {
     var element = $("#" + id);
     var ws_proxy = comm_websocket_adapter(comm)
 
-    function ondownload(figure, format) {
+    function ondownload(figure, _format) {
         window.open(figure.imageObj.src);
     }
 
@@ -48,10 +50,6 @@ mpl.mpl_figure_comm = function(comm, msg) {
         console.error("Failed to find cell for figure", id, fig);
         return;
     }
-
-    var output_index = fig.cell_info[2]
-    var cell = fig.cell_info[0];
-
 };
 
 mpl.figure.prototype.handle_close = function(fig, msg) {
@@ -73,7 +71,7 @@ mpl.figure.prototype.close_ws = function(fig, msg){
     // fig.ws.close()
 }
 
-mpl.figure.prototype.push_to_output = function(remove_interactive) {
+mpl.figure.prototype.push_to_output = function(_remove_interactive) {
     // Turn the data on the canvas into data in the output cell.
     var width = this.canvas.width/mpl.ratio
     var dataURL = this.canvas.toDataURL();
@@ -105,6 +103,7 @@ mpl.figure.prototype._init_toolbar = function() {
         return fig.toolbar_button_onmouseover(event['data']);
     }
 
+    var button;
     for(var toolbar_ind in mpl.toolbar_items){
         var name = mpl.toolbar_items[toolbar_ind][0];
         var tooltip = mpl.toolbar_items[toolbar_ind][1];
@@ -113,7 +112,7 @@ mpl.figure.prototype._init_toolbar = function() {
 
         if (!name) { continue; };
 
-        var button = $('<button class="btn btn-default" href="#" title="' + name + '"><i class="fa ' + image + ' fa-lg"></i></button>');
+        button = $('<button class="btn btn-default" href="#" title="' + name + '"><i class="fa ' + image + ' fa-lg"></i></button>');
         button.click(method_name, toolbar_event);
         button.mouseover(tooltip, toolbar_mouse_event);
         nav_element.append(button);
@@ -126,8 +125,8 @@ mpl.figure.prototype._init_toolbar = function() {
 
     // Add the close button to the window.
     var buttongrp = $('<div class="btn-group inline pull-right"></div>');
-    var button = $('<button class="btn btn-mini btn-primary" href="#" title="Stop Interaction"><i class="fa fa-power-off icon-remove icon-large"></i></button>');
-    button.click(function (evt) { fig.handle_close(fig, {}); } );
+    button = $('<button class="btn btn-mini btn-primary" href="#" title="Stop Interaction"><i class="fa fa-power-off icon-remove icon-large"></i></button>');
+    button.click(function (_evt) { fig.handle_close(fig, {}); } );
     button.mouseover('Stop Interaction', toolbar_mouse_event);
     buttongrp.append(button);
     var titlebar = this.root.find($('.ui-dialog-titlebar'));
@@ -158,7 +157,7 @@ mpl.figure.prototype._canvas_extra_style = function(el){
 
 }
 
-mpl.figure.prototype._key_event_extra = function(event, name) {
+mpl.figure.prototype._key_event_extra = function(event, _name) {
     var manager = IPython.notebook.keyboard_manager;
     if (!manager)
         manager = IPython.keyboard_manager;
@@ -172,7 +171,7 @@ mpl.figure.prototype._key_event_extra = function(event, name) {
     }
 }
 
-mpl.figure.prototype.handle_save = function(fig, msg) {
+mpl.figure.prototype.handle_save = function(fig, _msg) {
     fig.ondownload(fig, null);
 }
 
diff --git a/lib/matplotlib/backends/web_backend/package.json b/lib/matplotlib/backends/web_backend/package.json
@@ -0,0 +1,15 @@
+{
+  "devDependencies": {
+    "eslint": "^6.8.0",
+    "eslint-config-prettier": "^6.10.1",
+    "prettier": "^2.0.2"
+  },
+  "scripts": {
+    "eslint": "eslint . --fix",
+    "eslint:check": "eslint .",
+    "lint": "npm run prettier && npm run eslint",
+    "lint:check": "npm run prettier:check && npm run eslint:check",
+    "prettier": "prettier --write \"**/*{.ts,.tsx,.js,.jsx,.css,.json}\"",
+    "prettier:check": "prettier --check \"**/*{.ts,.tsx,.js,.jsx,.css,.json}\""
+  }
+}

Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`	`tornado-based server, that are not relevant when embedding WebAgg`
`3`	`3`	`in another web application. */`
`4`	`4`
	`5`	`+/* exported mpl_ondownload */`
`5`	`6`	`function mpl_ondownload(figure, format) {`
`6`	`7`	`window.open(figure.id + '/download.' + format, '_blank');`
`7`	`8`	`}`