refactor: robust pathPrefix handling; all internal links now consistent

Author: shawnthompson

package-lock.json

@@ -45,7 +45,7 @@
     "@11ty/eleventy-navigation": "^0.3.3",
     "@cspell/dict-fr-fr": "^2.1.2",
     "axios": "^1.7.5",
-    "broken-link-checker": "^0.6.7",
+    "broken-link-checker": "^0.7.8",
     "cross-env": "^7.0.3",
     "cspell": "^6.18.1",
     "dotenv": "^16.4.5",

package.json

@@ -128,7 +128,10 @@ const siteChecker = new blc.SiteChecker(
 					};
 					brokenLinks.push(existingPage);
 				}
-
+				// Ensure links array exists (defensive)
+				if (!Array.isArray(existingPage.links)) {
+					existingPage.links = [];
+				}
 				existingPage.links.push({
 					link: result.url.original,
 					linkText: result.html.text || "N/A"

scripts/link-checker.js

@@ -4,9 +4,8 @@ module.exports = () => {
   const pathPrefix = process.env.PATH_PREFIX;
 
   if (pathPrefix) {
-    // Ensure prefix starts with '/' but NO trailing slash
-    const normalizedPrefix = `/${pathPrefix.replace(/^\/+|\/+$/g, '')}`;
-    return normalizedPrefix;
+    // Only add leading slash if pathPrefix is set, and remove any leading/trailing slashes from the value
+    return '/' + pathPrefix.replace(/^\/+|\/+$/g, '');
   }
 
   // Default to empty string for main repo (no prefix needed)

src/_data/pathPrefix.js

@@ -64,7 +64,7 @@ Canada.ca > Digital Accessibility Toolkit > How to’s > Create web content > Ac
 			{% set url = page.url | replace("/", "") %}
 			{% if url != locale %}
 				<li property="itemListElement" typeof="ListItem">
-					<a property="item" typeof="WebPage" href="{{ pathPrefix }}/{{ locale }}/">{{ settings[locale].metaTitle }}</a>
+					<a property="item" typeof="WebPage" href="{% if pathPrefix %}{{ pathPrefix }}{% endif %}/{{ locale }}/">{{ settings[locale].metaTitle }}</a>
 					<meta property="position" content="2">
 				</li>
 			{% endif %}
@@ -77,7 +77,7 @@ Canada.ca > Digital Accessibility Toolkit > How to’s > Create web content > Ac
 				{% if subject %}
 					{% for breadcrumb in subject %}
 						<li property="itemListElement" typeof="ListItem">
-							<a property="item" typeof="WebPage" href="{{ pathPrefix }}/{{ locale }}/{{ tagList.tags[locale][breadcrumb] | stripTagsSlugify or tagList.subjects[locale][breadcrumb] | stripTagsSlugify }}">
+							<a property="item" typeof="WebPage" href="{% if pathPrefix %}{{ pathPrefix }}{% endif %}/{{ locale }}/{{ tagList.tags[locale][breadcrumb] | stripTagsSlugify or tagList.subjects[locale][breadcrumb] | stripTagsSlugify }}">
 								<span property="name">{{ tagList.tags[locale][breadcrumb] or tagList.subjects[locale][breadcrumb] }}</span>
 							</a>
 							<meta property="position" content="{{ counter }}">
@@ -91,7 +91,7 @@ Canada.ca > Digital Accessibility Toolkit > How to’s > Create web content > Ac
 					{% for breadcrumb in tags %}
 						{% if breadcrumb != "updatesMain" %}
 							<li property="itemListElement" typeof="ListItem">
-								<a property="item" typeof="WebPage" href="{{ pathPrefix }}/{{ locale }}/{{ tagList.tags[locale][breadcrumb] | stripTagsSlugify or tagList.subjects[locale][breadcrumb] | stripTagsSlugify }}">
+								<a property="item" typeof="WebPage" href="{% if pathPrefix %}{{ pathPrefix }}{% endif %}/{{ locale }}/{{ tagList.tags[locale][breadcrumb] | stripTagsSlugify or tagList.subjects[locale][breadcrumb] | stripTagsSlugify }}">
 									<span property="name">{{ tagList.tags[locale][breadcrumb] or tagList.subjects[locale][breadcrumb] }}</span>
 								</a>
 								<meta property="position" content="{{ counter }}">

src/_includes/partials/breadcrumbs.njk

@@ -1,4 +1,3 @@
-
 <div class="container">
 	<div class="row wb-eqht mrgn-tp-lg gc-srvinfo">
 		{% for item in collections.main | sort(false, false, 'data.title') | localeMatch(locale) %}

src/_includes/partials/collectionsMain.njk

@@ -31,10 +31,10 @@
     <div class="gc-stp-stp">
         <div class="toc row mrgn-tp-lg">
             <ul class="wb-eqht-grd">
-                <li class="col-md-4 col-sm-6"><a class="list-group-item{% if page.url === indexURL %} active{% endif %}"{% if page.url===indexURL %} aria-current="page"{% endif %}{% if page.url !=indexURL %} href="{{ pathPrefix }}{{ indexURL | replace('/', '') }}"{% endif %}>{{ indexTitle }} <small class="visible-xs-inline visible-sm-block visible-md-block visible-lg-block"> {{ inOffice }} {{ version }}</small></a></li>
+                <li class="col-md-4 col-sm-6"><a class="list-group-item{% if page.url === indexURL %} active{% endif %}"{% if page.url===indexURL %} aria-current="page"{% endif %}{% if page.url !=indexURL %} href="{{ pathPrefix }}{{ indexURL }}"{% endif %}>{{ indexTitle }} <small class="visible-xs-inline visible-sm-block visible-md-block visible-lg-block"> {{ inOffice }} {{ version }}</small></a></li>
                 {% for item in collections | localeMatch(locale) %}
                     {% set title = item.data.title %}
-                    <li class="col-md-4 col-sm-6" {% if page.url==item.url %} aria-current="page" {% endif %}><a class="list-group-item{% if page.url == item.url %} active{% endif %}"{% if page.url !=item.url %} href="{{ pathPrefix }}/{{ item.url | replace('/', '') }}"{% endif %}>
+                    <li class="col-md-4 col-sm-6" {% if page.url==item.url %} aria-current="page" {% endif %}><a class="list-group-item{% if page.url == item.url %} active{% endif %}"{% if page.url !=item.url %} href="{{ pathPrefix }}{{ item.url }}"{% endif %}>
                         {% if item.data.fontIcon %}
                             <i class="fas fa-lg {{ item.data.fontIcon }}" aria-hidden="true"></i>
                         {% endif %}
@@ -47,7 +47,7 @@
     <div class="well">
         {% set versionSlug = version | slugify %}
         {% set otherVersionSlug = otherVersion | slugify %}
-        <p class="mrgn-tp-md">{{ tryText }} <a href="{{ pathPrefix }}/{{ page.url | replace(versionSlug,otherVersionSlug) | replace('/', '') }}">{{ title | replace(inOffice + " " + version,"") }}<small><strong> {{ inOffice }} {{ otherVersion }}</strong></small></a></p>
+        <p class="mrgn-tp-md">{{ tryText }} <a href="{{ pathPrefix }}{{ page.url | replace(versionSlug,otherVersionSlug) }}">{{ title | replace(inOffice + " " + version,"") }}<small><strong> {{ inOffice }} {{ otherVersion }}</strong></small></a></p>
     </div>
 
 {% endif %}

src/_includes/partials/office-toc.njk

@@ -118,7 +118,7 @@
 				{% else %}
 					{% if entry.data.tags %}
 						<section class="col-md-6" data-wb-tags="{{ entry.data.subject }} {{ entry.data.tags }}{% for items in isLanding[6] %}{% if items != "m" %} notLanding{% endif %}{% endfor %}">
-							<h2 class="h4"><a href="{{ pathPrefix }}{{ entry.url }}">{{ entry.data.title | striptags(true) | escape | nl2br }}</a></h2>
+							<h2 class="h4"><a href="{{ entry.url }}">{{ entry.data.title | striptags(true) | escape | nl2br }}</a></h2>
 							{% if settings.env == "local" %}
 								{% if entry.data.subject %}
 									<p><strong>subject{% if locale === "fr" %} {% endif %}:</strong> <span class="label label-success">{{ entry.data.subject }}</span></p>

src/_includes/partials/pageList.njk

@@ -105,10 +105,10 @@
 				{% else %}
 				<tr{% for items in isLanding[6] %}{% if items === "m" %} class="success" data-wb-tags="isLanding"{% else %} data-wb-tags="isPage"{% endif %}{% endfor %}>
 					<td data-wb-tags="col_1">
-					<a href="{{ pathPrefix }}/{{ entry.url | replace('/', '') }}">{{ entry.data.title | safe }}</a></td>
+					<a href="{{ entry.url }}">{{ entry.data.title | safe }}</a></td>
 					<td data-wb-tags="col_2">
 						{% if entry.data.toggle %}
-						<a href="{{ pathPrefix }}/{{ otherLocale }}/{{ entry.data.toggle }}" hreflang="{{ otherLang }}">{% if locale === "en" %}French version{% else %}Version anglaise{% endif %} <span class="wb-inv">{% if locale === "en" %}of{% else %}de{% endif %} {{ entry.data.title | safe }}</span></a>
+						<a href="{{ pathPrefix }}{{ otherLocale }}/{{ entry.data.toggle }}" hreflang="{{ otherLang }}">{% if locale === "en" %}French version{% else %}Version anglaise{% endif %} <span class="wb-inv">{% if locale === "en" %}of{% else %}de{% endif %} {{ entry.data.title | safe }}</span></a>
 						{% else %}
 						<strong>{{ missingToggle }}</strong>
 						{% endif %}

src/_includes/partials/pageListTable.njk

@@ -17,7 +17,7 @@
 	</p>
 	<ul class="row wb-eqht-grd list-unstyled small">
 	{% for item in collections.updatesMain | sort(attribute='date', reverse=true) | localeMatch(locale) %}
-		<li class="col-xs-12 col-sm-6 mrgn-tp-sm mrgn-bttm-sm"><a href="{{ pathPrefix }}{{ item.url }}">{{ item.data.title }} <small class="visible-xs-inline visible-sm-block visible-md-block visible-lg-block"><time>{{ item.date | postDate }}</time></small></a></li>
+		<li class="col-xs-12 col-sm-6 mrgn-tp-sm mrgn-bttm-sm"><a href="{{ pathPrefix }}{{ item.url }} ">{{ item.data.title }} <small class="visible-xs-inline visible-sm-block visible-md-block visible-lg-block"><time>{{ item.date | postDate }}</time></small></a></li>
 	{% endfor %}
 	</ul>
 </section>