Prefer Marked slugger instance to slugger

Use the filter name `slugify` to match GOV.UK Frontend

lib/get-macro-options/index.js

@@ -1,7 +1,6 @@
 const { dirname, join } = require('path')
 
-const { marked } = require('marked')
-const slugger = require('slugger')
+const { Slugger, marked } = require('marked')
 
 // Get reference to marked.js
 const renderer = new marked.Renderer()
@@ -20,7 +19,7 @@ function addSlugs (option) {
   }
 
   // Add URL-safe slugs for hrefs and IDs
-  option.slug = slugger(option.name)
+  option.slug = new Slugger().slug(option.name)
 
   return option
 }

lib/metalsmith.js

@@ -8,9 +8,9 @@ const permalinks = require('@metalsmith/permalinks') // apply a permalink patter
 const postcss = require('@metalsmith/postcss')
 const sass = require('@metalsmith/sass') // convert Sass files to CSS using Dart Sass
 const { glob } = require('glob') // Match files using glob patterns
+const { Slugger } = require('marked') // generate slugs from titles
 const Metalsmith = require('metalsmith') // static site generator
 const canonical = require('metalsmith-canonical') // add a canonical url property to pages
-const slugger = require('slugger') // generate slugs from titles
 
 // Helpers and config
 const { paths, navigation: menuItems } = require('../config')
@@ -60,7 +60,7 @@ const nunjucksOptions = {
   },
 
   filters: {
-    slugger
+    slugify: (string) => new Slugger().slug(string)
   }
 }
 

package.json

@@ -82,7 +82,6 @@
     "serve-static": "^1.15.0",
     "sitemap": "^7.1.1",
     "slash": "^3.0.0",
-    "slugger": "^1.0.1",
     "standard": "^17.1.0",
     "stylelint": "^14.16.1",
     "stylelint-config-gds": "^0.3.0",

views/partials/_example.njk

@@ -15,7 +15,7 @@
 {% if params.id %}
   {% set exampleId = params.id %}
 {% else %}
-  {% set exampleId = (exampleTitle + " example") | slugger %}
+  {% set exampleId = (exampleTitle + " example") | slugify %}
 {% endif %}
 
 {% if params.open %}