feat: add verbosity setting (#33)

JustinBeckwith · web-flow · commit 118abd494ccc · 2020-12-29T18:14:58.000-08:00
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -11,7 +11,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: ./
         with:
-          skip: "https://www.github.com/JustinBeckwith/linkinator-action/compare"
+          skip: "CHANGELOG.md"
       - uses: ./
         with:
           paths: test/fixtures/test.md
diff --git a/README.md b/README.md
@@ -53,5 +53,8 @@ jobs:
 ## Outputs
 - `results` - An object with the results of the run.
 
+## Debugging
+To view skipped links, failure details, and more debugging information [enable step debug logging](https://docs.github.com/en/free-pro-team@latest/actions/managing-workflow-runs/enabling-debug-logging#enabling-step-debug-logging).
+
 ## License
 [MIT](LICENSE)
diff --git a/action.yml b/action.yml
@@ -16,6 +16,8 @@ inputs:
     default: false
   linksToSkip:
     description: 'List of urls in regexy form to not include in the check.'
+  skip:
+    description: 'List of urls in regexy form to not include in the check.'
   timeout:
     description: 'Request timeout in ms.  Defaults to 0 (no timeout).'
     default: 0
diff --git a/dist/index.js b/dist/index.js
@@ -32725,7 +32725,7 @@ function wrappy (fn, cb) {
 /***/ ((module, __unused_webpack_exports, __webpack_require__) => {
 
 const core = __webpack_require__(2186);
-const { LinkChecker } = __webpack_require__(356);
+const { LinkChecker, LinkState } = __webpack_require__(356);
 
 async function main () {
   try {
@@ -32745,20 +32745,33 @@ async function main () {
 
     const checker = new LinkChecker()
       .on('pagestart', url => {
-        console.log(`Scanning ${url}`);
+        core.info(`Scanning ${url}`);
+      })
+      .on('link', link => {
+        switch (link.state) {
+          case LinkState.BROKEN:
+            core.error(`[${link.status.toString()}] ${link.url}`);
+            break;
+          case LinkState.OK:
+            core.info(`[${link.status.toString()}] ${link.url}`);
+            break;
+          case LinkState.SKIPPED:
+            core.debug(`[SKP] ${link.url}`);
+            break;
+        }
       });
 
     const result = await checker.check(options);
+    core.info(`Scanned total of ${result.links.length} links!`);
     if (!result.passed) {
       const brokenLinks = result.links.filter(x => x.state === 'BROKEN');
       let failureOutput = `Detected ${brokenLinks.length} broken links.`;
       for (const link of brokenLinks) {
         failureOutput += `\n [${link.status}] ${link.url}`;
+        core.debug(JSON.stringify(link.failureDetails, null, 2));
       }
       core.setFailed(failureOutput);
-      return;
     }
-    console.log(`Scanned total of ${result.links.length} links!`);
     core.setOutput('results', result);
   } catch (err) {
     core.setFailed(`Linkinator exception: \n${err.message}\n${err.stack}`);
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/package.json b/package.json
@@ -26,6 +26,7 @@
   "homepage": "https://github.com/JustinBeckwith/linkinator-action#readme",
   "dependencies": {
     "@actions/core": "^1.2.6",
+    "chalk": "^4.1.0",
     "linkinator": "2.12.1"
   },
   "devDependencies": {
diff --git a/src/index.js b/src/index.js
@@ -1,5 +1,5 @@
 const core = require('@actions/core');
-const { LinkChecker } = require('linkinator');
+const { LinkChecker, LinkState } = require('linkinator');
 
 async function main () {
   try {
@@ -19,20 +19,33 @@ async function main () {
 
     const checker = new LinkChecker()
       .on('pagestart', url => {
-        console.log(`Scanning ${url}`);
+        core.info(`Scanning ${url}`);
+      })
+      .on('link', link => {
+        switch (link.state) {
+          case LinkState.BROKEN:
+            core.error(`[${link.status.toString()}] ${link.url}`);
+            break;
+          case LinkState.OK:
+            core.info(`[${link.status.toString()}] ${link.url}`);
+            break;
+          case LinkState.SKIPPED:
+            core.debug(`[SKP] ${link.url}`);
+            break;
+        }
       });
 
     const result = await checker.check(options);
+    core.info(`Scanned total of ${result.links.length} links!`);
     if (!result.passed) {
       const brokenLinks = result.links.filter(x => x.state === 'BROKEN');
       let failureOutput = `Detected ${brokenLinks.length} broken links.`;
       for (const link of brokenLinks) {
         failureOutput += `\n [${link.status}] ${link.url}`;
+        core.debug(JSON.stringify(link.failureDetails, null, 2));
       }
       core.setFailed(failureOutput);
-      return;
     }
-    console.log(`Scanned total of ${result.links.length} links!`);
     core.setOutput('results', result);
   } catch (err) {
     core.setFailed(`Linkinator exception: \n${err.message}\n${err.stack}`);
diff --git a/test/test.js b/test/test.js
@@ -34,14 +34,13 @@ describe('linkinator action', () => {
     const inputStub = sinon.stub(core, 'getInput');
     inputStub.withArgs('paths').returns('test/fixtures/test.md');
     inputStub.returns('');
-    const setOutputStub = sinon.stub(core, 'setOutput');
+    sinon.stub(core, 'setOutput');
     const setFailedStub = sinon.stub(core, 'setFailed');
     const scope = nock('http://fake.local')
       .head('/').reply(404)
       .head('/fake').reply(404);
     await action();
     assert.ok(inputStub.called);
-    assert.ok(setOutputStub.notCalled);
     assert.ok(setFailedStub.called);
     scope.done();
   });
