@x-govuk/govuk-eleventy-plugin 5.0.4 → 5.0.6

package/README.md

@@ -4,16 +4,16 @@ Build documentation websites using Markdown and GOV.UK styles.
 
 You’re welcome to use the plugin even if your service isn’t considered part of GOV.UK, but your site or service must not:
 
-* identify itself as being part of GOV.UK
-* use the crown or GOV.UK logotype in the header
-* use the GDS Transport typeface
-* suggest that it’s an official UK government website if it’s not
+- identify itself as being part of GOV.UK
+- use the crown or GOV.UK logotype in the header
+- use the GDS Transport typeface
+- suggest that it’s an official UK government website if it’s not
 
 ## Requirements
 
-* [Node.js](https://nodejs.org) v16.0.0 or above
-* [npm CLI](https://docs.npmjs.com/cli) v8.0.0 or above
-* [Eleventy](https://www.11ty.dev) v2.0.0 or above
+- [Node.js](https://nodejs.org) v16.0.0 or above
+- [npm CLI](https://docs.npmjs.com/cli) v8.0.0 or above
+- [Eleventy](https://www.11ty.dev) v2.0.0 or above
 
 ## Installation
 
@@ -30,3 +30,12 @@ eleventyConfig.addPlugin(govukEleventyPlugin, {
 ```
 
 Learn more about how to [get started](https://x-govuk.github.io/govuk-eleventy-plugin/get-started/) and which [options you can provide](https://x-govuk.github.io/govuk-eleventy-plugin/options/).
+
+## Releasing a new version
+
+`npm run release`
+
+This command will ask you what version you want to use. It will then publish a new version on NPM, create and push a new git tag and then generate release notes ready for posting on GitHub.
+
+> ![NOTE]
+> Releasing a new version requires permission to publish packages to the `@x-govuk` organisation.

package/components/document-header/template.njk

@@ -38,8 +38,7 @@
       {%- if params.tags | length > 0 -%}
         <span aria-hidden="true">&ensp;•&ensp;</span>Tags:
         {%- for tag in params.tags %}
-          {% set item = params.tagPages | includes("data.tag", tag) | first %}
-          <a href="{{ item.url }}" class="govuk-link">{{ item.data.tag }}</a>
+          <a href="/tags/{{ tag | slug }}" class="govuk-link">{{ tag }}</a>
           {%- if not loop.last %}, {% endif %}
         {%- endfor -%}
       {%- endif -%}

package/components/link/_link.scss

@@ -13,7 +13,7 @@
     font-variant: all-small-caps;
     font-weight: normal;
     margin-left: govuk-spacing(1);
-    opacity: .5;
+    opacity: 0.5;
   }
 }
 

package/components/prose-scope/_prose-scope.scss

@@ -34,11 +34,11 @@
   }
 
   sup {
-    top: -.4em;
+    top: -0.4em;
   }
 
   sub {
-    bottom: -.4em;
+    bottom: -0.4em;
   }
 
   img {
@@ -56,7 +56,7 @@
     // Show outline around linked images within figures
     img {
       display: block;
-      outline: 1px solid rgba($govuk-border-colour, .5);
+      outline: 1px solid rgba($govuk-border-colour, 0.5);
     }
 
     > .govuk-link img {

package/components/site-search/_site-search.scss

@@ -115,7 +115,7 @@ $icon-size: 40px;
 }
 
 .app-site-search__menu--overlay {
-  box-shadow: rgba(govuk-colour("black"), .25) 0 2px 6px;
+  box-shadow: rgba(govuk-colour("black"), 0.25) 0 2px 6px;
   left: 0;
   position: absolute;
   top: 100%;

package/index.js

@@ -12,7 +12,6 @@ module.exports = function (eleventyConfig, pluginOptions = {}) {
   eleventyConfig.addCollection('ordered', require('./lib/collections/ordered.js'))
   eleventyConfig.addCollection('sitemap', require('./lib/collections/sitemap.js'))
   eleventyConfig.addCollection('tags', require('./lib/collections/tags.js'))
-  eleventyConfig.addCollection('tagPages', require('./lib/collections/tag-pages.js'))
 
   // Extensions and template formats
   eleventyConfig.addExtension('scss', require('./lib/extensions/scss.js'))

package/layouts/post.njk

@@ -16,8 +16,7 @@
         modified: modified,
         author: author,
         authors: authors,
-        tags: tags,
-        tagPages: collections.tagPages
+        tags: tags
       }) }}
     </div>
 

package/layouts/tags.njk

@@ -15,10 +15,10 @@
     }) }}
 
     <ul class="govuk-list govuk-list--bullet">
-      {% for item in collections.tagPages %}
+      {% for tag in collections.tags %}
       <li>
-        <a href="{{ item.url | url }}">{{ item.data.tag }}</a>
-        ({{ collections[item.data.tag] | length }})
+        <a href="/tags/{{ tag | slug }}">{{ tag }}</a>
+        ({{ collections[tag] | length }})
       </li>
       {% endfor %}
     </ul>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@x-govuk/govuk-eleventy-plugin",
-  "version": "5.0.4",
+  "version": "5.0.6",
   "description": "Write documentation using Markdown and publish it using GOV.UK styles",
   "keywords": [
     "govuk",
@@ -36,10 +36,11 @@
     "predev": "rimraf _site",
     "dev": "eleventy --serve --watch",
     "start": "eleventy --serve",
-    "lint": "standard && stylelint '**/*.scss'",
+    "lint": "prettier . --check && standard && stylelint '**/*.scss'",
     "test": "ava",
     "test:watch": "ava --watch",
-    "coverage": "c8 ava"
+    "coverage": "c8 ava",
+    "release": "np"
   },
   "dependencies": {
     "@11ty/eleventy": "^2.0.0",
@@ -63,7 +64,7 @@
     "markdown-it-sup": "^1.0.0",
     "markdown-it-table-of-contents": "^0.6.0",
     "rimraf": "^5.0.0",
-    "rollup": "^3.9.0",
+    "rollup": "^4.1.0",
     "sass": "^1.45.1",
     "smartypants": "^0.2.0"
   },
@@ -71,12 +72,14 @@
     "@x-govuk/govuk-eleventy-plugin": "file:./",
     "ava": "^5.1.0",
     "c8": "^8.0.0",
+    "np": "^8.0.4",
+    "prettier": "^3.0.0",
     "standard": "^17.0.0",
     "stylelint": "^ 15.10.3",
     "stylelint-config-gds": "^1.0.0"
   },
   "engines": {
-    "node": "^16.0.0 || ^18.0.0",
+    "node": "^16 || ^18 || ^20",
     "npm": ">=8.0.0"
   },
   "publishConfig": {
@@ -88,6 +91,26 @@
       "lcovonly"
     ]
   },
+  "prettier": {
+    "semi": false,
+    "singleQuote": true,
+    "trailingComma": "none",
+    "overrides": [
+      {
+        "files": "*.md",
+        "options": {
+          "embeddedLanguageFormatting": "off",
+          "singleQuote": false
+        }
+      },
+      {
+        "files": "*.scss",
+        "options": {
+          "singleQuote": false
+        }
+      }
+    ]
+  },
   "stylelint": {
     "extends": "stylelint-config-gds/scss"
   }

package/lib/collections/tag-pages.js

@@ -1,2 +0,0 @@
-module.exports = (collection) =>
-  collection.getAllSorted().filter((item) => item.data.layout === 'tag')