feat: allow --skip to be defined multiple times (#399)

Author: JustinBeckwith

README.md

@@ -4,7 +4,7 @@
 
 [![npm version](https://img.shields.io/npm/v/linkinator)](https://www.npmjs.org/package/linkinator)
 [![Build Status](https://img.shields.io/github/workflow/status/JustinBeckwith/linkinator/ci/main)](https://github.com/JustinBeckwith/linkinator/actions?query=branch%3Amain+workflow%3Aci)
-[![codecov](https://img.shields.io/codecov/c/github/JustinBeckwith/linkinator/main)](https://codecov.io/gh/JustinBeckwith/linkinator)
+[![codecov](https://img.shields.io/codecov/c/github/JustinBeckwith/linkinator/main)](https://app.codecov.io/gh/JustinBeckwith/linkinator)
 [![Known Vulnerabilities](https://img.shields.io/snyk/vulnerabilities/github/JustinBeckwith/linkinator)](https://snyk.io/test/github/JustinBeckwith/linkinator)
 [![Code Style: Google](https://img.shields.io/badge/code%20style-google-blueviolet)](https://github.com/google/gts)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079)](https://github.com/semantic-release/semantic-release)

src/cli.ts

@@ -103,7 +103,7 @@ const cli = meow(
       config: {type: 'string'},
       concurrency: {type: 'number'},
       recurse: {type: 'boolean', alias: 'r'},
-      skip: {type: 'string', alias: 's'},
+      skip: {type: 'string', alias: 's', isMultiple: true},
       format: {type: 'string', alias: 'f'},
       silent: {type: 'boolean'},
       timeout: {type: 'number'},
@@ -184,7 +184,14 @@ async function main() {
     if (typeof flags.skip === 'string') {
       opts.linksToSkip = flags.skip.split(/[\s,]+/).filter(x => !!x);
     } else if (Array.isArray(flags.skip)) {
-      opts.linksToSkip = flags.skip;
+      // with `isMultiple` enabled in meow, a comma delimeted list will still
+      // be passed as an array, but with a single element that still needs to
+      // be split.
+      opts.linksToSkip = [];
+      for (const skip of flags.skip) {
+        const rules = skip.split(/[\s,]+/).filter(x => !!x);
+        opts.linksToSkip.push(...rules);
+      }
     }
   }
   if (flags.urlRewriteSearch && flags.urlRewriteReplace) {

src/config.ts

@@ -4,7 +4,7 @@ export interface Flags {
   concurrency?: number;
   config?: string;
   recurse?: boolean;
-  skip?: string;
+  skip?: string | string[];
   format?: string;
   silent?: boolean;
   verbosity?: string;
@@ -42,7 +42,10 @@ export async function getConfig(flags: Flags) {
   // doesn't blast away config level settings.
   const strippedFlags = Object.assign({}, flags);
   Object.entries(strippedFlags).forEach(([key, value]) => {
-    if (typeof value === 'undefined') {
+    if (
+      typeof value === 'undefined' ||
+      (Array.isArray(value) && value.length === 0)
+    ) {
       delete (strippedFlags as {[index: string]: {}})[key];
     }
   });

test/test.cli.ts

@@ -73,6 +73,24 @@ describe('cli', function () {
     assert.match(stderr, /scanned 2 links/);
   });
 
+  it('should allow --skip multiple times', async () => {
+    const res = await execa(node, [
+      linkinator,
+      '--verbosity',
+      'INFO',
+      '--skip',
+      'LICENSE.md',
+      '--skip',
+      'unlinked.md',
+      'test/fixtures/markdown/README.md',
+    ]);
+    const stdout = stripAnsi(res.stdout);
+    const stderr = stripAnsi(res.stderr);
+    assert.match(stdout, /\[SKP\]/);
+    // make sure we don't report skipped links in the count
+    assert.match(stderr, /scanned 2 links/);
+  });
+
   it('should provide CSV if asked nicely', async () => {
     const res = await execa(node, [
       linkinator,