govuk_tech_docs 6.2.4 → 6.3.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74dc4c44fa70d8f29bb050007da7bfc8740e690f3dda8b4220fc1cbf6246d08d
-  data.tar.gz: 972e4b78381b8a0d07384fd65dc8a40889b56458d31e3bfca60098a053e5b794
+  metadata.gz: 4749230e0456525bafbee2e00579a1b1170ce58c40d33a5c00672e6d1f14e61a
+  data.tar.gz: fad8867ac7acfc14d5e46108dbf592705c3d527a679474f9dc421b36648d196e
 SHA512:
-  metadata.gz: c9289ca8f68a4b0327d71355929f319dea91d1a8a72dcbb10a7190a51e6cf59f06ed5df79ed7acf3efa7989c180c29c43727931e64b8045741df4a6fa7b25495
-  data.tar.gz: 7e02307c317a55e7075c71d537fa0e11c60c7250af9c6851f2e45e6068cb8f8fde3236f9202811049e557047c078a5bd9a48e324ff6f19ae57ae651b4f556dae
+  metadata.gz: b38a0ea5499072b25c6500ef301958482189bd65a33766158061a8dc4c8af6625095d5ff807d28b2bd50610068c9f27d6dd845c45b070574a39abce5a346ddc2
+  data.tar.gz: a0d16ce398a23cfa9ee149ee2993522d13e72754931fe480e518f4ef8ee3bbee44c26eedc17c7e93c116705f077061b81a97be0746b1da53b66378dc28b12352

data/.github/workflows/dependency-review.yaml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: 'Checkout Repository'
-        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
       - name: 'Dependency Review'
         uses: actions/dependency-review-action@a1d282b36b6f3519aa1f3fc636f609c47dddb294 #5.0.0
         with:

data/.github/workflows/publish.yaml

@@ -16,7 +16,7 @@ jobs:
       go: ${{ steps.gem_version.outputs.new_version }}
 
     steps:
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
         with:
           show-progress: false
 
@@ -48,7 +48,7 @@ jobs:
     if: needs.pre.outputs.go == 'true'
 
     steps:
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
         with:
           show-progress: false
 

data/.github/workflows/test.yaml

@@ -22,7 +22,7 @@ jobs:
         ruby: ['3.3', '3.4', '4.0']
 
     steps:
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
         with:
           show-progress: false
 

data/.rubocop.yml

@@ -3,7 +3,7 @@ inherit_gem:
     - config/default.yml
 
 AllCops:
-  TargetRubyVersion: 3.1
+  TargetRubyVersion: 3.3.0
 
 Layout/HeredocIndentation:
   Enabled: false
@@ -13,3 +13,7 @@ Naming/HeredocDelimiterNaming:
 
 Lint/NestedMethodDefinition:
   Enabled: false
+
+Lint/MissingSuper:
+  Exclude:
+    - 'lib/tasks/**/*'

data/.vale.ini

@@ -0,0 +1,10 @@
+StylesPath = styles
+Packages = https://github.com/alphagov/tech-docs-linter/releases/latest/download/tech-writing-style-guide.zip
+SkippedScopes = pre, code, script, style
+MinAlertLevel = suggestion
+[*.{md,org,txt,erb,html}]
+
+BasedOnStyles = tech-writing-style-guide
+TokenIgnores = `[^`]+`
+
+; full docs about vale.ini options are at https://vale.sh/docs/vale-ini

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 6.3.0.beta
+
+- Add `exe/tech_docs_jobs` to allow executable `Rake` commands
+- Add `rake task` for style guide linting
+- Add `lib/tasks/helpers/linter_report.rb` and `lib/tasks/helpers/vale_report.rb` for formatting output
+- Add `.vale.ini` to include [`tech-docs-linter`](https://github.com/alphagov/tech-docs-linter/tree/main#rules) rules
+- Update `README.md`
+
 ## 6.2.4
 
 - Support non-JSON response content types in OpenAPI renderer.

data/README.md

@@ -1,9 +1,11 @@
 # Tech Docs Template - gem
 
-This repo contains the Ruby gem that distributes the [Tech Docs Template][tdt-template]. The Tech Docs Template is a [middleman template][mmt] that
+This repo contains the Ruby gem that distributes the [Tech Docs Template][tdt-template]. The Tech Docs Template is
+a [middleman template][mmt] that
 you can use to build technical documentation using a GOV.UK style.
 
-To find out more about setting up and managing content for a website using this template, see the [Tech Docs Template documentation][tdt-docs].
+To find out more about setting up and managing content for a website using this template, see
+the [Tech Docs Template documentation][tdt-docs].
 
 ## Contributing
 
@@ -11,17 +13,54 @@ Everybody who uses this project is encouraged to contribute.
 
 Find out how to [contribute](https://tdt-documentation.london.cloudapps.digital/support/#contribute).
 
+## Rake tasks
+
+This gem contains `Rake` tasks that you can use to run the linter against your middleman build. To list the available
+jobs you can run the command:
+
+```shell
+bundle exec tech_docs_jobs -T
+```
+
+### Tech-docs-linter
+
+The `tech-docs-linter` is a set of `Vale` linting rules which can help you check your content meets the gov.uk style
+guide. To find out more about the linter visit the [GitHub repository](https://github.com/alphagov/tech-docs-linter).
+`Vale` is designed to evaluate written content, and does not recommend auto-fixing. You should review the output report
+and manually resolve alerts where appropriate.
+
+The `vale:lint` task returns a 0 exit code unless there is an `Exception`.  This allows you to run the linter without interrupting your `CI/CD workflows`.
+
+You can run the linting task from your project root with the command:
+
+```shell
+bundle exec tech_docs_jobs lint:vale
+```
+
+The linting job can take the following optional parameters:
+
+| Name          | Definition                                                                                  | Default   |
+|---------------|---------------------------------------------------------------------------------------------|-----------|
+| `target`      | Directory of your middleman build, relative to the root of your project.                    | './build' |
+| `clean_build` | If true runs `bundle exec middleman build` to create a clean build.                         | 'true'    |
+| `full_output` | If true the full report is printed to the console, otherwise only the summary is displayed. | 'true'    |
+
 ## GOV.UK frontend
 
-This gem uses [GOV.UK Frontend](https://github.com/alphagov/govuk-frontend), part of the [GOV.UK Design System](https://design-system.service.gov.uk/).
+This gem uses [GOV.UK Frontend](https://github.com/alphagov/govuk-frontend), part of
+the [GOV.UK Design System](https://design-system.service.gov.uk/).
 
-This gem can also use [GOV.UK Design System nunjucks components](https://design-system.service.gov.uk/components/).  It is recommended that you use these as they are user researched and accessibility tested.  An example using the `govukButton` component is available in the [example site in this gem](./example/source/index.html.md.erb).
+This gem can also use [GOV.UK Design System nunjucks components](https://design-system.service.gov.uk/components/). It
+is recommended that you use these as they are user researched and accessibility tested. An example using the
+`govukButton` component is available in the [example site in this gem](./example/source/index.html.md.erb).
 
-We use `npm` to download the govuk-frontend package. To update to a new version, change the version in the [package.json file](package.json) and run `npm update`.
+We use `npm` to download the govuk-frontend package. To update to a new version, change the version in
+the [package.json file](package.json) and run `npm update`.
 
 ## Table of contents helper functions
 
-With `Middleman` you can apply layouts to group pages and customise sites. This gem has the following additional helper functions to manage the table of contents (ToC):
+With `Middleman` you can apply layouts to group pages and customise sites. This gem has the following additional helper
+functions to manage the table of contents (ToC):
 
 - `single_page_table_of_contents` to create a ToC from the headings on the current page
 - `multi_page_table_of_contents` to create a ToC for a group of pages, opened at the current page
@@ -48,7 +87,7 @@ end
 %>
 ```
 
-This example will create a ToC containing the current page title, and nested headings to a depth of 2. 
+This example will create a ToC containing the current page title, and nested headings to a depth of 2.
 
 ### Multi page table of contents
 
@@ -73,7 +112,10 @@ wrap_layout :core do
 end
 %>
 ```
-This example will create a ToC containing the page title of each resource, as a heading.  Each heading can be expanded to show nested headings to the depth defined in the site config.  If `include_child_resources` is set to `true`, child resources will also be included.
+
+This example will create a ToC containing the page title of each resource, as a heading. Each heading can be expanded to
+show nested headings to the depth defined in the site config. If `include_child_resources` is set to `true`, child
+resources will also be included.
 
 ## Developing locally
 
@@ -90,9 +132,11 @@ To see how your changes to the gem affect your website, point your website's Gem
 gem 'govuk_tech_docs', path: '../tech-docs-gem'
 ```
 
-To preview your documentation changes locally, see the [Tech Docs Template documentation on previewing your documentation](https://tdt-documentation.london.cloudapps.digital/create_project/preview/#preview-your-documentation).
+To preview your documentation changes locally, see
+the [Tech Docs Template documentation on previewing your documentation](https://tdt-documentation.london.cloudapps.digital/create_project/preview/#preview-your-documentation).
 
-If you experience [the FFI gem issue for Mojave users](https://github.com/alphagov/tech-docs-gem/issues/254), you should refer to this [list of possible fixes](#issue-with-ffi-on-osx-mohave).
+If you experience [the FFI gem issue for Mojave users](https://github.com/alphagov/tech-docs-gem/issues/254), you should
+refer to this [list of possible fixes](#issue-with-ffi-on-osx-mohave).
 
 ### Use the example in this repo
 
@@ -106,20 +150,45 @@ bundle exec middleman server
 
 See your website on `http://localhost:4567` in your browser.
 
-If you experience [the FFI gem issue for Mojave users](https://github.com/alphagov/tech-docs-gem/issues/254), you should refer to this [list of possible fixes](#issue-with-ffi-on-osx-mohave).
+If you experience [the FFI gem issue for Mojave users](https://github.com/alphagov/tech-docs-gem/issues/254), you should
+refer to this [list of possible fixes](#issue-with-ffi-on-osx-mohave).
 
-For more information on previewing your documentation locally, see the [Tech Docs template documentation on previewing your documentation](https://tdt-documentation.london.cloudapps.digital/create_project/preview/#preview-your-documentation).
+For more information on previewing your documentation locally, see
+the [Tech Docs template documentation on previewing your documentation](https://tdt-documentation.london.cloudapps.digital/create_project/preview/#preview-your-documentation).
 
 ## Tests
 
-Use this command to run the linting and tests for the Ruby and JavaScript code:
+### Ruby tests and linting
+
+You can run the Ruby test suite with the following command:
+
+```shell
+bundle exec rspec
+```
+
+To test a specific file include the filepath after `rspec`.
+
+You can lint the ruby code with the command:
+
+```shell
+bundle exec rubocop
+```
+
+Rubocop can automatically fix some linting issues. If the above command has suggestions that you automatically fix them
+with:
+
+```shell
+bundle exec rubocop -a 
+```
+
+### JavaScript tests and linting
+
+Use this command to run the linting and tests for the JavaScript code:
 
 ```sh
 bundle exec rake
 ```
 
-### JavaScript tests
-
 The JavaScript tests use the [Jasmine test framework][jas].
 
 You can run these tests on their own and see the results in your browser.
@@ -140,28 +209,38 @@ Users on OSX Mojave (10.14) may get this error when running `bundle exec middlem
 There are 3 possible ways to solve this. From best to worst, you can:
 
 * upgrade to macOS 10.15 (Catalina) or higher
-* tell rubygems not to use the system ffi by running `gem install ffi -- --disable-system-libffi` in the command line when the error shows
+* tell rubygems not to use the system ffi by running `gem install ffi -- --disable-system-libffi` in the command line
+when the error shows
 * pin the ffi version back to 1.12.2 by editing the Gemfile of your app
 
 ## Releasing new versions
 
-To release a new version, create a new pull request (PR) that updates [version.rb](lib/govuk_tech_docs/version.rb) and [CHANGELOG.md](CHANGELOG.md).
+To release a new version, create a new pull request (PR) that updates [version.rb](lib/govuk_tech_docs/version.rb)
+and [CHANGELOG.md](CHANGELOG.md).
 
-Do not include other changes in your pull request, as this makes it easier to find out what was released when. See an example of a [PR for releasing a new version](https://github.com/alphagov/tech-docs-gem/pull/15).
+Do not include other changes in your pull request, as this makes it easier to find out what was released when. See an
+example of a [PR for releasing a new version](https://github.com/alphagov/tech-docs-gem/pull/15).
 
 Travis will automatically release a [new version to Rubygems.org](https://rubygems.org/gems/govuk_tech_docs).
 
 ## Licence
 
-Unless stated otherwise, the codebase is released under [the MIT License][mit]. This covers both the codebase and any sample code in the documentation.
+Unless stated otherwise, the codebase is released under [the MIT License][mit]. This covers both the codebase and any
+sample code in the documentation.
 
-The documentation is [© Crown copyright][copyright] and available under the terms of the [Open Government 3.0][ogl] licence.
+The documentation is [© Crown copyright][copyright] and available under the terms of the [Open Government 3.0][ogl]
+licence.
 
 [mit]: LICENCE
+
 [copyright]: http://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/crown-copyright/
+
 [ogl]: http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/
+
 [tdt-docs]: https://github.com/alphagov/tdt-documentation/
+
 [tdt-template]: https://github.com/alphagov/tech-docs-template
+
 [mmt]: https://middlemanapp.com/advanced/project_templates/
 
 [jas]: https://jasmine.github.io/

data/example/source/child-of-expired-page.html.md

@@ -5,4 +5,4 @@ parent: /expired-page.html
 
 # This is a child of expired page
 
-Expired page should highlight in the navigation.
+Expired page should highlight in the navigation.

data/exe/tech_docs_jobs

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+require "rake"
+
+Rake.application.init
+
+Dir.glob(File.join(__dir__, "../lib/tasks/*.rake")).each { |r| load r }
+
+Rake.application.top_level

data/lib/govuk_tech_docs/version.rb

@@ -1,3 +1,3 @@
 module GovukTechDocs
-  VERSION = "6.2.4".freeze
+  VERSION = "6.3.0.beta".freeze
 end

data/lib/govuk_tech_docs/warning_text_extension.rb

@@ -5,6 +5,7 @@ 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)
         <<~EOS
         <div class="govuk-warning-text">

data/lib/tasks/helpers/linter_report.rb

@@ -0,0 +1,49 @@
+class LinterReport
+  attr_accessor :linter_raw_output, :linter_summary_report, :linter_full_report
+
+  def initialize(raw_output)
+    puts "#{self.class} initialized."
+    @linter_raw_output = raw_output
+  end
+
+  def format_linter_output
+    raise NotImplementedError, "Subclass must implement #format_linter_output"
+  end
+
+  def get_raw_output
+    raise "No raw output available.  Check you have run the linter task correctly" unless @linter_raw_output
+
+    @linter_raw_output
+  end
+
+  def set_linter_summary_report
+    raise "Subclass must implement #set_linter_summary_report"
+  end
+
+  def get_linter_summary_report
+    raise "No output summary available.  Check you have called set_linter_summary_report" unless @linter_summary_report
+
+    @linter_summary_report
+  end
+
+  def set_linter_full_report
+    raise "Subclass must implement #set_linter_full_report"
+  end
+
+  def get_linter_full_report
+    raise "No output detail available.  Check you have called set_linter_full_report" unless @linter_full_report
+
+    @linter_full_report
+  end
+
+protected
+
+  def set_output_text_color(text, severity)
+    case severity.downcase
+    when "error" then "\e[31m#{text}\e[0m" # Red
+    when "warning" then "\e[33m#{text}\e[0m" # Yellow
+    when "suggestion" then "\e[34m#{text}\e[0m" # Blue
+    else "\e[36m#{text}\e[0m" # Cyan
+    end
+  end
+end

data/lib/tasks/helpers/rake_utils.rb

@@ -0,0 +1,7 @@
+def get_gem_root
+  Gem::Specification.find_by_name("govuk_tech_docs").gem_dir
+end
+
+def vale_config_path
+  File.join(get_gem_root, ".vale.ini")
+end

data/lib/tasks/helpers/vale_report.rb

@@ -0,0 +1,156 @@
+require_relative "./linter_report"
+require "json"
+
+class ValeLinterReport < LinterReport
+  attr_accessor :table_rows, :linter_severity_totals, :table_column_widths, :formatter, :linter_summary_report_json, :linter_full_report_json
+
+  def format_linter_output
+    if @linter_raw_output.strip.empty?
+      @table_rows = []
+      @linter_severity_totals = { "error" => 0, "warning" => 0, "suggestion" => 0 }
+    else
+      set_table_rows
+      set_linter_severity_totals_from_rows
+    end
+
+    set_linter_full_report
+    set_linter_summary_report
+    set_linter_summary_report_json
+  end
+
+  def set_linter_full_report
+    add_formatted_rows_to_detail_output
+  end
+
+  def set_linter_summary_report
+    if @linter_severity_totals.nil?
+      set_linter_severity_totals_from_rows
+    end
+
+    error = @linter_severity_totals["error"]
+    warning = @linter_severity_totals["warning"]
+    suggestion = @linter_severity_totals["suggestion"]
+
+    @linter_summary_report = []
+
+    @linter_summary_report << "\n#{'=' * [0, 40].max}"
+    @linter_summary_report << "\e[1m Vale summary\e[0m"
+    @linter_summary_report << "-" * [0, 40].max
+    @linter_summary_report << "  Errors:      #{error.positive? ? set_output_text_color(error, 'error') : error}"
+    @linter_summary_report << "  Warnings:    #{warning.positive? ? set_output_text_color(warning, 'warning') : warning}"
+    @linter_summary_report << "  Suggestions: #{suggestion.positive? ? set_output_text_color(suggestion, 'suggestion') : suggestion}"
+    @linter_summary_report << "-" * [0, 40].max
+    @linter_summary_report.join("\n")
+  end
+
+  def set_linter_summary_report_json
+    if @linter_severity_totals.nil?
+      set_linter_severity_totals_from_rows
+    end
+    @linter_summary_report_json = JSON.generate(@linter_severity_totals)
+  end
+
+private
+
+  def set_table_column_widths
+    if @table_rows.nil?
+      set_table_rows
+    end
+
+    @table_column_widths = %i[file line severity message rule].each_with_object({}) do |col, acc|
+      all_values = @table_rows.map { |row| row[col].to_s }
+      acc[col] = [col.to_s.length, *all_values.map(&:length)].max
+    end
+  end
+
+  def set_table_formatter
+    if @table_column_widths.nil?
+      set_table_column_widths
+    end
+    @formatter = "%-#{@table_column_widths[:file]}s | %-#{@table_column_widths[:line]}s | %-#{@table_column_widths[:severity]}s | %-#{@table_column_widths[:message]}s | %-#{@table_column_widths[:rule]}s"
+  end
+
+  def add_formatted_header_to_detail_output
+    if @linter_full_report.nil?
+      @linter_full_report = []
+    end
+
+    header = sprintf(@formatter, "File", "Line", "Severity", "Message", "Rule")
+    @linter_full_report << "\e[1m🔍 Vale Style Linting Report\e[0m\n\n"
+    @linter_full_report << "\e[1m#{header}\e[0m"
+    @linter_full_report << "-" * header.gsub(/\e\[[0-9;]*m/, "").length
+  end
+
+  def add_formatted_rows_to_detail_output
+    set_table_column_widths
+    set_table_formatter
+    add_formatted_header_to_detail_output
+
+    @table_rows.each do |row|
+      @linter_full_report << format_row(row)
+    end
+    @linter_full_report.join("\n")
+  end
+
+  def set_linter_severity_totals_from_rows
+    if @table_rows.nil?
+      set_table_rows
+    end
+
+    default_totals = { "error" => 0, "warning" => 0, "suggestion" => 0 }
+
+    @linter_severity_totals = default_totals.merge(
+      @table_rows
+        .map { |r| r[:severity] }
+        .compact # drops any actual nils
+        .tally,
+    )
+  end
+
+  def format_row(row)
+    colored_severity = set_output_text_color(row[:severity].upcase, row[:severity])
+    severity_padding = " " * (@table_column_widths[:severity] - row[:severity].length)
+    padded_severity = "#{colored_severity}#{severity_padding}"
+
+    sprintf(
+      @formatter,
+      row[:file], row[:line], padded_severity, row[:message], row[:rule]
+    )
+  end
+
+  def set_table_rows
+    begin
+      rows_json = JSON.parse(@linter_raw_output)
+    rescue JSON::ParserError
+      puts "\e[Error parsing Vale payload:\e[0m\n#{@linter_raw_output}"
+      exit 1
+    end
+
+    unique_rows = []
+
+    rows_json.each do |file_path, alerts|
+      next if alerts.empty?
+
+      seen_messages = Set.new
+
+      alerts.each do |alert|
+        msg = alert["Message"]
+        # Vale will hilghlight every instance of an infraction, sometimes this is unhelpful.  For example the acronyms rule needs to highlight an acronym is not defined in the first use
+        # it does not need to then point out every single time it is referenced in the document, so we check for itentical messages for specific rules
+        if seen_messages.include?(msg) && alert["Check"].downcase == "tech-writing-style-guide.acronyms"
+          next
+        end
+
+        seen_messages.add(msg)
+        unique_rows << {
+          file: file_path,
+          line: alert["Line"].to_s,
+          severity: alert["Severity"],
+          message: msg,
+          rule: alert["Check"],
+        }
+      end
+    end
+    @table_rows = unique_rows
+  end
+end

data/lib/tasks/lint.rake

@@ -0,0 +1,33 @@
+# Rakefile
+require "json"
+require "open3"
+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."
+  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}'"
+
+    if args.clean_build == "true"
+      Rake::Task["middleman:build"].invoke
+    end
+
+    stdout, = Open3.capture3("vale --config='#{vale_config_path}' --output=JSON #{args.target}")
+
+    linter_report = ValeLinterReport.new(stdout)
+    linter_report.format_linter_output
+    if args.full_output == "true"
+      puts linter_report.get_linter_full_report
+    end
+    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
+end

data/lib/tasks/middleman.rake

@@ -0,0 +1,10 @@
+namespace :middleman do
+  desc "Delete build directory and run bundle exec middleman build"
+  task :build do
+    if Dir.exist?("./build")
+      puts "Target directory found at ./build.  Removing old build."
+      FileUtils.rm_rf("./build")
+    end
+    sh "bundle exec middleman build"
+  end
+end

data/package-lock.json

@@ -12,7 +12,7 @@
       },
       "devDependencies": {
         "jasmine-browser-runner": "^4.0.0",
-        "jasmine-core": "^6.0.0",
+        "jasmine-core": "^6.3.0",
         "standard": "^17.0.0"
       }
     },
@@ -2992,9 +2992,9 @@
       }
     },
     "node_modules/jasmine-core": {
-      "version": "6.2.0",
-      "resolved": "https://registry.npmjs.org/jasmine-core/-/jasmine-core-6.2.0.tgz",
-      "integrity": "sha512-b16WZG/pFEFj8qRW1ss7nDuNGYz9ji8BDGj7fJNrROauk5rj/diO3KPOuyIpcgUChdC+c0PfQ8iUk4nHE+EN4w==",
+      "version": "6.3.0",
+      "resolved": "https://registry.npmjs.org/jasmine-core/-/jasmine-core-6.3.0.tgz",
+      "integrity": "sha512-eMm5qBovNjNoGOcgE/W207+wrcK5zrQv0Rg/rWGboUJUmZp0dFCpHTyjpuDAfCwRCqg7f9U2q2jtv/aUuzdCQg==",
       "dev": true,
       "license": "MIT"
     },

data/package.json

@@ -13,7 +13,7 @@
   },
   "devDependencies": {
     "jasmine-browser-runner": "^4.0.0",
-    "jasmine-core": "^6.0.0",
+    "jasmine-core": "^6.3.0",
     "standard": "^17.0.0"
   },
   "standard": {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_tech_docs
 version: !ruby/object:Gem::Version
-  version: 6.2.4
+  version: 6.3.0.beta
 platform: ruby
 authors:
 - Government Digital Service
@@ -383,7 +383,8 @@ description: Gem to distribute the GOV.UK Tech Docs Template. See https://github
   for the project.
 email:
 - govuk-dev@digital.cabinet-office.gov.uk
-executables: []
+executables:
+- tech_docs_jobs
 extensions: []
 extra_rdoc_files: []
 files:
@@ -402,6 +403,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
+- ".vale.ini"
 - CHANGELOG.md
 - Gemfile
 - LICENCE
@@ -440,6 +442,7 @@ files:
 - example/source/stylesheets/screen-old-ie.css.scss
 - example/source/stylesheets/screen.css.scss
 - example/source/templates/proxy_template.html.md
+- exe/tech_docs_jobs
 - govuk_tech_docs.gemspec
 - lib/assets/javascripts/_analytics.js
 - lib/assets/javascripts/_govuk/modules.js
@@ -525,6 +528,11 @@ files:
 - lib/source/layouts/layout.erb
 - lib/source/search/index.html.erb
 - lib/source/stylesheets/manifest.css
+- lib/tasks/helpers/linter_report.rb
+- lib/tasks/helpers/rake_utils.rb
+- lib/tasks/helpers/vale_report.rb
+- lib/tasks/lint.rake
+- lib/tasks/middleman.rake
 - node_modules/govuk-frontend/dist/govuk-prototype-kit/init.js
 - node_modules/govuk-frontend/dist/govuk-prototype-kit/init.scss
 - node_modules/govuk-frontend/dist/govuk/_base.scss