fix: follow verbosity rules for JSON and CSV (#216)

JustinBeckwith · Dec 24, 2020 · 9eb5590 · 9eb5590
1 parent cf29469
commit 9eb5590
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 4 deletions.
diff --git a/src/cli.ts b/src/cli.ts
@@ -131,10 +131,25 @@ async function main() {
     opts.linksToSkip = flags.skip.split(' ').filter(x => !!x);
   }
   const result = await checker.check(opts);
+  const filteredResults = result.links.filter(link => {
+    switch (link.state) {
+      case LinkState.OK:
+        return verbosity <= LogLevel.WARNING;
+      case LinkState.BROKEN:
+        if (verbosity > LogLevel.DEBUG) {
+          link.failureDetails = undefined;
+        }
+        return verbosity <= LogLevel.ERROR;
+      case LinkState.SKIPPED:
+        return verbosity <= LogLevel.INFO;
+    }
+  });
   if (format === Format.JSON) {
+    result.links = filteredResults;
     console.log(JSON.stringify(result, null, 2));
     return;
   } else if (format === Format.CSV) {
+    result.links = filteredResults;
     const csv = await toCSV(result.links);
     console.log(csv);
     return;

diff --git a/src/logger.ts b/src/logger.ts
@@ -42,7 +42,7 @@ export class Logger {
   }
 
   error(message?: string) {
-    if (this.level <= LogLevel.ERROR) {
+    if (this.level <= LogLevel.ERROR && this.format === Format.TEXT) {
       console.error(message);
     }
   }

diff --git a/test/zcli.ts b/test/zcli.ts
@@ -1,6 +1,7 @@
 import {describe, it} from 'mocha';
 import * as execa from 'execa';
 import {assert} from 'chai';
+import {LinkResult, LinkState} from '../src/index';
 
 describe('cli', () => {
   before(async () => {
@@ -53,7 +54,6 @@ describe('cli', () => {
   it('should provide CSV if asked nicely', async () => {
     const res = await execa('npx', [
       'linkinator',
-      '--markdown',
       '--format',
       'csv',
       'test/fixtures/markdown/README.md',
@@ -64,12 +64,12 @@ describe('cli', () => {
   it('should provide JSON if asked nicely', async () => {
     const res = await execa('npx', [
       'linkinator',
-      '--markdown',
       '--format',
       'json',
       'test/fixtures/markdown/README.md',
     ]);
-    assert.match(res.stdout, /{/);
+    const output = JSON.parse(res.stdout);
+    assert.ok(output.links);
   });
 
   it('should not show links if --silent', async () => {
@@ -81,6 +81,21 @@ describe('cli', () => {
     assert.notMatch(res.stdout, /\[/);
   });
 
+  it('should not show 200 links if verbosity is ERROR with JSON', async () => {
+    const res = await execa('npx', [
+      'linkinator',
+      '--verbosity',
+      'ERROR',
+      '--format',
+      'JSON',
+      'test/fixtures/markdown/README.md',
+    ]);
+    const links = JSON.parse(res.stdout).links as LinkResult[];
+    for (const link of links) {
+      assert.strictEqual(link.state, LinkState.BROKEN);
+    }
+  });
+
   it('should accept a server-root', async () => {
     const res = await execa('npx', [
       'linkinator',