Add Nunjucks smartypants filter

alphagov · Aug 15, 2023 · 5aec229 · 5aec229
1 parent 968daec
commit 5aec229
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 0 deletions.
diff --git a/lib/nunjucks/filters.js b/lib/nunjucks/filters.js
@@ -1,5 +1,10 @@
+const { markedSmartypants } = require('marked-smartypants')
+const filters = require('nunjucks/src/filters')
 const slug = require('slug')
 
+// Marked extension for "smart" typographic punctuation
+const smartypants = markedSmartypants()
+
 /**
  * Format strings into kebab case but also
  * handles `errorMessage` → `error-message`
@@ -20,3 +25,13 @@ exports.kebabCase = function (string) {
 exports.slugify = function (string) {
   return slug(string, { lower: true })
 }
+
+/**
+ * Format strings with "smart" typographic punctuation
+ *
+ * @param {string} string - String to format
+ * @returns {string} Formatted string
+ */
+exports.smartypants = function (string) {
+  return filters.safe(smartypants.hooks.postprocess(string))
+}
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -71,6 +71,7 @@
     "jstransformer-marked": "^1.4.0",
     "jstransformer-nunjucks": "^1.2.0",
     "marked": "^7.0.2",
+    "marked-smartypants": "^1.0.5",
     "metalsmith": "^2.6.1",
     "metalsmith-canonical": "^1.2.0",
     "multimatch": "^6.0.0",