govuk_tech_docs 6.4.0.beta → 6.5.0

data/lib/govuk_tech_docs/contribution_banner.rb

@@ -19,7 +19,8 @@ module GovukTechDocs
     end
 
     def report_issue_url
-      url = config[:source_urls]&.[](:report_issue_url)
+      url = config[:tech_docs][:source_urls]&.[](:report_issue_url)
+      url ||= config[:source_urls]&.[](:report_issue_url)
       params = {
         body: "Problem with '#{current_page.data.title}' (#{config[:tech_docs][:host]}#{current_page.url})",
       }
@@ -35,11 +36,22 @@ module GovukTechDocs
     end
 
     def repo_url
-      "https://github.com/#{config[:tech_docs][:github_repo]}"
+      github_repo = config[:tech_docs][:github_repo]
+      if github_repo.nil? || github_repo.empty?
+        raise ArgumentError, "github_repo value not found in config/tech-docs.yml"
+      end
+
+      repo_url = if github_repo.match?(%r{\Ahttps://github\.com/}i)
+                   github_repo
+                 else
+                   "https://github.com/#{github_repo}"
+                 end
+
+      repo_url.delete_suffix("/")
     end
 
     def repo_branch
-      config[:tech_docs][:github_branch] || "master" # TODO: change this to 'main' in a future breaking release
+      config[:tech_docs][:github_branch] || "master"
     end
 
   private

data/lib/govuk_tech_docs/version.rb

@@ -1,3 +1,3 @@
 module GovukTechDocs
-  VERSION = "6.4.0.beta".freeze
+  VERSION = "6.5.0".freeze
 end

data/lib/govuk_tech_docs/warning_text_extension.rb

@@ -5,8 +5,8 @@ module GovukTechDocs
     end
 
     helpers do
-      warn("This functionality is deprecated and will be removed in a future release. \n You should use the GOV.UK warning text component instead.")
       def warning_text(text)
+        warn("The `warning_text` function will be removed in version 7. You should use the GOV.UK warning text component instead.")
         <<~EOS
         <div class="govuk-warning-text">
           <span class="govuk-warning-text__icon" aria-hidden="true">!</span>

data/lib/govuk_tech_docs.rb

@@ -84,6 +84,7 @@ module GovukTechDocs
     context.activate :unique_identifier
     context.activate :warning_text
     context.activate :api_reference
+    context.activate :custom_method_missing_handler
 
     context.helpers do
       include GovukTechDocs::PathHelpers
@@ -164,9 +165,5 @@ module GovukTechDocs
     else
       context.ignore "search/*"
     end
-
-    if context.config[:tech_docs][:enable_govuk_components]
-      context.activate :custom_method_missing_handler
-    end
   end
 end

data/lib/source/layouts/_govuk_footer.erb

@@ -0,0 +1,9 @@
+<%=
+
+  govukFooter({
+    containerClasses: config[:tech_docs][:footerContainerClasses] ? config[:tech_docs][:footerContainerClasses] : "govuk-footer__container--full-width",
+    classes: config[:tech_docs][:footerClasses] ? config[:tech_docs][:footerClasses] : "",
+
+  })
+
+%>

data/lib/source/layouts/_govuk_header.erb

@@ -0,0 +1,17 @@
+<%
+  service_link = config[:tech_docs][:service_link]
+  homepage_url = service_link ? get_path_to_resource(config, service_link, current_page) : nil
+
+%>
+
+<%=
+
+govukHeader({
+  homepageUrl: homepage_url || "",
+  productName: config[:tech_docs][:product_name] ? config[:tech_docs][:product_name] : "",
+  containerClasses: config[:tech_docs][:headerContainerClasses] ? config[:tech_docs][:headerContainerClasses] : "govuk-header__container--full-width",
+  classes: config[:tech_docs][:headerClasses] ? config[:tech_docs][:headerClasses] : ""
+
+})
+
+%>

data/lib/source/layouts/_service_navigation.erb

@@ -1,24 +1,24 @@
-<div class="govuk-service-navigation app-pane__navigation" data-module="govuk-service-navigation">
-<div class="govuk-width-container">
-    <div class="govuk-service-navigation__container">
-      <nav aria-label="Menu" class="govuk-service-navigation__wrapper">
-        <button type="button" class="govuk-service-navigation__toggle govuk-js-service-navigation-toggle" aria-controls="navigation" hidden aria-hidden="true">
-          Menu
-        </button>
-        <ul class="govuk-service-navigation__list" id="navigation">
-          <% config[:tech_docs][:header_links].each do |title, path| %>
-            <li class="govuk-service-navigation__item <% if active_page(path) %> govuk-service-navigation__item--active<% end %>">
-              <a class="govuk-service-navigation__link" href="<%= get_path_to_resource config, path, current_page %>"<% if active_page(path) %> aria-current="page"<% end %>>
-              <% if active_page(path) %>
-                <strong class="govuk-service-navigation__active-fallback"><%= title %></strong>
-              <% else %>
-                <%= title %>
-              <% end %>
-              </a>
-            </li>
-          <% end %>
-        </ul>
-      </nav>
-    </div>
-  </div>
-</div>
+<%
+
+  navigation = []
+  config[:tech_docs][:header_links].each do |title, path|
+    url = get_path_to_resource config, path, current_page
+    navigation.append << {
+      href: url,
+      text: title,
+      active: active_page(path)
+    }
+  end
+
+%>
+
+
+<%=
+  govukServiceNavigation({
+       navigation: navigation,
+       serviceUrl: config[:tech_docs][:service_link] ,
+       serviceName: config[:tech_docs][:service_name],
+       navigationClasses: config[:tech_docs][:navigationContainerClasses] ? config[:tech_docs][:navigationContainerClasses] : "",
+       classes: config[:tech_docs][:navigationClasses] ? config[:tech_docs][:navigationClasses] : ""
+  })
+%>

data/lib/source/layouts/core.erb

@@ -50,9 +50,23 @@
 
   <body class="govuk-template__body">
     <script>document.body.className += ' js-enabled' + ('noModule' in HTMLScriptElement.prototype ? ' govuk-frontend-supported' : '');</script>
-    <header class="govuk-template__header app-header">
-      <%= partial 'layouts/header' %>
-    </header>
+  <!-- .app-header aligns the header component properly with the in page navigation   -->
+    <div class="app-header" role="banner" data-module="govuk-header">
+      <% if config[:tech_docs][:show_govuk_logo] %>
+         <%= partial 'layouts/govuk_header' %>
+      <% else %>
+        <%=
+          # if show govuk_logo is true we can just use the govuk component.
+          # If not we need to fall back temporarily to the old custom header to make sure we don't start
+          # showing logos everywhere, as there is no option in the component to turn it off.  This will be removed once the generic header and branding is in place.
+          # We will raise a deprecation warning to let people know this is imminent
+          warn("You have set show_govuk_logo to false or removed it from your config.  This setting wil be removed in version 7 to be replaced by the generic header and custom logo.  If you rely on this setting for custom code you should review this as soon as possible.")
+        %>
+        <%= partial 'layouts/header' %>
+      <% end %>
+
+    </div>
+
     <% if config[:tech_docs][:header_links] %>
         <%= partial 'layouts/service_navigation' %>
     <% end %>
@@ -102,9 +116,12 @@
         </div>
       </div>
 
-
     <footer class="govuk-template__footer">
-      <%= partial "layouts/footer" %>
+      <% if config[:tech_docs][:show_govuk_logo] %>
+        <%= partial "layouts/govuk_footer" %>
+      <% else %>
+        <%= partial "layouts/footer" %>
+      <% end %>
     </footer>
 
     <%= partial 'layouts/analytics' %>

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.4.0';
+  const version = '6.5.1';
 
   function getBreakpoint(name) {
     const property = `--govuk-breakpoint-${name}`;

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

@@ -1,4 +1,4 @@
-const version = '6.4.0';
+const version = '6.5.1';
 
 function getBreakpoint(name) {
   const property = `--govuk-breakpoint-${name}`;

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

@@ -1,4 +1,4 @@
-const version = '6.4.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,6 +10,7 @@
 @import "error-message";
 @import "error-summary";
 @import "exit-this-page";
+@import "feedback";
 @import "fieldset";
 @import "file-upload";
 @import "footer";
@@ -19,6 +20,7 @@
 @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,6 +10,7 @@
 @use "error-message";
 @use "error-summary";
 @use "exit-this-page";
+@use "feedback";
 @use "fieldset";
 @use "file-upload";
 @use "footer";
@@ -19,6 +20,7 @@
 @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/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/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/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/language-navigation/_index.import.scss

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

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

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

data/node_modules/govuk-frontend/dist/govuk/components/language-navigation/_language-navigation.import.scss

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

data/node_modules/govuk-frontend/dist/govuk/components/language-navigation/_mixin.scss

@@ -0,0 +1,68 @@
+@use "../../base";
+
+/// @access private
+@mixin styles {
+  .govuk-language-navigation {
+    @include base.govuk-font($size: 19);
+
+    @include base.govuk-responsive-margin(6, "bottom");
+    color: base.govuk-functional-colour(text);
+  }
+
+  .govuk-language-navigation__list {
+    display: inline-flex;
+    flex-wrap: wrap;
+    row-gap: base.govuk-spacing(2);
+    margin: 0;
+    padding: 0;
+    list-style-type: none;
+  }
+
+  .govuk-language-navigation__list-item {
+    display: flex;
+    align-items: center;
+
+    &:not(:last-child) {
+      &::after {
+        content: "";
+        display: block;
+        height: 1em;
+        margin-right: base.govuk-spacing(2);
+        margin-left: base.govuk-spacing(2);
+        border-right: 1px solid;
+        border-right-color: base.govuk-functional-colour(border);
+      }
+    }
+  }
+
+  .govuk-language-navigation__link {
+    @include base.govuk-link-common;
+    @include base.govuk-link-style-default;
+  }
+
+  .govuk-language-navigation--inverse {
+    color: base.govuk-functional-colour(inverse-text);
+
+    .govuk-language-navigation__link {
+      @include base.govuk-link-style-inverse;
+    }
+
+    .govuk-language-navigation__list-item::after {
+      border-right-color: currentcolor;
+    }
+  }
+
+  // Ensure the Language navigation has enough
+  // spacing with the rest of the Service Navigation
+  .govuk-service-navigation .govuk-language-navigation {
+    // Slightly smaller margin because the Service Navigation's menu toggle
+    // has a little margin underneath it already.
+    margin-top: base.govuk-spacing(1);
+    margin-bottom: base.govuk-spacing(3);
+
+    @media #{base.govuk-from-breakpoint(tablet)} {
+      margin-top: base.govuk-spacing(3);
+    }
+  }
+}
+

data/node_modules/govuk-frontend/dist/govuk/components/service-navigation/_mixin.scss

@@ -20,6 +20,28 @@
     --govuk-text-colour: #{$govuk-service-navigation-text-colour};
     color: base.govuk-functional-colour(text);
     background-color: $govuk-service-navigation-background;
+
+    @media print {
+      border-bottom-color: currentcolor;
+      background-color: transparent;
+    }
+  }
+
+  .govuk-service-navigation__inlining-container {
+    display: flex;
+    flex-wrap: wrap;
+    align-items: baseline;
+
+    .govuk-service-navigation__container {
+      // Expand the container to shift the `end` slot to the right
+      flex-grow: 1;
+
+      // Ensure some space between the `end` slot and the container
+      // when displayed inline
+      &:not(:last-child) {
+        margin-right: base.govuk-spacing(6);
+      }
+    }
   }
 
   .govuk-service-navigation__container {
@@ -27,9 +49,16 @@
     flex-direction: column;
     align-items: start;
 
+    // Avoid the end slot rendering on the right of the container
+    // in small viewports by ensuring the container is full width
+    @media #{base.govuk-until-breakpoint(tablet)} {
+      width: 100%;
+    }
+
     @media #{base.govuk-from-breakpoint(tablet)} {
       flex-direction: row;
       flex-wrap: wrap;
+      align-items: center;
     }
   }
 
@@ -65,6 +94,10 @@
         @include base.govuk-responsive-margin(6, $direction: right);
       }
     }
+
+    @media print {
+      border-color: currentcolor;
+    }
   }
 
   // Remove the top margin of the first nav item if there is a service name but
@@ -207,10 +240,19 @@
     --govuk-text-colour: #{base.govuk-functional-colour(inverse-text)};
     background-color: base.govuk-functional-colour(brand);
 
+    @media print {
+      --govuk-text-colour: #{base.govuk-functional-colour(print-text)};
+      background-color: transparent;
+    }
+
     .govuk-width-container {
       border-width: 1px 0;
       border-style: solid;
       border-color: $govuk-service-navigation-border-colour;
+
+      @media print {
+        border-color: currentcolor;
+      }
     }
 
     // Subtract 1px of space to account for the extra border-top
@@ -224,9 +266,12 @@
       border-color: currentcolor;
     }
 
-    // Override link styles
-    .govuk-service-navigation__link {
-      @include base.govuk-link-style-text;
+    // Override link styles if on screens
+    // In print, we want the normal link styles to still apply
+    @media not print {
+      .govuk-service-navigation__link {
+        @include base.govuk-link-style-text;
+      }
     }
 
     // Override mobile menu toggle colour when not focused

data/node_modules/govuk-frontend/dist/govuk/custom-properties/_frontend-version.mixin.scss

@@ -7,7 +7,7 @@
   // `$govuk-output-custom-properties` is true or not to help with checking if
   // multiple stylesheets are outputting the same version
   :root {
-    --govuk-frontend-version: "6.4.0";
+    --govuk-frontend-version: "6.5.1";
   }
 }