govuk_tech_docs 6.3.0 → 6.4.1.0

data/lib/tasks/lint.rake

@@ -1,33 +1,107 @@
 # Rakefile
 require "json"
-require "open3"
+require "timeout" # Built into standard Ruby
 require_relative "./helpers/rake_utils"
 require_relative "./helpers/vale_report"
 
 namespace :lint do
-  # task vale_sync:
-  desc "Run tech-docs-linter to check content against GOV.UK style guide."
+  desc "Run linter to check content against GOV.UK style guide."
   task :vale, [:target, :clean_build, :full_output] do |_t, args|
     args.with_defaults(target: "./build", clean_build: "true", full_output: "true")
 
-    sh "bundle exec vale sync --config='#{vale_config_path}'"
+    Rake::Task["middleman:build"].invoke if args.clean_build == "true"
 
-    if args.clean_build == "true"
-      Rake::Task["middleman:build"].invoke
+    files = Dir.glob("#{args.target}/**/*.{html,md}")
+    puts "Running Vale against #{files.count} files...\n\n"
+
+    combined_json = {}
+
+    files.each do |file|
+      print "Linting #{file}... "
+
+      file_output = ""
+
+      # IO.popen runs the command and exposes the Process ID (PID)
+      IO.popen(["vale", "--config=#{vale_config_path}", "--output=JSON", file]) do |io|
+        begin
+          # If a file takes longer than 10 seconds, raise a timeout
+          Timeout.timeout(10) do
+            file_output = io.read
+          end
+          # If we reach here, it finished safely
+          puts "\e[32mDone\e[0m"
+        rescue Timeout::Error
+          # The regex hung. Send a SIGKILL to the Vale process to stop it chewing CPU
+          Process.kill("KILL", io.pid)
+          puts "\e[31mHUNG (Skipped due to timeout)\e[0m" # Red text
+        end
+      end
+
+      # Merge JSON only if we got a valid response (ignores timeouts)
+      unless file_output.strip.empty?
+        parsed_output = JSON.parse(file_output)
+        combined_json.merge!(parsed_output) unless parsed_output.empty?
+      end
     end
 
-    stdout, = Open3.capture3("vale --config='#{vale_config_path}' --output=JSON #{args.target}")
+    puts "\nGenerating report..."
 
-    linter_report = ValeLinterReport.new(stdout)
+    linter_report = ValeLinterReport.new(combined_json.to_json)
     linter_report.format_linter_output
-    if args.full_output == "true"
-      puts linter_report.get_linter_full_report
-    end
+
+    puts linter_report.get_linter_full_report if args.full_output == "true"
     puts linter_report.get_linter_summary_report
 
-    # finish with a Ci friendly json string
     linter_report.linter_summary_report_json
-    # Always exit 0 so individual project pipelines can evaluate the data themselves
     exit 0
   end
+
+  desc "Debug Vale to find which rule hangs on a specific file."
+  require 'timeout'
+
+  desc "Debug specific Vale rules for regex hangs"
+  task :debug, [:rules] do |_, args|
+    # Accepts Rake args (rake "debug[Rule1,Rule2]") or ENV vars (rake debug RULES=Rule1,Rule2)
+    raw_input = args[:rules] || ENV['RULES']
+
+    if raw_input.nil? || raw_input.strip.empty?
+      abort "Please provide rules to test. \nUsage: rake \"debug[Rule1,Rule2]\" OR rake debug RULES=Rule1,Rule2"
+    end
+
+    # Split by comma, remove whitespace, and drop any empty strings
+    rules = raw_input.split(',').map(&:strip).reject(&:empty?)
+
+    style_prefix = 'style-guide'
+    target_file = './build/search/index.html'
+
+    puts "Hunting for the hanging regex in #{target_file}..."
+    puts "Testing #{rules.size} rule(s): #{rules.join(', ')}\n\n"
+
+    rules.each do |rule_name|
+      full_rule = "#{style_prefix}.#{rule_name}"
+      print "Testing #{full_rule}... "
+      filter_string = ".Name=='#{full_rule}'"
+
+      # Run Vale for just this single rule
+      IO.popen(["vale", "--filter=#{filter_string}", "--output=line", target_file]) do |io|
+        begin
+          # If the regex loops catastrophically, it hits this 5-second limit
+          Timeout.timeout(5) do
+            io.read
+          end
+
+          # If it finishes within 5 seconds, the rule is safe
+          puts "\e[32mPassed (No hang)\e[0m"
+
+        rescue Timeout::Error
+          # The regex froze! Kill the underlying process to save CPU and flag it
+          Process.kill("KILL", io.pid)
+          puts "\e[31m💥 HUNG! (This is the broken regex)\e[0m"
+        end
+      end
+    end
+
+    exit 0
+  end
+
 end

data/node_modules/govuk-frontend/dist/govuk/all.bundle.js

@@ -4,7 +4,7 @@
   (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.GOVUKFrontend = global.GOVUKFrontend || {}));
 })(this, (function (exports) { 'use strict';
 
-  const version = '6.2.0';
+  const version = '6.5.1';
 
   function getBreakpoint(name) {
     const property = `--govuk-breakpoint-${name}`;
@@ -1594,16 +1594,13 @@
       this.id = void 0;
       this.$announcements = void 0;
       this.enteredAnotherElement = void 0;
-      const $input = this.$root.querySelector('input');
+      const $input = this.$root.querySelector('input[type="file"]');
       if ($input === null) {
         throw new ElementError({
           component: FileUpload,
           identifier: 'File inputs (`<input type="file">`)'
         });
       }
-      if ($input.type !== 'file') {
-        throw new ElementError(formatErrorMessage(FileUpload, 'File input (`<input type="file">`) attribute (`type`) is not `file`'));
-      }
       this.$input = $input;
       if (!this.$input.id) {
         throw new ElementError({

data/node_modules/govuk-frontend/dist/govuk/all.bundle.mjs

@@ -1,4 +1,4 @@
-const version = '6.2.0';
+const version = '6.5.1';
 
 function getBreakpoint(name) {
   const property = `--govuk-breakpoint-${name}`;
@@ -1588,16 +1588,13 @@ class FileUpload extends ConfigurableComponent {
     this.id = void 0;
     this.$announcements = void 0;
     this.enteredAnotherElement = void 0;
-    const $input = this.$root.querySelector('input');
+    const $input = this.$root.querySelector('input[type="file"]');
     if ($input === null) {
       throw new ElementError({
         component: FileUpload,
         identifier: 'File inputs (`<input type="file">`)'
       });
     }
-    if ($input.type !== 'file') {
-      throw new ElementError(formatErrorMessage(FileUpload, 'File input (`<input type="file">`) attribute (`type`) is not `file`'));
-    }
     this.$input = $input;
     if (!this.$input.id) {
       throw new ElementError({

data/node_modules/govuk-frontend/dist/govuk/common/govuk-frontend-version.mjs

@@ -1,4 +1,4 @@
-const version = '6.2.0';
+const version = '6.5.1';
 
 export { version };
 //# sourceMappingURL=govuk-frontend-version.mjs.map

data/node_modules/govuk-frontend/dist/govuk/components/_index.import.scss

@@ -10,14 +10,17 @@
 @import "error-message";
 @import "error-summary";
 @import "exit-this-page";
+@import "feedback";
 @import "fieldset";
 @import "file-upload";
 @import "footer";
+@import "generic-header";
 @import "header";
 @import "hint";
 @import "input";
 @import "inset-text";
 @import "label";
+@import "language-navigation";
 @import "notification-banner";
 @import "pagination";
 @import "panel";

data/node_modules/govuk-frontend/dist/govuk/components/_index.scss

@@ -10,14 +10,17 @@
 @use "error-message";
 @use "error-summary";
 @use "exit-this-page";
+@use "feedback";
 @use "fieldset";
 @use "file-upload";
 @use "footer";
+@use "generic-header";
 @use "header";
 @use "hint";
 @use "input";
 @use "inset-text";
 @use "label";
+@use "language-navigation";
 @use "notification-banner";
 @use "pagination";
 @use "panel";

data/node_modules/govuk-frontend/dist/govuk/components/breadcrumbs/_mixin.scss

@@ -124,11 +124,7 @@
   }
 
   .govuk-breadcrumbs--inverse {
-    color: base.govuk-colour("white");
-
-    .govuk-breadcrumbs__link {
-      @include base.govuk-link-style-inverse;
-    }
+    --govuk-text-colour: #{base.govuk-functional-colour(inverse-text)};
 
     .govuk-breadcrumbs__list-item::before {
       border-color: currentcolor;

data/node_modules/govuk-frontend/dist/govuk/components/checkboxes/_mixin.scss

@@ -41,7 +41,7 @@
     // __item using flex-wrap because we want hints on a separate line.
     max-width: calc(100% - #{(($govuk-checkboxes-label-padding-left-right * 2) + $govuk-touch-target-size)});
     margin-bottom: 0;
-    padding: (base.govuk-spacing(1) + base.$govuk-border-width-form-element) base.govuk-spacing(3);
+    padding: (base.govuk-spacing(1) + base.$govuk-border-width-form-element) $govuk-checkboxes-label-padding-left-right;
     cursor: pointer;
     // remove 300ms pause on mobile
     touch-action: manipulation;
@@ -206,6 +206,12 @@
     }
 
     .govuk-checkboxes__label {
+      // Recalculate max-width to account for the smaller checkbox size
+      // 1px comes from padding-left (defined below)
+      max-width: calc(
+        100% - #{($govuk-touch-target-size - $input-offset) + $govuk-checkboxes-label-padding-left-right + 1px}
+      );
+
       // Create a tiny space between the small checkbox hover state so that it
       // doesn't clash with the label
       padding-left: 1px;

data/node_modules/govuk-frontend/dist/govuk/components/cookie-banner/_mixin.scss

@@ -16,6 +16,12 @@
 
     color: base.govuk-functional-colour(surface-text);
     background-color: base.govuk-functional-colour(surface-background);
+
+    @media print {
+      border-bottom-color: currentcolor;
+      color: base.govuk-functional-colour(print-text);
+      background-color: transparent;
+    }
   }
 
   // Support older browsers which don't hide elements with the `hidden` attribute

data/node_modules/govuk-frontend/dist/govuk/components/exit-this-page/_mixin.scss

@@ -69,7 +69,11 @@
     right: 0;
     bottom: 0;
     left: 0;
-    background-color: base.govuk-colour("white");
+    // The overlay is imitating a default browser window so we can use
+    // system colours ensure it matches the browser's default colours.
+    // https://developer.mozilla.org/en-US/docs/Web/CSS/Reference/Values/system-color
+    color: CanvasText;
+    background-color: Canvas;
   }
 
   // This class is added to the body when the Exit This Page button is activated

data/node_modules/govuk-frontend/dist/govuk/components/feedback/_feedback.import.scss

@@ -0,0 +1,6 @@
+@use "../../settings/warnings--internal";
+
+@include warnings--internal.component-scss-file-warning("feedback");
+
+@import "index";
+

data/node_modules/govuk-frontend/dist/govuk/components/feedback/_index.import.scss

@@ -0,0 +1,8 @@
+@use "mixin";
+
+@import "../../base";
+
+@include govuk-exports("govuk/component/feedback") {
+  @include mixin.styles;
+}
+

data/node_modules/govuk-frontend/dist/govuk/components/feedback/_index.scss

@@ -0,0 +1,5 @@
+@use "../../custom-properties";
+@use "mixin";
+
+@include mixin.styles;
+

data/node_modules/govuk-frontend/dist/govuk/components/feedback/_mixin.scss

@@ -0,0 +1,48 @@
+@use "../../base";
+
+/// @access private
+@mixin styles {
+  .govuk-feedback {
+    box-sizing: border-box;
+    // Tie left/right padding to page gutter as it stretches across the whole
+    // screen on smaller screens
+    padding: base.govuk-spacing(4) base.$govuk-gutter-half base.govuk-spacing(5);
+    border-top: 1px solid;
+    border-color: base.govuk-functional-colour("brand");
+    background-color: base.govuk-functional-colour("surface-background");
+
+    @media #{base.govuk-from-breakpoint(tablet)} {
+      padding-right: base.govuk-spacing(4);
+      padding-left: base.govuk-spacing(4);
+    }
+
+    // Override $govuk-width-container's left and right margin as we want Feedback
+    // to go across the whole screen on smaller screens
+    @media #{base.govuk-until-breakpoint(tablet)} {
+      margin-right: 0;
+      margin-left: 0;
+    }
+
+    @media print {
+      border-color: currentcolor;
+      background-color: transparent;
+    }
+  }
+
+  .govuk-feedback__title {
+    @include base.govuk-font($size: 24, $weight: bold);
+    margin-top: 0;
+    color: base.govuk-functional-colour(text);
+    @include base.govuk-responsive-margin(1, "bottom");
+  }
+
+  // Removes the bottom margin from the final child element eg: a paragraph
+  //
+  // Feedback body doesn't have any opinions about typography. Instead we defer
+  // to users to use typography classes in their input, or apply a `govuk-body`
+  // paragraph for if users pass `text`.
+  .govuk-feedback__body > :last-child {
+    margin-bottom: 0;
+  }
+}
+

data/node_modules/govuk-frontend/dist/govuk/components/file-upload/file-upload.bundle.js

@@ -387,16 +387,13 @@
       this.id = void 0;
       this.$announcements = void 0;
       this.enteredAnotherElement = void 0;
-      const $input = this.$root.querySelector('input');
+      const $input = this.$root.querySelector('input[type="file"]');
       if ($input === null) {
         throw new ElementError({
           component: FileUpload,
           identifier: 'File inputs (`<input type="file">`)'
         });
       }
-      if ($input.type !== 'file') {
-        throw new ElementError(formatErrorMessage(FileUpload, 'File input (`<input type="file">`) attribute (`type`) is not `file`'));
-      }
       this.$input = $input;
       if (!this.$input.id) {
         throw new ElementError({

data/node_modules/govuk-frontend/dist/govuk/components/file-upload/file-upload.bundle.mjs

@@ -381,16 +381,13 @@ class FileUpload extends ConfigurableComponent {
     this.id = void 0;
     this.$announcements = void 0;
     this.enteredAnotherElement = void 0;
-    const $input = this.$root.querySelector('input');
+    const $input = this.$root.querySelector('input[type="file"]');
     if ($input === null) {
       throw new ElementError({
         component: FileUpload,
         identifier: 'File inputs (`<input type="file">`)'
       });
     }
-    if ($input.type !== 'file') {
-      throw new ElementError(formatErrorMessage(FileUpload, 'File input (`<input type="file">`) attribute (`type`) is not `file`'));
-    }
     this.$input = $input;
     if (!this.$input.id) {
       throw new ElementError({

data/node_modules/govuk-frontend/dist/govuk/components/file-upload/file-upload.mjs

@@ -1,6 +1,5 @@
 import { closestAttributeValue } from '../../common/closest-attribute-value.mjs';
 import { ConfigurableComponent } from '../../common/configuration.mjs';
-import { formatErrorMessage } from '../../common/index.mjs';
 import { ElementError } from '../../errors/index.mjs';
 import { I18n } from '../../i18n.mjs';
 
@@ -25,16 +24,13 @@ class FileUpload extends ConfigurableComponent {
     this.id = void 0;
     this.$announcements = void 0;
     this.enteredAnotherElement = void 0;
-    const $input = this.$root.querySelector('input');
+    const $input = this.$root.querySelector('input[type="file"]');
     if ($input === null) {
       throw new ElementError({
         component: FileUpload,
         identifier: 'File inputs (`<input type="file">`)'
       });
     }
-    if ($input.type !== 'file') {
-      throw new ElementError(formatErrorMessage(FileUpload, 'File input (`<input type="file">`) attribute (`type`) is not `file`'));
-    }
     this.$input = $input;
     if (!this.$input.id) {
       throw new ElementError({

data/node_modules/govuk-frontend/dist/govuk/components/footer/_mixin.scss

@@ -19,6 +19,12 @@
     border-top-color: base.govuk-functional-colour(brand);
     color: $govuk-footer-text;
     background: base.govuk-functional-colour(template-background);
+
+    @media print {
+      border-top-color: currentcolor;
+      color: base.govuk-functional-colour(text);
+      background-color: transparent;
+    }
   }
 
   .govuk-footer__crown {

data/node_modules/govuk-frontend/dist/govuk/components/generic-header/_generic-header.import.scss

@@ -0,0 +1,6 @@
+@use "../../settings/warnings--internal";
+
+@include warnings--internal.component-scss-file-warning("generic-header");
+
+@import "index";
+

data/node_modules/govuk-frontend/dist/govuk/components/generic-header/_index.import.scss

@@ -0,0 +1,8 @@
+@use "mixin";
+
+@import "../../base";
+
+@include govuk-exports("govuk/component/generic-header") {
+  @include mixin.styles;
+}
+

data/node_modules/govuk-frontend/dist/govuk/components/generic-header/_index.scss

@@ -0,0 +1,5 @@
+@use "../../custom-properties";
+@use "mixin";
+
+@include mixin.styles;
+

data/node_modules/govuk-frontend/dist/govuk/components/generic-header/_mixin.scss

@@ -0,0 +1,140 @@
+////
+/// @group components/generic-header
+////
+
+@use "../../base";
+
+/// Width of transparent bottom border of header.
+/// Set to provide a visual border in forced colour modes
+///
+/// @type Number
+/// @access private
+$header-forced-colour-border-width: 1px;
+
+/// Shared block header styles, with automatic background setting
+///
+/// @param {String} $background-colour - background colour of the header
+/// @param {String} $text-colour - text colour of the header
+/// @access private
+@mixin block-styles($background-colour: base.govuk-colour("black"), $text-colour: base.govuk-colour("white")) {
+  @include base.govuk-font($size: 16, $line-height: 1);
+
+  // Add a transparent bottom border for forced-colour modes
+  border-bottom: $header-forced-colour-border-width solid transparent;
+
+  --govuk-text-colour: #{$text-colour};
+  color: base.govuk-functional-colour(text);
+  background: $background-colour;
+
+  @media print {
+    border-bottom-width: 0;
+
+    --govuk-text-colour: inherit;
+    background: transparent;
+  }
+}
+
+/// Shared header full width container styles
+///
+/// @access private
+@mixin full-width-container-styles() {
+  padding: 0 base.$govuk-gutter-half;
+}
+
+/// Shared header logo container element styles, with automating padding setting
+///
+/// @param {String} $padding-top - top padding of logo container
+/// @param {String} $padding-bottom - bottom padding of logo container
+/// @access private
+@mixin logo-styles(
+  $padding-top: (
+    base.govuk-spacing(3)
+  ),
+  $padding-bottom: (
+    base.govuk-spacing(3)
+  )
+) {
+  padding-top: $padding-top;
+  padding-bottom: $padding-bottom;
+}
+
+/// Shared header logo link element styles
+///
+/// @access private
+@mixin link-styles {
+  // Avoid using the `base.govuk-link-common` mixin because the links in the
+  // header get a special treatment, because:
+  //
+  // - underlines are only visible on hover
+  // - all links get a 3px underline regardless of text size, as there are
+  //   multiple grouped elements close to one another and having slightly
+  //   different underline widths looks unbalanced
+  //
+  // Font size needs to be set on the link so that the box sizing is correct
+  // in Firefox
+  display: inline;
+  margin-right: base.govuk-spacing(2);
+  font-size: 30px; // We don't have a mixin that produces 30px font size
+  text-decoration: none;
+
+  @include base.govuk-link-style-text;
+
+  &:link,
+  &:visited {
+    text-decoration: none;
+  }
+
+  &:hover,
+  &:active {
+    // Negate the added border
+    $link-underline-thickness: 3px;
+    margin-bottom: $link-underline-thickness * -1;
+    border-bottom: $link-underline-thickness solid;
+  }
+
+  &:focus {
+    // Remove any borders that show when focused and hovered.
+    margin-bottom: 0;
+    border-bottom: 0;
+
+    @include base.govuk-focused-text;
+  }
+
+  @media print {
+    &:link,
+    &:visited {
+      color: base.govuk-functional-colour(text);
+    }
+
+    // Do not append link href to GOV.UK link when printing (e.g. '(/)')
+    &::after {
+      content: "";
+    }
+  }
+}
+
+/// @access private
+@mixin styles {
+  .govuk-generic-header {
+    @include block-styles;
+  }
+
+  .govuk-generic-header__container--full-width {
+    @include full-width-container-styles;
+  }
+
+  .govuk-generic-header__logo {
+    @include logo-styles;
+  }
+
+  .govuk-generic-header__homepage-link {
+    @include link-styles;
+
+    // Automatically centre align direct child elements to help users with
+    // positioning their logo assets eg: as `svg`s or `img`s
+    > * {
+      vertical-align: top;
+    }
+  }
+}
+