fix(cli): *index.md should not be treated as folder index files

Author: daKmoR

.changeset/lemon-bulldogs-check.md

@@ -0,0 +1,5 @@
+---
+'@rocket/cli': patch
+---
+
+Make sure links to `*index.md` files are not treated as folder index files like `index.md`

packages/cli/src/eleventy-plugins/processLocalReferences.cjs

@@ -39,22 +39,25 @@ const templateEndings = [
   '.pug',
 ];
 
-function endsWithAny(string, suffixes) {
-  for (let suffix of suffixes) {
-    if (string.endsWith(suffix)) {
+function isTemplateFile(href) {
+  for (const templateEnding of templateEndings) {
+    if (href.endsWith(templateEnding)) {
       return true;
     }
   }
   return false;
 }
 
-function isTemplateFile(href) {
-  return endsWithAny(href, templateEndings);
-}
-
 function isIndexTemplateFile(href) {
+  const hrefParsed = path.parse(href);
   const indexTemplateEndings = templateEndings.map(ending => `index${ending}`);
-  return endsWithAny(href, indexTemplateEndings);
+
+  for (const indexTemplateEnding of indexTemplateEndings) {
+    if (hrefParsed.base === indexTemplateEnding) {
+      return true;
+    }
+  }
+  return false;
 }
 
 /**
@@ -91,12 +94,46 @@ function extractReferences(html, inputPath) {
   return { hrefs, assets };
 }
 
+/**
+ * @param {string} inValue
+ */
+function getValueAndAnchor(inValue) {
+  let value = inValue.replace(/&#/g, '--__check-html-links__--');
+  let anchor = '';
+  let suffix = '';
+
+  if (value.includes('#')) {
+    [value, anchor] = value.split('#');
+    suffix = `#${anchor}`;
+  }
+  if (value.includes('?')) {
+    value = value.split('?')[0];
+  }
+  if (anchor.includes(':~:')) {
+    anchor = anchor.split(':~:')[0];
+  }
+  if (value.includes(':~:')) {
+    value = value.split(':~:')[0];
+  }
+
+  value = value.replace(/--__check-html-links__--/g, '&#');
+  anchor = anchor.replace(/--__check-html-links__--/g, '&#');
+  suffix = suffix.replace(/--__check-html-links__--/g, '&#');
+  value = value.trim();
+  anchor = anchor.trim();
+
+  return {
+    value,
+    anchor,
+    suffix,
+  };
+}
+
 function calculateNewHrefs(hrefs, inputPath) {
   const newHrefs = [];
   for (const hrefObj of hrefs) {
     const newHrefObj = { ...hrefObj };
-    const [href, anchor] = newHrefObj.value.split('#');
-    const suffix = anchor ? `#${anchor}` : '';
+    const { value: href, suffix } = getValueAndAnchor(hrefObj.value);
 
     if (isRelativeLink(href) && isTemplateFile(href)) {
       const hrefParsed = path.parse(href);

packages/cli/test-node/RocketCli.e2e.test.js

@@ -353,7 +353,7 @@ describe('RocketCli e2e', () => {
     expect(guidesHtml).to.equal('/_merged_assets/11ty-img/58b7e437-1200.png');
   });
 
-  it.only('will add "../" for links and image urls only within named template files', async () => {
+  it('will add "../" for links and image urls only within named template files', async () => {
     await executeStart('e2e-fixtures/image-link/rocket.config.js');
 
     const namedMdContent = [
@@ -415,13 +415,15 @@ describe('RocketCli e2e', () => {
         '<a href="guides/#with-anchor">Guides</a>',
         '<a href="./one-level/raw/">Raw</a>',
         '<a href="template/">Template</a>',
+        '<a href="./rules/tabindex/">EndingIndex</a>',
         '<img src="./images/my-img.svg" alt="my-img">',
         '<img src="/images/my-img.svg" alt="absolute-img"></p>',
         '<div>',
         '  <a href="./">Root</a>',
         '  <a href="guides/#with-anchor">Guides</a>',
         '  <a href="./one-level/raw/">Raw</a>',
         '  <a href="template/">Template</a>',
+        '  <a href="./rules/tabindex/">EndingIndex</a>',
         '  <img src="./images/my-img.svg" alt="my-img">',
         '  <img src="/images/my-img.svg" alt="absolute-img">',
         '  <picture>',

packages/cli/test-node/e2e-fixtures/image-link/docs/index.md

@@ -2,6 +2,7 @@
 [Guides](./guides.md#with-anchor)
 [Raw](./one-level/raw.html)
 [Template](./template.njk)
+[EndingIndex](./rules/tabindex.md)
 ![my-img](./images/my-img.svg)
 ![absolute-img](/images/my-img.svg)
 
@@ -10,6 +11,7 @@
   <a href="./guides.md#with-anchor">Guides</a>
   <a href="./one-level/raw.html">Raw</a>
   <a href="./template.njk">Template</a>
+  <a href="./rules/tabindex.md">EndingIndex</a>
   <img src="./images/my-img.svg" alt="my-img">
   <img src="/images/my-img.svg" alt="absolute-img">
   <picture>