govuk_frontend_toolkit 4.18.3 → 4.18.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff89585fe100d23ffb900f2b96330c86e7f0fdf5
-  data.tar.gz: 36ef8152896403bea8a5904192b42956109a8425
+  metadata.gz: ed31373cbe3fd29495e7825368045f0961c44b00
+  data.tar.gz: 5e1914525810948b8ea7ebeb6a863500c3b8dc7e
 SHA512:
-  metadata.gz: 550dae177f300cb2c69a4220ed10bf07f05789478afd1529697d033569ab486b0ea35c006e1548ab171f0ffbd2bdb1ae3e9b898fd506dbdf195b8681b0b3d35d
-  data.tar.gz: 199cd1b7031db11cd65ec393be4eaa0749e9d690e9d28607073b8f82fdfefe2d2ef5eeba353dfaa4ab944b8418e6e3cfcde172a4cab7fb2214e0daf2e5836c1b
+  metadata.gz: 6de494a693da9ee1f4650cec2e256de23b91b46627f035e7d688e4ab4625e9dfce928809b6f1ae921e32879bf8de4a32f5492111fe37f88e1742047510128e5c
+  data.tar.gz: 1581b99971f60eebab602605fe1bc1de2e32b69ccec3b4d00653759b9e8f000e76c63d5c3543f08829958e2bebf9bb045f51bf6410a8b19e7b669b4c260f5f34

data/app/assets/.gitignore

@@ -2,3 +2,4 @@ node_modules/
 .sass-cache
 npm-debug.log
 spec/stylesheets
+_SpecRunner.html

data/app/assets/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 4.18.4
+
+- Lint codebase using standard ([PR #334](https://github.com/alphagov/govuk_frontend_toolkit/pull/334))
+- Add semicolons at the start of IIFE's ([PR #339](https://github.com/alphagov/govuk_frontend_toolkit/pull/339))
+
 # 4.18.3
 
 - For smaller screens (<768px) ensure that the GOVUK.StickAtTopWhenScrolling JS "unsticks" the element which was previously "stuck" (by removing both the class which sets fixed positioning and the shim). ([PR #329](https://github.com/alphagov/govuk_frontend_toolkit/pull/329))

data/app/assets/Gruntfile.js

@@ -1,30 +1,29 @@
-module.exports = function(grunt) {
-  var allSassFiles = [];
-
-  var path = require('path');
+module.exports = function (grunt) {
+  var allSassFiles = []
 
   grunt.file.recurse(
-    "./stylesheets/",
-    function(abspath, rootdir, subdir, filename) {
-      if(typeof subdir !== 'undefined'){
-        var relpath = subdir + '/' + filename;
+    './stylesheets/',
+    function (abspath, rootdir, subdir, filename) {
+      var relpath
+      if (typeof subdir !== 'undefined') {
+        relpath = subdir + '/' + filename
       } else {
-        var relpath = filename;
+        relpath = filename
       }
       if (filename.match(/\.scss/)) {
-        allSassFiles.push("@import '" + relpath + "';");
+        allSassFiles.push("@import '" + relpath + "';")
       }
     }
-  );
+  )
 
   grunt.file.write(
-    "./spec/stylesheets/test.scss",
-    allSassFiles.join("\n")
-  );
+    './spec/stylesheets/test.scss',
+    allSassFiles.join('\n')
+  )
 
   grunt.initConfig({
     clean: {
-      sass: ["spec/stylesheets/test*css"]
+      sass: ['spec/stylesheets/test*css']
     },
     jasmine: {
       javascripts: {
@@ -53,12 +52,12 @@ module.exports = function(grunt) {
         }
       }
     }
-  });
+  })
 
-  grunt.loadNpmTasks('grunt-contrib-clean');
-  grunt.loadNpmTasks('grunt-contrib-jasmine');
-  grunt.loadNpmTasks('grunt-contrib-sass');
+  grunt.loadNpmTasks('grunt-contrib-clean')
+  grunt.loadNpmTasks('grunt-contrib-jasmine')
+  grunt.loadNpmTasks('grunt-contrib-sass')
 
-  grunt.registerTask('test', ['sass', 'clean', 'jasmine']);
-  grunt.registerTask('default', ['test']);
-};
+  grunt.registerTask('test', ['sass', 'clean', 'jasmine'])
+  grunt.registerTask('default', ['test'])
+}

data/app/assets/README.md

@@ -94,6 +94,10 @@ npm install
 npm test
 ```
 
+### Standard JavaScript
+`govuk_frontend_toolkit` uses [standardjs](http://standardjs.com/), an opinionated JavaScript linter.
+All JavaScript files follow its conventions. [Read more](https://github.com/alphagov/govuk_prototype_kit/blob/master/docs/linting.md)
+
 ### Using the local test runner
 
 The test suite can be run by opening the `./spec/support/LocalTestRunner.html` file in a browser for a more detailed trace of errors.

data/app/assets/VERSION.txt

@@ -1 +1 @@
-4.18.3
+4.18.4

data/app/assets/docs/javascript.md

@@ -23,7 +23,7 @@ Modules can be found and started by including `govuk/modules.js` and running:
 
 ```javascript
 $(document).ready(function(){
-  GOVUK.modules.start();
+  GOVUK.modules.start()
 });
 ```
 
@@ -32,15 +32,15 @@ This will attempt to find and start all modules in the page. For the example abo
 The module will be instantiated and then its `start` method called. The HTML element with the `data-module` attribute is passed as the first argument to the module. This limits modules to acting only within their containing elements.
 
 ```javascript
-module = new GOVUK.Modules[type]();
-module.start(element);
+module = new GOVUK.Modules[type]()
+module.start(element)
 ```
 
 Running `GOVUK.modules.start()` multiple times will have no additional affect. When a module is started a flag is set on the element using the data attribute `module-started`. `data-module-started` is a reserved attribute. It can however be called with an element as the first argument, to allow modules to be started in dynamically loaded content:
 
 ```javascript
-var $container = $('.dynamic-content');
-GOVUK.modules.start($container);
+var $container = $('.dynamic-content')
+GOVUK.modules.start($container)
 ```
 
 ### Module structure
@@ -49,14 +49,15 @@ A module must add its constructor to `GOVUK.Modules` and it must have a `start`
 The simplest module looks like:
 
 ```javascript
-(function(Modules) {
-  "use strict";
+;(function(Modules) {
+  'use strict'
+  
   Modules.SomeModule = function() {
     this.start = function($element) {
       // module code
     }
-  };
-})(window.GOVUK.Modules);
+  }
+})(window.GOVUK.Modules)
 ```
 
 ### Writing modules
@@ -80,8 +81,8 @@ Beginning with a set of event listeners clearly indicates the module’s intenti
 
 ```js
 this.start = function($element) {
-  $element.on('click', '.js-toggle', toggle);
-  $element.on('click', '.js-cancel', cancel);
+  $element.on('click', '.js-toggle', toggle)
+  $element.on('click', '.js-cancel', cancel)
 }
 ```
 
@@ -302,13 +303,13 @@ To add it to all lists which have items with the class `primary-item` use
 something like:
 
 ```javascript
-GOVUK.primaryLinks.init('.primary-item');
+GOVUK.primaryLinks.init('.primary-item')
 ```
 
 Or to add it just to that list you could use:
 
 ```javascript
-new GOVUK.PrimaryList($('#primary-list'), '.primary-item');
+new GOVUK.PrimaryList($('#primary-list'), '.primary-item')
 ```
 
 ## Stick at top when scrolling
@@ -333,7 +334,7 @@ The following would cause the element to stay when you scroll:
 ```
 
 ```javascript
-GOVUK.stickAtTopWhenScrolling.init();
+GOVUK.stickAtTopWhenScrolling.init()
 ```
 
 If you also include the `stopScrollingAtFooter` JavaScript this will also try
@@ -356,14 +357,14 @@ When the input is focused or its `checked` attribute is set, classes are added t
 To apply this behaviour to elements with the above HTML pattern, call the `GOVUK.SelectionButtons` constructor with their inputs:
 
 ```
-var $buttons = $("label input[type='radio'], label input[type='checkbox']");
-var selectionButtons = new GOVUK.SelectionButtons($buttons);
+var $buttons = $("label input[type='radio'], label input[type='checkbox']")
+var selectionButtons = new GOVUK.SelectionButtons($buttons)
 ```
 
 You can also call `GOVUK.SelectionButtons` with a selector:
 
 ```
-var selectionButtons = new GOVUK.SelectionButtons("label input[type='radio'], label input[type='checkbox']");
+var selectionButtons = new GOVUK.SelectionButtons("label input[type='radio'], label input[type='checkbox']")
 ```
 
 This will bind all events to the document, meaning any changes to content (for example, by AJAX) will not effect the button's behaviour.
@@ -371,10 +372,10 @@ This will bind all events to the document, meaning any changes to content (for e
 The classes that get added to the `<label>` tags can be passed in as options:
 
 ```
-var $buttons = $("label input[type='radio'], label input[type='checkbox']");
-var selectionButtons = new GOVUK.SelectionButtons($buttons, { focusedClass : 'selectable-focused', selectedClass : 'selectable-selected' });
+var $buttons = $("label input[type='radio'], label input[type='checkbox']")
+var selectionButtons = new GOVUK.SelectionButtons($buttons, { focusedClass : 'selectable-focused', selectedClass : 'selectable-selected' })
 
-var selectionButtons = new GOVUK.SelectionButtons("label input[type='radio'], label input[type='checkbox']", { focusedClass : 'selectable-focused', selectedClass : 'selectable-selected' });
+var selectionButtons = new GOVUK.SelectionButtons("label input[type='radio'], label input[type='checkbox']", { focusedClass : 'selectable-focused', selectedClass : 'selectable-selected' })
 ```
 
 #### destroy method
@@ -393,8 +394,8 @@ The previous method of calling selection buttons is now deprecated. If you need
 
 ```
 GOVUK.selectionButtons = function (elms, opts) {
-  new GOVUK.SelectionButtons(elms, opts);
-};
+  new GOVUK.SelectionButtons(elms, opts)
+}
 ```
 
 This method will mean the `destroy` method is not available to call.
@@ -412,7 +413,7 @@ By default, this behaviour will only be applied to links with a role of button.
 ```
 
 ```javascript
-GOVUK.shimLinksWithButtonRole.init();
+GOVUK.shimLinksWithButtonRole.init()
 ```
 
 If you need to override the elements this is applied to then you can do that by passing in a custom selector to the initialiser:
@@ -420,7 +421,7 @@ If you need to override the elements this is applied to then you can do that by
 ```javascript
 GOVUK.shimLinksWithButtonRole.init({
   selector: '.my-class'
-});
+})
 ```
 
 It’s also possible to define more or different keycodes to activate against:
@@ -457,8 +458,8 @@ When the input's `checked` attribute is set, the show/hide content's `.js-hidden
 To apply this behaviour to elements with the above HTML pattern, call the `GOVUK.ShowHideContent` constructor:
 
 ```
-var showHideContent = new GOVUK.ShowHideContent();
-showHideContent.init();
+var showHideContent = new GOVUK.ShowHideContent()
+showHideContent.init()
 ```
 
 This will bind two event handlers to $(document.body), one for radio inputs and one for checkboxes. By listening for events bubbling up to the `body` tag, additional show/hide content added to the page will still be picked up after `.init()` is called.
@@ -466,6 +467,6 @@ This will bind two event handlers to $(document.body), one for radio inputs and
 Alternatively, pass in your own selector. In the example below, event handlers are bound to the form instead.
 
 ```
-var showHideContent = new GOVUK.ShowHideContent();
-showHideContent.init($('form.example'));
+var showHideContent = new GOVUK.ShowHideContent()
+showHideContent.init($('form.example'))
 ```

data/app/assets/javascripts/govuk/analytics/analytics.js

@@ -1,38 +1,38 @@
-(function(global) {
-  "use strict";
+;(function (global) {
+  'use strict'
 
-  var GOVUK = global.GOVUK || {};
+  var GOVUK = global.GOVUK || {}
 
   // For usage and initialisation see:
   // https://github.com/alphagov/govuk_frontend_toolkit/blob/master/docs/analytics.md#create-an-analytics-tracker
 
-  var Analytics = function(config) {
-    this.trackers = [];
-    if (typeof config.universalId != 'undefined') {
-      var universalId = config.universalId;
-      delete config.universalId;
-      this.trackers.push(new GOVUK.GoogleAnalyticsUniversalTracker(universalId, config));
+  var Analytics = function (config) {
+    this.trackers = []
+    if (typeof config.universalId !== 'undefined') {
+      var universalId = config.universalId
+      delete config.universalId
+      this.trackers.push(new GOVUK.GoogleAnalyticsUniversalTracker(universalId, config))
     }
-  };
+  }
 
-  Analytics.prototype.sendToTrackers = function(method, args) {
+  Analytics.prototype.sendToTrackers = function (method, args) {
     for (var i = 0, l = this.trackers.length; i < l; i++) {
-      var tracker = this.trackers[i],
-          fn = tracker[method];
+      var tracker = this.trackers[i]
+      var fn = tracker[method]
 
-      if (typeof fn === "function") {
-        fn.apply(tracker, args);
+      if (typeof fn === 'function') {
+        fn.apply(tracker, args)
       }
     }
-  };
+  }
 
-  Analytics.load = function() {
-    GOVUK.GoogleAnalyticsUniversalTracker.load();
-  };
+  Analytics.load = function () {
+    GOVUK.GoogleAnalyticsUniversalTracker.load()
+  }
 
-  Analytics.prototype.trackPageview = function(path, title, options) {
-    this.sendToTrackers('trackPageview', arguments);
-  };
+  Analytics.prototype.trackPageview = function (path, title, options) {
+    this.sendToTrackers('trackPageview', arguments)
+  }
 
   /*
     https://developers.google.com/analytics/devguides/collection/analyticsjs/events
@@ -40,30 +40,30 @@
     options.value – Values must be non-negative. Useful to pass counts
     options.nonInteraction – Prevent event from impacting bounce rate
   */
-  Analytics.prototype.trackEvent = function(category, action, options) {
-    this.sendToTrackers('trackEvent', arguments);
-  };
+  Analytics.prototype.trackEvent = function (category, action, options) {
+    this.sendToTrackers('trackEvent', arguments)
+  }
 
-  Analytics.prototype.trackShare = function(network) {
-    this.sendToTrackers('trackSocial', [network, 'share', location.pathname]);
-  };
+  Analytics.prototype.trackShare = function (network) {
+    this.sendToTrackers('trackSocial', [network, 'share', global.location.pathname])
+  }
 
   /*
     The custom dimension index must be configured within the
     Universal Analytics profile
    */
-  Analytics.prototype.setDimension = function(index, value) {
-    this.sendToTrackers('setDimension', arguments);
-  };
+  Analytics.prototype.setDimension = function (index, value) {
+    this.sendToTrackers('setDimension', arguments)
+  }
 
   /*
    Add a beacon to track a page in another GA account on another domain.
    */
-  Analytics.prototype.addLinkedTrackerDomain = function(trackerId, name, domain) {
-    this.sendToTrackers('addLinkedTrackerDomain', arguments);
-  };
+  Analytics.prototype.addLinkedTrackerDomain = function (trackerId, name, domain) {
+    this.sendToTrackers('addLinkedTrackerDomain', arguments)
+  }
 
-  GOVUK.Analytics = Analytics;
+  GOVUK.Analytics = Analytics
 
-  global.GOVUK = GOVUK;
-})(window);
+  global.GOVUK = GOVUK
+})(window)

data/app/assets/javascripts/govuk/analytics/download-link-tracker.js

@@ -1,41 +1,41 @@
-(function(global) {
-  "use strict";
+;(function (global) {
+  'use strict'
 
-  var $ = global.jQuery;
-  var GOVUK = global.GOVUK || {};
+  var $ = global.jQuery
+  var GOVUK = global.GOVUK || {}
 
-  GOVUK.analyticsPlugins = GOVUK.analyticsPlugins || {};
+  GOVUK.analyticsPlugins = GOVUK.analyticsPlugins || {}
   GOVUK.analyticsPlugins.downloadLinkTracker = function (options) {
-    var options = options || {},
-        downloadLinkSelector = options.selector;
+    options = options || {}
+    var downloadLinkSelector = options.selector
 
     if (downloadLinkSelector) {
-      $('body').on('click', downloadLinkSelector, trackDownload);
+      $('body').on('click', downloadLinkSelector, trackDownload)
     }
 
-    function trackDownload(evt) {
-      var $link = getLinkFromEvent(evt),
-          href = $link.attr('href'),
-          evtOptions = {transport: 'beacon'},
-          linkText = $.trim($link.text());
+    function trackDownload (evt) {
+      var $link = getLinkFromEvent(evt)
+      var href = $link.attr('href')
+      var evtOptions = {transport: 'beacon'}
+      var linkText = $.trim($link.text())
 
       if (linkText) {
-        evtOptions.label = linkText;
+        evtOptions.label = linkText
       }
 
-      GOVUK.analytics.trackEvent('Download Link Clicked', href, evtOptions);
+      GOVUK.analytics.trackEvent('Download Link Clicked', href, evtOptions)
     }
 
-    function getLinkFromEvent(evt) {
-      var $target = $(evt.target);
+    function getLinkFromEvent (evt) {
+      var $target = $(evt.target)
 
       if (!$target.is('a')) {
-        $target = $target.parents('a');
+        $target = $target.parents('a')
       }
 
-      return $target;
+      return $target
     }
   }
 
-  global.GOVUK = GOVUK;
-})(window);
+  global.GOVUK = GOVUK
+})(window)

data/app/assets/javascripts/govuk/analytics/error-tracking.js

@@ -1,51 +1,51 @@
 // Extension to track errors using google analytics as a data store.
-(function(global) {
-  "use strict";
+;(function (global) {
+  'use strict'
 
-  var GOVUK = global.GOVUK || {};
+  var GOVUK = global.GOVUK || {}
 
-  GOVUK.analyticsPlugins = GOVUK.analyticsPlugins || {};
+  GOVUK.analyticsPlugins = GOVUK.analyticsPlugins || {}
 
   GOVUK.analyticsPlugins.error = function (options) {
-    var options = options || {},
-        filenameMustMatch = options.filenameMustMatch;
+    options = options || {}
+    var filenameMustMatch = options.filenameMustMatch
 
     var trackJavaScriptError = function (e) {
-      var errorFilename = e.filename,
-          errorSource = errorFilename + ': ' + e.lineno;
+      var errorFilename = e.filename
+      var errorSource = errorFilename + ': ' + e.lineno
 
       if (shouldTrackThisError(errorFilename)) {
         GOVUK.analytics.trackEvent('JavaScript Error', e.message, {
           label: errorSource,
           value: 1,
           nonInteraction: true
-        });
+        })
       }
-    };
+    }
 
-    function shouldTrackThisError(errorFilename) {
+    function shouldTrackThisError (errorFilename) {
       // Errors in page should always be tracked
       // If there's no filename filter, everything is tracked
       if (!errorFilename || !filenameMustMatch) {
-        return true;
+        return true
       }
 
       // If there's a filter and the error matches it, track it
       if (filenameMustMatch.test(errorFilename)) {
-        return true;
+        return true
       }
 
-      return false;
+      return false
     }
 
     if (global.addEventListener) {
-      global.addEventListener('error', trackJavaScriptError, false);
+      global.addEventListener('error', trackJavaScriptError, false)
     } else if (global.attachEvent) {
-      global.attachEvent('onerror', trackJavaScriptError);
+      global.attachEvent('onerror', trackJavaScriptError)
     } else {
-      global.onerror = trackJavaScriptError;
+      global.onerror = trackJavaScriptError
     }
   }
 
-  global.GOVUK = GOVUK;
-})(window);
+  global.GOVUK = GOVUK
+})(window)