Add eslint checks to all Oscar JS to the travis build.

.eslintrc.json

@@ -0,0 +1,21 @@
+{
+    "env": {
+        "browser": true
+    },
+    "extends": "eslint:recommended",
+    "rules": {
+        "indent": [
+            "error",
+            4
+        ],
+        "linebreak-style": [
+            "error",
+            "unix"
+        ],
+        "quotes": "off",
+        "semi": [
+            "error",
+            "always"
+        ]
+    }
+}

package.json

@@ -1,12 +1,13 @@
 {
   "name": "django-oscar",
-  "version": "1.1.1",
+  "version": "1.6.0",
   "description": "A domain-driven e-commerce framework for Django",
   "main": "index.js",
   "dependencies": {},
   "devDependencies": {
     "bootstrap": "^3.3.7",
     "bootstrap-datetime-picker": "^2.4.4",
+    "eslint": "^4.19.1",
     "gulp": "~3.9.1",
     "gulp-autoprefixer": "~1.0.1",
     "gulp-concat": "^2.6.1",
@@ -20,13 +21,14 @@
     "less": "^2.5.3",
     "pump": "^1.0.1",
     "require-dir": "^0.3.0",
-    "tinymce": "^4.7.6",
     "select2": "4.0.5",
-    "select2-bootstrap-theme": "0.1.0-beta.10"
+    "select2-bootstrap-theme": "0.1.0-beta.10",
+    "tinymce": "^4.7.6"
   },
   "scripts": {
     "build": "gulp",
-    "start": "gulp watch"
+    "start": "gulp watch",
+    "eslint": "./node_modules/.bin/eslint src/oscar/static/oscar/js/oscar/"
   },
   "license": "MIT",
   "homepage": "https://github.com/django-oscar/django-oscar#readme"

src/oscar/static/oscar/js/oscar/RelatedObjectLookups.js

@@ -1,3 +1,4 @@
+/*global jQuery,oscar */
 /*!
  * Code in this file copied and modified from Django's admin app
  * Source-code file: django/contrib/admin/static/admin/js/admin/RelatedObjectLookups.js
@@ -28,11 +29,11 @@
      * Date: 2017-08-25T12:16:21+03:00
      */
     o.interpolate = function(fmt, obj, named) {
-      if (named) {
-        return fmt.replace(/%\(\w+\)s/g, function(match){return String(obj[match.slice(2,-2)])});
-      } else {
-        return fmt.replace(/%s/g, function(match){return String(obj.shift())});
-      }
+        if (named) {
+            return fmt.replace(/%\(\w+\)s/g, function(match){return String(obj[match.slice(2,-2)]);});
+        } else {
+            return fmt.replace(/%s/g, function(){return String(obj.shift());});
+        }
     };
 
     // IE doesn't accept periods or dashes in the window name, but the element IDs
@@ -41,7 +42,7 @@
     // element when the popup window is dismissed.
     o.id_to_windowname = function(text) {
         text = text.replace(/\./g, '__dot__');
-        text = text.replace(/\-/g, '__dash__');
+        text = text.replace(/-/g, '__dash__');
         return text;
     };
 
@@ -111,7 +112,7 @@
             }
         }).trigger('change');
         win.close();
-    }
+    };
 
     o.dismissDeleteRelatedObjectPopup = function(win, objId) {
         var id = o.windowname_to_id(win.name).replace(/^delete_/, '');
@@ -135,7 +136,7 @@
             }
         }
     });
-    $('body').on('change', '.related-widget-wrapper select', function(e) {
+    $('body').on('change', '.related-widget-wrapper select', function() {
         var event = $.Event('oscar:update-related');
         $(this).trigger(event);
         if (!event.isDefaultPrevented()) {

src/oscar/static/oscar/js/oscar/dashboard.js

@@ -1,3 +1,5 @@
+/*global jQuery */
+
 var oscar = (function(o, $) {
 
     o.getCsrfToken = function() {
@@ -5,7 +7,7 @@ var oscar = (function(o, $) {
         var cookies = document.cookie.split(';');
         var csrf_token = null;
         $.each(cookies, function(index, cookie) {
-            cookieParts = $.trim(cookie).split('=');
+            var cookieParts = $.trim(cookie).split('=');
             if (cookieParts[0] == 'csrftoken') {
                 csrf_token = cookieParts[1];
             }
@@ -47,7 +49,7 @@ var oscar = (function(o, $) {
 
             $(".category-select ul").prev('a').on('click', function(){
                 var $this = $(this),
-                plus = $this.hasClass('ico_expand');
+                    plus = $this.hasClass('ico_expand');
                 if (plus) {
                     $this.removeClass('ico_expand').addClass('ico_contract');
                 } else {
@@ -58,8 +60,8 @@ var oscar = (function(o, $) {
 
             // Adds error icon if there are errors in the product update form
             $('[data-behaviour="affix-nav-errors"] .tab-pane').each(function(){
-              var productErrorListener = $(this).find('[class*="error"]:not(:empty)').closest('.tab-pane').attr('id');
-              $('[data-spy="affix"] a[href="#' + productErrorListener + '"]').append('<i class="icon-info-sign pull-right"></i>');
+                var productErrorListener = $(this).find('[class*="error"]:not(:empty)').closest('.tab-pane').attr('id');
+                $('[data-spy="affix"] a[href="#' + productErrorListener + '"]').append('<i class="icon-info-sign pull-right"></i>');
             });
 
             o.dashboard.filereader.init();
@@ -82,7 +84,7 @@ var oscar = (function(o, $) {
             o.dashboard.initSelects(el);
         },
         initMasks: function(el) {
-            $(el).find(':input').inputmask()
+            $(el).find(':input').inputmask();
         },
         initSelects: function(el) {
             // Adds type/search for select fields
@@ -118,7 +120,7 @@ var oscar = (function(o, $) {
                     'language': o.dashboard.options.languageCode,
                     'minView': 2
                 };
-                $dates = $(el).find('[data-oscarWidget="date"]').not('.no-widget-init').not('.no-widget-init *')
+                var $dates = $(el).find('[data-oscarWidget="date"]').not('.no-widget-init').not('.no-widget-init *');
                 $dates.each(function(ind, ele) {
                     var $ele = $(ele),
                         config = $.extend({}, defaultDatepickerConfig, {
@@ -134,12 +136,12 @@ var oscar = (function(o, $) {
                     'language': o.dashboard.options.languageCode,
                     'initialDate': o.dashboard.options.initialDate
                 };
-                $datetimes = $(el).find('[data-oscarWidget="datetime"]').not('.no-widget-init').not('.no-widget-init *')
+                var $datetimes = $(el).find('[data-oscarWidget="datetime"]').not('.no-widget-init').not('.no-widget-init *');
                 $datetimes.each(function(ind, ele) {
                     var $ele = $(ele),
                         config = $.extend({}, defaultDatetimepickerConfig, {
-                          'format': $ele.data('datetimeformat'),
-                          'minuteStep': $ele.data('stepminute')
+                            'format': $ele.data('datetimeformat'),
+                            'minuteStep': $ele.data('stepminute')
                         });
                     $ele.datetimepicker(config);
                 });
@@ -151,15 +153,15 @@ var oscar = (function(o, $) {
                     'language': o.dashboard.options.languageCode,
                     'initialDate': o.dashboard.options.initialDate
                 };
-                $times = $(el).find('[data-oscarWidget="time"]').not('.no-widget-init').not('.no-widget-init *')
+                var $times = $(el).find('[data-oscarWidget="time"]').not('.no-widget-init').not('.no-widget-init *');
                 $times.each(function(ind, ele) {
                     var $ele = $(ele),
                         config = $.extend({}, defaultTimepickerConfig, {
-                          'format': $ele.data('timeformat'),
-                          'minuteStep': $ele.data('stepminute'),
-                          'startView': 1,
-                          'maxView': 1,
-                          'formatViewType': 'time'
+                            'format': $ele.data('timeformat'),
+                            'minuteStep': $ele.data('stepminute'),
+                            'startView': 1,
+                            'maxView': 1,
+                            'formatViewType': 'time'
                         });
                     $ele.datetimepicker(config);
                 });
@@ -167,7 +169,7 @@ var oscar = (function(o, $) {
         },
         initWYSIWYG: function(el) {
             // Use TinyMCE by default
-            $textareas = $(el).find('textarea').not('.no-widget-init textarea').not('.no-widget-init');
+            var $textareas = $(el).find('textarea').not('.no-widget-init textarea').not('.no-widget-init');
             $textareas.filter('form.wysiwyg textarea').tinymce(o.dashboard.options.tinyConfig);
             $textareas.filter('.wysiwyg').tinymce(o.dashboard.options.tinyConfig);
         },
@@ -205,11 +207,11 @@ var oscar = (function(o, $) {
             init: function(){
                 var type_selects = $("select[name$=type]");
 
-                type_selects.each(function(index){
+                type_selects.each(function(){
                     o.dashboard.product_attributes.toggleOptionGroup($(this));
                 });
 
-                type_selects.change(function(e){
+                type_selects.change(function(){
                     o.dashboard.product_attributes.toggleOptionGroup($(this));
                 });
             },
@@ -223,7 +225,7 @@ var oscar = (function(o, $) {
         ranges: {
             init: function() {
                 $('[data-behaviours~="remove"]').click(function() {
-                    $this = $(this);
+                    var $this = $(this);
                     $this.parents('table').find('input').prop('checked', false);
                     $this.parents('tr').find('input').prop('checked', true);
                     $this.parents('form').submit();
@@ -252,48 +254,48 @@ var oscar = (function(o, $) {
         },
         reordering: (function() {
             var options = {
-                handle: '.btn-handle',
-                submit_url: '#'
-            },
-            saveOrder = function(data) {
+                    handle: '.btn-handle',
+                    submit_url: '#'
+                },
+                saveOrder = function(data) {
                 // Get the csrf token, otherwise django will not accept the
                 // POST request.
-                var csrf = o.getCsrfToken();
-                $.ajax({
-                    type: 'POST',
-                    data: $.param(data),
-                    dataType: "json",
-                    url: options.submit_url,
-                    beforeSend: function(xhr, settings) {
-                        xhr.setRequestHeader("X-CSRFToken", csrf);
-                    }
-                });
-            },
-            init = function(user_options) {
-                options = $.extend(options, user_options);
-                var group = $(options.wrapper).sortable({
-                    group: 'serialization',
-                    containerSelector: 'tbody',
-                    itemSelector: 'tr',
-                    handle: options.handle,
-                    vertical: true,
-                    onDrop: function ($item, container, _super) {
-                        var data = group.sortable("serialize");
-                        saveOrder(data);
-                        _super($item, container);
-                    },
-                    placeholder: '<tr class="placeholder"/>',
-                    serialize: function (parent, children, isContainer) {
-                        if (isContainer) {
-                            return children;
+                    var csrf = o.getCsrfToken();
+                    $.ajax({
+                        type: 'POST',
+                        data: $.param(data),
+                        dataType: "json",
+                        url: options.submit_url,
+                        beforeSend: function(xhr) {
+                            xhr.setRequestHeader("X-CSRFToken", csrf);
                         }
-                        else {
-                            var parts = parent.attr('id').split('_');
-                            return {'name': parts[0], 'value': parts[1]};
+                    });
+                },
+                init = function(user_options) {
+                    options = $.extend(options, user_options);
+                    var group = $(options.wrapper).sortable({
+                        group: 'serialization',
+                        containerSelector: 'tbody',
+                        itemSelector: 'tr',
+                        handle: options.handle,
+                        vertical: true,
+                        onDrop: function ($item, container, _super) {
+                            var data = group.sortable("serialize");
+                            saveOrder(data);
+                            _super($item, container);
+                        },
+                        placeholder: '<tr class="placeholder"/>',
+                        serialize: function (parent, children, isContainer) {
+                            if (isContainer) {
+                                return children;
+                            }
+                            else {
+                                var parts = parent.attr('id').split('_');
+                                return {'name': parts[0], 'value': parts[1]};
+                            }
                         }
-                    }
-                });
-            };
+                    });
+                };
 
             return {
                 init: init,
@@ -305,7 +307,7 @@ var oscar = (function(o, $) {
                 var searchForm = $(".orders_search"),
                     searchLink = $('.pull_out'),
                     doc = $('document');
-                searchForm.each(function(index) {
+                searchForm.each(function() {
                     doc.css('height', doc.height());
                 });
                 searchLink.on('click', function() {
@@ -314,7 +316,7 @@ var oscar = (function(o, $) {
                         .toggleClass('no-float')
                         .end().end()
                         .slideToggle("fast");
-                    }
+                }
                 );
             }
         },

src/oscar/static/oscar/js/oscar/ui.js

@@ -1,3 +1,5 @@
+/*global jQuery */
+
 var oscar = (function(o, $) {
     // Replicate Django's flash messages so they can be used by AJAX callbacks.
     o.messages = {
@@ -82,19 +84,19 @@ var oscar = (function(o, $) {
             });
             // stuff for star rating on review page
             // show clickable stars instead of a select dropdown for product rating
-            ratings = $('.reviewrating');
+            var ratings = $('.reviewrating');
             if(ratings.length){
                 ratings.find('.star-rating i').on('click',o.forms.reviewRatingClick);
             }
         },
-        submitIfNotLocked: function(event) {
+        submitIfNotLocked: function() {
             var $form = $(this);
             if ($form.data('locked')) {
                 return false;
             }
             $form.data('locked', true);
         },
-        reviewRatingClick: function(event){
+        reviewRatingClick: function(){
             var ratings = ['One','Two','Three','Four','Five']; //possible classes for display state
             $(this).parent().removeClass('One Two Three Four Five').addClass(ratings[$(this).index()]);
             $(this).closest('.controls').find('select').val($(this).index() + 1); //select is hidden, set value
@@ -182,7 +184,7 @@ var oscar = (function(o, $) {
                 o.basket.checkAndSubmit($(this), 'form', 'save_for_later');
                 event.preventDefault();
             });
-            $('#content_inner').on('click', '#saved_basket_formset a[data-behaviours~="move"]', function(event) {
+            $('#content_inner').on('click', '#saved_basket_formset a[data-behaviours~="move"]', function() {
                 o.basket.checkAndSubmit($(this), 'saved', 'move_to_basket');
             });
             $('#content_inner').on('click', '#saved_basket_formset a[data-behaviours~="remove"]', function(event) {
@@ -285,7 +287,7 @@ var oscar = (function(o, $) {
                     'language': o.datetimepickers.options.languageCode,
                     'minView': 2
                 };
-                $dates = $(el).find('[data-oscarWidget="date"]').not('.no-widget-init').not('.no-widget-init *');
+                var $dates = $(el).find('[data-oscarWidget="date"]').not('.no-widget-init').not('.no-widget-init *');
                 $dates.each(function(ind, ele) {
                     var $ele = $(ele),
                         config = $.extend({}, defaultDatepickerConfig, {
@@ -300,12 +302,12 @@ var oscar = (function(o, $) {
                     'autoclose': true,
                     'language': o.datetimepickers.options.languageCode
                 };
-                $datetimes = $(el).find('[data-oscarWidget="datetime"]').not('.no-widget-init').not('.no-widget-init *');
+                var $datetimes = $(el).find('[data-oscarWidget="datetime"]').not('.no-widget-init').not('.no-widget-init *');
                 $datetimes.each(function(ind, ele) {
                     var $ele = $(ele),
                         config = $.extend({}, defaultDatetimepickerConfig, {
-                          'format': $ele.data('datetimeformat'),
-                          'minuteStep': $ele.data('stepminute')
+                            'format': $ele.data('datetimeformat'),
+                            'minuteStep': $ele.data('stepminute')
                         });
                     $ele.datetimepicker(config);
                 });
@@ -316,15 +318,15 @@ var oscar = (function(o, $) {
                     'autoclose': true,
                     'language': o.datetimepickers.options.languageCode
                 };
-                $times = $(el).find('[data-oscarWidget="time"]').not('.no-widget-init').not('.no-widget-init *')
+                var $times = $(el).find('[data-oscarWidget="time"]').not('.no-widget-init').not('.no-widget-init *');
                 $times.each(function(ind, ele) {
                     var $ele = $(ele),
                         config = $.extend({}, defaultTimepickerConfig, {
-                          'format': $ele.data('timeformat'),
-                          'minuteStep': $ele.data('stepminute'),
-                          'startView': 1,
-                          'maxView': 1,
-                          'formatViewType': 'time'
+                            'format': $ele.data('timeformat'),
+                            'minuteStep': $ele.data('stepminute'),
+                            'startView': 1,
+                            'maxView': 1,
+                            'formatViewType': 'time'
                         });
                     $ele.datetimepicker(config);
                 });

tox.ini

@@ -37,8 +37,10 @@ deps =
     flake8
     isort
 commands =
+    npm install
     flake8 src tests setup.py
     isort -q --recursive --diff src/ tests/
+    npm run eslint
     django-admin.py compilemessages