Merge pull request UmbrellaDocs#74 from UmbrellaDocs/incorrect-md-fix

Incorrect md fix
gaurav-nelson · Jul 1, 2024 · 59321b9 · 59321b9
2 parents e36d213 + d94d218
commit 59321b9
Show file tree

Hide file tree

Showing 12 changed files with 311 additions and 255 deletions.
diff --git a/index.js b/index.js
@@ -108,7 +108,7 @@ program
         process.exit(1)
       }
     } catch (error) {
-      console.error(kleur.red(`💥 Error: ${error.message}`))
+      console.error(kleur.red(`💥 Main error: ${error.message}`))
       process.exit(1)
     }
   })

diff --git a/index.test.js b/index.test.js
@@ -5,82 +5,6 @@ let cmd = {
   json: true,
 }
 
-test('linkspector should check image links in Markdown file', async () => {
-  let hasErrorLinks = false
-  let currentFile = '' // Variable to store the current file name
-  let results = [] // Array to store the results if json is true
-
-  for await (const { file, result } of linkspector(
-    './test/fixtures/markdown/image/imageTest.yml',
-    cmd
-  )) {
-    currentFile = file
-    for (const linkStatusObj of result) {
-      if (cmd.json) {
-        results.push({
-          file: currentFile,
-          link: linkStatusObj.link,
-          status_code: linkStatusObj.status_code,
-          line_number: linkStatusObj.line_number,
-          position: linkStatusObj.position,
-          status: linkStatusObj.status,
-          error_message: linkStatusObj.error_message,
-        })
-      }
-      if (linkStatusObj.status === 'error') {
-        hasErrorLinks = true
-      }
-    }
-  }
-
-  expect(hasErrorLinks).toBe(false)
-  expect(results.length).toBe(1)
-  expect(results[0].link).toBe(
-    'https://commons.wikimedia.org/wiki/Main_Page#/media/File:Praia_do_Ribeiro_do_Cavalo2.jpg'
-  )
-  expect(results[0].status).toBe('alive')
-})
-
-test('linkspector should check relative links in Markdown file', async () => {
-  let hasErrorLinks = false
-  let currentFile = '' // Variable to store the current file name
-  let results = [] // Array to store the results if json is true
-
-  for await (const { file, result } of linkspector(
-    './test/fixtures/markdown/relative/.relativeTest.yml',
-    cmd
-  )) {
-    currentFile = file
-    for (const linkStatusObj of result) {
-      if (cmd.json) {
-        results.push({
-          file: currentFile,
-          link: linkStatusObj.link,
-          status_code: linkStatusObj.status_code,
-          line_number: linkStatusObj.line_number,
-          position: linkStatusObj.position,
-          status: linkStatusObj.status,
-          error_message: linkStatusObj.error_message,
-        })
-      }
-      if (linkStatusObj.status === 'error') {
-        hasErrorLinks = true
-      }
-    }
-  }
-
-  expect(hasErrorLinks).toBe(true)
-  expect(results.length).toBe(8)
-  expect(results[0].status).toBe('alive')
-  expect(results[1].status).toBe('alive')
-  expect(results[2].status).toBe('alive')
-  expect(results[3].status).toBe('alive')
-  expect(results[4].status).toBe('alive')
-  expect(results[5].status).toBe('alive')
-  expect(results[6].status).toBe('error')
-  expect(results[7].status).toBe('error')
-})
-
 test('linkspector should check top-level relative links in Markdown file', async () => {
   let hasErrorLinks = false
   let currentFile = '' // Variable to store the current file name
@@ -112,177 +36,3 @@ test('linkspector should check top-level relative links in Markdown file', async
   expect(hasErrorLinks).toBe(false)
   expect(results.length).toBe(21)
 })
-
-test('linkspector should add back the removed duplicates when returning the results', async () => {
-  let hasErrorLinks = false
-  let currentFile = '' // Variable to store the current file name
-  let results = [] // Array to store the results if json is true
-
-  for await (const { file, result } of linkspector(
-    './test/fixtures/markdown/duplicates/duplicateTest.yml',
-    cmd
-  )) {
-    currentFile = file
-    for (const linkStatusObj of result) {
-      if (cmd.json) {
-        results.push({
-          file: currentFile,
-          link: linkStatusObj.link,
-          status_code: linkStatusObj.status_code,
-          line_number: linkStatusObj.line_number,
-          position: linkStatusObj.position,
-          status: linkStatusObj.status,
-          error_message: linkStatusObj.error_message,
-        })
-      }
-      if (linkStatusObj.status === 'error') {
-        hasErrorLinks = true
-      }
-    }
-  }
-
-  expect(hasErrorLinks).toBe(true)
-  expect(results.length).toBe(4)
-  expect(results[0].status).toBe('alive')
-  expect(results[1].status).toBe('error')
-  expect(results[2].status).toBe('alive')
-  expect(results[3].status).toBe('error')
-})
-
-test('linkspector should check hyperlinks in AsciiDoc files', async () => {
-  let hasErrorLinks = false
-  let currentFile = '' // Variable to store the current file name
-  let results = [] // Array to store the results if json is true
-
-  for await (const { file, result } of linkspector(
-    './test/fixtures/asciidoc/hyperlinks/hyperlinksTest.yml',
-    cmd
-  )) {
-    currentFile = file
-    for (const linkStatusObj of result) {
-      if (cmd.json) {
-        results.push({
-          file: currentFile,
-          link: linkStatusObj.link,
-          status_code: linkStatusObj.status_code,
-          line_number: linkStatusObj.line_number,
-          position: linkStatusObj.position,
-          status: linkStatusObj.status,
-          error_message: linkStatusObj.error_message,
-        })
-      }
-      if (linkStatusObj.status === 'error') {
-        hasErrorLinks = true
-      }
-    }
-  }
-
-  expect(hasErrorLinks).toBe(true)
-  expect(results.length).toBe(4)
-  expect(results[0].status).toBe('error')
-  expect(results[1].status).toBe('alive')
-  expect(results[2].status).toBe('error')
-  expect(results[3].status).toBe('alive')
-})
-
-test('linkspector should check HTML encoded section links', async () => {
-  let hasErrorLinks = false
-  let currentFile = '' // Variable to store the current file name
-  let results = [] // Array to store the results if json is true
-
-  for await (const { file, result } of linkspector(
-    './test/fixtures/markdown/decoded-sections/.decodedTest.yml',
-    cmd
-  )) {
-    currentFile = file
-    for (const linkStatusObj of result) {
-      if (cmd.json) {
-        results.push({
-          file: currentFile,
-          link: linkStatusObj.link,
-          status_code: linkStatusObj.status_code,
-          line_number: linkStatusObj.line_number,
-          position: linkStatusObj.position,
-          status: linkStatusObj.status,
-          error_message: linkStatusObj.error_message,
-        })
-      }
-      if (linkStatusObj.status === 'error') {
-        hasErrorLinks = true
-      }
-    }
-  }
-
-  expect(hasErrorLinks).toBe(false)
-  expect(results.length).toBe(4)
-  expect(results[0].status).toBe('alive')
-  expect(results[1].status).toBe('alive')
-  expect(results[2].status).toBe('alive')
-  expect(results[3].status).toBe('alive')
-})
-
-test('linkspector should check HTML encoded section links and include anchor names', async () => {
-  let hasErrorLinks = false
-  let currentFile = '' // Variable to store the current file name
-  let results = [] // Array to store the results if json is true
-
-  for await (const { file, result } of linkspector(
-    './test/fixtures/markdown/with-html-anchors/.withHtmlAnchorsTest.yml',
-    cmd
-  )) {
-    currentFile = file
-    for (const linkStatusObj of result) {
-      if (cmd.json) {
-        results.push({
-          file: currentFile,
-          link: linkStatusObj.link,
-          status_code: linkStatusObj.status_code,
-          line_number: linkStatusObj.line_number,
-          position: linkStatusObj.position,
-          status: linkStatusObj.status,
-          error_message: linkStatusObj.error_message,
-        })
-      }
-      if (linkStatusObj.status === 'error') {
-        hasErrorLinks = true
-      }
-    }
-  }
-
-  // Test expectations for link checks
-  expect(hasErrorLinks).toBe(false)
-  expect(results.length).toBe(1)
-  expect(results[0].status).toBe('alive')
-})
-
-test('linkspector should check links to headings with inline bold, italic, code, link, and image elements', async () => {
-  let hasErrorLinks = false
-  let currentFile = '' // Variable to store the current file name
-  let results = [] // Array to store the results if json is true
-
-  for await (const { file, result } of linkspector(
-    './test/fixtures/markdown/headings/headingsTest.yml',
-    cmd
-  )) {
-    currentFile = file
-    for (const linkStatusObj of result) {
-      if (cmd.json) {
-        results.push({
-          file: currentFile,
-          link: linkStatusObj.link,
-          status_code: linkStatusObj.status_code,
-          line_number: linkStatusObj.line_number,
-          position: linkStatusObj.position,
-          status: linkStatusObj.status,
-          error_message: linkStatusObj.error_message,
-        })
-      }
-      if (linkStatusObj.status === 'error') {
-        hasErrorLinks = true
-      }
-    }
-  }
-
-  expect(hasErrorLinks).toBe(false)
-  expect(results.length).toBe(8)
-})
diff --git a/lib/prepare-file-list.js b/lib/prepare-file-list.js
@@ -150,7 +150,7 @@ function prepareFilesList(config) {
     return relativeFiles.map((file) => resolve(process.cwd(), file)) // Convert back to absolute paths
   } catch (err) {
     // Handle any other errors that may occur
-    console.error(err.message)
+    console.error("Error: Couldn't prepare the list of files. ", err)
     return []
   }
 }

diff --git a/lib/update-linkstatus-obj.js b/lib/update-linkstatus-obj.js
@@ -17,8 +17,22 @@ function updateLinkStatusObj(astNodes, linkStatus) {
   astNodes.forEach((node) => {
     const existingLink = linkStatus.find((link) => link.link === node.url)
     if (existingLink) {
+      if (!existingLink.position) {
+        console.error(
+          `ERROR: Markdown formatting error around link: ${existingLink.link}. Please check the file containing this link.`
+        )
+        existingLink.position = {
+          start: { line: 1, column: 1 },
+          end: { line: 1, column: 1 },
+        }
+      }
+
       const existingPosition = existingLink.position
-      const nodePosition = node.position
+      const nodePosition = node.position || {
+        start: { line: 1, column: 1 },
+        end: { line: 1, column: 1 },
+      }
+
       if (
         existingPosition.start.line !== nodePosition.start.line ||
         existingPosition.start.column !== nodePosition.start.column ||

diff --git a/lib/validate-config.js b/lib/validate-config.js
@@ -59,13 +59,13 @@ async function validateConfig(config) {
     return true
   } catch (err) {
     if (err instanceof ValidationError) {
-      console.error(err.message, err.details)
+      console.error('Validation Error:', err.message)
       throw err
     } else if (err.message.includes('ENOENT: no such file or directory')) {
       console.error('Error reading file:', err.message)
       throw err
     } else {
-      console.error('Error:', err.message)
+      console.error('Other Validation Error:', err.message)
       throw err
     }
     return false

diff --git a/test/fixtures/asciidoc/hyperlinks/asciidoc-hyperlinks.test.js b/test/fixtures/asciidoc/hyperlinks/asciidoc-hyperlinks.test.js
@@ -0,0 +1,42 @@
+import { expect, test } from 'vitest'
+import { linkspector } from './linkspector.js'
+
+let cmd = {
+  json: true,
+}
+
+test('linkspector should check hyperlinks in AsciiDoc files', async () => {
+  let hasErrorLinks = false
+  let currentFile = '' // Variable to store the current file name
+  let results = [] // Array to store the results if json is true
+
+  for await (const { file, result } of linkspector(
+    './test/fixtures/asciidoc/hyperlinks/hyperlinksTest.yml',
+    cmd
+  )) {
+    currentFile = file
+    for (const linkStatusObj of result) {
+      if (cmd.json) {
+        results.push({
+          file: currentFile,
+          link: linkStatusObj.link,
+          status_code: linkStatusObj.status_code,
+          line_number: linkStatusObj.line_number,
+          position: linkStatusObj.position,
+          status: linkStatusObj.status,
+          error_message: linkStatusObj.error_message,
+        })
+      }
+      if (linkStatusObj.status === 'error') {
+        hasErrorLinks = true
+      }
+    }
+  }
+
+  expect(hasErrorLinks).toBe(true)
+  expect(results.length).toBe(4)
+  expect(results[0].status).toBe('error')
+  expect(results[1].status).toBe('alive')
+  expect(results[2].status).toBe('error')
+  expect(results[3].status).toBe('alive')
+})