feat: display warning log message when it can not parse config

fix htmlhint#662
is2ei · Jan 30, 2022 · 52ca8c9 · 52ca8c9
1 parent 200e2e5
commit 52ca8c9
Show file tree

Hide file tree

Showing 5 changed files with 51 additions and 2 deletions.
diff --git a/dist/cli/htmlhint.js b/dist/cli/htmlhint.js
diff --git a/src/cli/htmlhint.ts b/src/cli/htmlhint.ts
@@ -407,7 +407,7 @@ function getConfig(
         configPath: configPath,
       })
     } catch (e) {
-      // ignore
+      console.log(chalk.yellow(`Could not parse config file (${configPath}).`))
     }
 
     return ruleset

diff --git a/test/conf/invalid-json.conf b/test/conf/invalid-json.conf
@@ -0,0 +1,3 @@
+{
+    "attr-lowercase": false,
+}
diff --git a/test/conf/valid-json.conf b/test/conf/valid-json.conf
@@ -0,0 +1,3 @@
+{
+    "attr-lowercase": false
+}
diff --git a/test/executable.spec.js b/test/executable.spec.js
@@ -34,4 +34,46 @@ describe('Executable', () => {
       expect(stdoutEnd || processEnd).toBe(false)
     })
   })
+
+  it('should not display warning log message when it can parse config file', (done) => {
+    ChildProcess.exec(
+      [
+        'node',
+        path.resolve(__dirname, '../bin/htmlhint'),
+        path.resolve(__dirname, './html/executable.html'),
+        '--config',
+        path.resolve(__dirname, './conf/valid-json.conf'),
+      ].join(' '),
+      (error, stdout) => {
+        expect(stdout).not.to.contain(
+          `Could not parse config file (${path.resolve(
+            __dirname,
+            './conf/invalid-json.conf'
+          )}).`
+        )
+        done()
+      }
+    )
+  })
+
+  it('should display warning log message when it can not parse config file', (done) => {
+    ChildProcess.exec(
+      [
+        'node',
+        path.resolve(__dirname, '../bin/htmlhint'),
+        path.resolve(__dirname, './html/executable.html'),
+        '--config',
+        path.resolve(__dirname, './conf/invalid-json.conf'),
+      ].join(' '),
+      (error, stdout) => {
+        expect(stdout).to.contain(
+          `Could not parse config file (${path.resolve(
+            __dirname,
+            './conf/invalid-json.conf'
+          )}).`
+        )
+        done()
+      }
+    )
+  })
 })