Fix: find all files in a directory (#14)

Author: Constantin Krüger

lib/allChecksRunner.js

@@ -1,4 +1,3 @@
-const fs = require('fs')
 const HtmlPage = require('./html/htmlPage')
 const SinglePageResult = require('./singlePageResult')
 const Logger = require('./logging/LoggingFacacde')
@@ -12,23 +11,16 @@ class AllChecksRunner {
   async performAllChecks () {
     const resultsForAllPages = []
 
-    fs.readdir(this.config.sourceDir, { recursive: this.config.recursive, withFileTypes: true }, (err, files) => {
-      if (!err) {
-        files.filter((file) => {
-          return file.isFile() && file.name.toLowerCase().endsWith('.html')
-        }).forEach((file) => {
-          const singlePageResult = this.performCheckForOneFile(file)
-          resultsForAllPages.push(singlePageResult)
-        })
-      } else {
-        console.log(err)
-      }
+    const files = require('./utils').findFiles(this.config.sourceDir, this.config.recursive, this.config.extension)
+    files.forEach((file) => {
+      const singlePageResult = this.performCheckForOneFile(file)
+      resultsForAllPages.push(singlePageResult)
     })
     return resultsForAllPages
   }
 
   performCheckForOneFile (file) {
-    const htmlPage = new HtmlPage({ filePath: file.parentPath, fileName: file.name })
+    const htmlPage = new HtmlPage({ filePath: file.filePath, fileName: file.fileName })
     const singlePageResult = new SinglePageResult(htmlPage)
 
     const { checker = [] } = this.config

lib/utils.js

@@ -3,5 +3,24 @@
 module.exports = {
   cwd: function cwd () {
     return process.cwd()
+  },
+  findFiles: function (/* string */ sourceDir, /* boolean */ recursive, /* string[] */ fileExtensions) {
+    const fs = require('fs')
+    const path = require('path')
+    const files = fs.readdirSync(sourceDir, { recursive, withFileTypes: false })
+    return files.filter((file) => {
+      let fileExt = path.extname(file).toLowerCase()
+      if (fileExt) {
+        fileExt = fileExt.substring(1)
+      }
+      return fileExtensions.includes(fileExt)
+    }).map((file) => {
+      return {
+        filePath: path.join(sourceDir, path.dirname(file)),
+        fileName: path.basename(file)
+      }
+    }
+    )
   }
+
 }

test/node-unit/utils.spec.js

@@ -0,0 +1,32 @@
+/* global describe it */
+'use strict'
+
+const { findFiles, cwd } = require('../../lib/utils')
+const chai = require('chai')
+const path = require('path')
+const expect = chai.expect
+
+describe('findFiles', () => {
+  it('non recursive', () => {
+    const files = findFiles(`${cwd()}/test/fixtures`, false, ['html'])
+    expect(files).to.have.lengthOf(1)
+    expect(files).has.deep.members([
+      { filePath: path.join(cwd(), 'test', 'fixtures'), fileName: 'file-to-test.html' }
+    ])
+  })
+  it('recursive', () => {
+    const files = findFiles(`${cwd()}/test/fixtures`, true, ['html'])
+    expect(files).to.have.lengthOf(5)
+    expect(files).has.deep.members([
+      { filePath: path.join(cwd(), 'test', 'fixtures'), fileName: 'file-to-test.html' },
+      { filePath: path.join(cwd(), 'test', 'fixtures', 'html-files'), fileName: 'brokenHttpLinksChecker_127_0_0_2.html' },
+      { filePath: path.join(cwd(), 'test', 'fixtures', 'html-files'), fileName: 'brokenHttpLinksChecker_github.com.html' },
+      { filePath: path.join(cwd(), 'test', 'fixtures', 'html-files'), fileName: 'brokenHttpLinksChecker_localhost.html' },
+      { filePath: path.join(cwd(), 'test', 'fixtures', 'sub_dr'), fileName: 'brokenHttpLinksChecker.html' }
+    ])
+  })
+  it('empty extensions', () => {
+    const files = findFiles(`${cwd()}/test/fixtures`, true, [])
+    expect(files).to.have.lengthOf(0)
+  })
+})