Merge pull request #1377 from yuvipanda/eslint

Lint our JS with a generous eslint

Author: consideRatio

.eslintrc.js

@@ -0,0 +1,13 @@
+module.exports = {
+    "env": {
+        "browser": true,
+        "jquery": true,
+        "es6": true
+    },
+    "extends": "eslint:recommended",
+    "parserOptions": {
+        "sourceType": "module"
+    },
+    "rules": {
+    }
+};

.github/workflows/eslint.yml

@@ -0,0 +1,18 @@
+# Lints the binderhub/static/js folders content with eslint, influenced by
+# ".eslintrc.js", by running "npm run lint".
+name: eslint
+
+on:
+  pull_request:
+  push:
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Install modules
+      run: npm i
+    - name: Run ESLint on binderhub JS
+      run: npm run lint

CONTRIBUTING.md

@@ -97,6 +97,9 @@ user interface of those parts as BinderHub is configured to fake those actions.
 You can tell you are using the fake builder and launcher from the fact that the
 build will never complete.
 
+We use [eslint](https://eslint.org/) to catch errors in our JS, and you can
+run it locally with `npm run lint`.
+
 To learn how to set yourself with a BinderHub development environment that lets
 you modify the builder and launcher refer to [Develop Kubernetes
 integration](#develop-kubernetes-integration) or [Develop Helm

binderhub/static/js/index.js

@@ -138,7 +138,7 @@ function updateUrls(formValues) {
     $('#markdown-badge-snippet').text(markdownBadge(url));
     $('#rst-badge-snippet').text(rstBadge(url));
   } else {
-    ['#basic-url-snippet', '#markdown-badge-snippet', '#rst-badge-snippet' ].map(function(item, ind){
+    ['#basic-url-snippet', '#markdown-badge-snippet', '#rst-badge-snippet' ].map(function(item){
       const el = $(item);
       el.text(el.attr('data-default'));
     })
@@ -170,20 +170,20 @@ function build(providerSpec, log, fitAddon, path, pathType) {
     }
   });
 
-  image.onStateChange('waiting', function(oldState, newState, data) {
+  image.onStateChange('waiting', function() {
     $('#phase-waiting').removeClass('hidden');
   });
 
-  image.onStateChange('building', function(oldState, newState, data) {
+  image.onStateChange('building', function() {
     $('#phase-building').removeClass('hidden');
     log.show();
   });
 
-  image.onStateChange('pushing', function(oldState, newState, data) {
+  image.onStateChange('pushing', function() {
     $('#phase-pushing').removeClass('hidden');
   });
 
-  image.onStateChange('failed', function(oldState, newState, data) {
+  image.onStateChange('failed', function() {
     $('#build-progress .progress-bar').addClass('hidden');
     $('#phase-failed').removeClass('hidden');
 
@@ -199,7 +199,7 @@ function build(providerSpec, log, fitAddon, path, pathType) {
     image.close();
   });
 
-  image.onStateChange('built', function(oldState, newState, data) {
+  image.onStateChange('built', function(oldState) {
     if (oldState === null) {
       $('#phase-already-built').removeClass('hidden');
       $('#phase-launching').removeClass('hidden');
@@ -296,11 +296,11 @@ function indexMain() {
     updatePathText();
     updateRepoText();
 
-    $('#repository').on('keyup paste change', function(event) {updateUrls();});
+    $('#repository').on('keyup paste change', function() {updateUrls();});
 
-    $('#ref').on('keyup paste change', function(event) {updateUrls();});
+    $('#ref').on('keyup paste change', function() {updateUrls();});
 
-    $('#filepath').on('keyup paste change', function(event) {updateUrls();});
+    $('#filepath').on('keyup paste change', function() {updateUrls();});
 
     $('#toggle-badge-snippet').on('click', function() {
         const badgeSnippets = $('#badge-snippets');

package.json

@@ -4,21 +4,23 @@
   "description": "`BinderHub`",
   "devDependencies": {
     "css-loader": "^6.2.0",
+    "eslint": "^7.32.0",
     "mini-css-extract-plugin": "^2.3.0",
     "webpack": "^5.52.1",
     "webpack-cli": "^4.8.0"
   },
   "dependencies": {
-    "event-source-polyfill": "^1.0.25",
     "bootstrap": "^3.4.0",
     "clipboard": "^2.0.8",
     "jquery": "^3.6.0",
+    "event-source-polyfill": "^1.0.25",
     "xterm": "^4.14.1",
     "xterm-addon-fit": "^0.5.0"
   },
   "scripts": {
     "webpack": "webpack",
-    "webpack:watch": "webpack --watch"
+    "webpack:watch": "webpack --watch",
+    "lint": "eslint binderhub/static/js"
   },
   "repository": {
     "type": "git",