test: stop using npm link in CLI tests (#251)

Author: JustinBeckwith

test/test.cli.ts

@@ -9,15 +9,11 @@ import {LinkResult, LinkState} from '../src/index';
 // eslint-disable-next-line prefer-arrow-callback
 describe('cli', function () {
   let server: http.Server;
-  this.timeout(60_000);
+  this.timeout(10_000);
 
-  if (process.env.LINKINATOR_SKIP_CLI_TESTS) {
-    return;
-  }
-
-  before(async () => {
-    await execa('npm', ['link']);
-  });
+  const pkg = require('../../package.json');
+  const linkinator = pkg.bin.linkinator;
+  const node = 'node';
 
   afterEach(async () => {
     if (server) {
@@ -26,34 +22,39 @@ describe('cli', function () {
   });
 
   it('should show output for failures', async () => {
-    const res = await execa('linkinator', ['test/fixtures/basic'], {
+    const res = await execa(node, [linkinator, 'test/fixtures/basic'], {
       reject: false,
     });
     assert.match(res.stderr, /ERROR: Detected 1 broken links/);
   });
 
   it('should pass successful markdown scan', async () => {
-    const res = await execa('linkinator', ['test/fixtures/markdown/README.md']);
+    const res = await execa(node, [
+      linkinator,
+      'test/fixtures/markdown/README.md',
+    ]);
     assert.match(res.stderr, /Successfully scanned/);
   });
 
   it('should allow multiple paths', async () => {
-    const res = await execa('linkinator', [
+    const res = await execa(node, [
+      linkinator,
       'test/fixtures/markdown/unlinked.md',
       'test/fixtures/markdown/README.md',
     ]);
     assert.match(res.stderr, /Successfully scanned/);
   });
 
   it('should show help if no params are provided', async () => {
-    const res = await execa('linkinator', {
+    const res = await execa(node, [linkinator], {
       reject: false,
     });
     assert.match(res.stdout, /\$ linkinator LOCATION \[ --arguments \]/);
   });
 
   it('should flag skipped links', async () => {
-    const res = await execa('linkinator', [
+    const res = await execa(node, [
+      linkinator,
       '--verbosity',
       'INFO',
       '--skip',
@@ -64,7 +65,8 @@ describe('cli', function () {
   });
 
   it('should provide CSV if asked nicely', async () => {
-    const res = await execa('linkinator', [
+    const res = await execa(node, [
+      linkinator,
       '--format',
       'csv',
       'test/fixtures/markdown/README.md',
@@ -73,7 +75,8 @@ describe('cli', function () {
   });
 
   it('should provide JSON if asked nicely', async () => {
-    const res = await execa('linkinator', [
+    const res = await execa(node, [
+      linkinator,
       '--format',
       'json',
       'test/fixtures/markdown/README.md',
@@ -83,15 +86,17 @@ describe('cli', function () {
   });
 
   it('should not show links if --silent', async () => {
-    const res = await execa('linkinator', [
+    const res = await execa(node, [
+      linkinator,
       '--silent',
       'test/fixtures/markdown/README.md',
     ]);
     assert.notMatch(res.stdout, /\[/);
   });
 
   it('should not show 200 links if verbosity is ERROR with JSON', async () => {
-    const res = await execa('linkinator', [
+    const res = await execa(node, [
+      linkinator,
       '--verbosity',
       'ERROR',
       '--format',
@@ -105,7 +110,8 @@ describe('cli', function () {
   });
 
   it('should accept a server-root', async () => {
-    const res = await execa('linkinator', [
+    const res = await execa(node, [
+      linkinator,
       '--markdown',
       '--server-root',
       'test/fixtures/markdown',
@@ -115,24 +121,29 @@ describe('cli', function () {
   });
 
   it('should accept globs', async () => {
-    const res = await execa('linkinator', [
+    const res = await execa(node, [
+      linkinator,
       'test/fixtures/markdown/*.md',
       'test/fixtures/markdown/**/*.md',
     ]);
     assert.match(res.stderr, /Successfully scanned/);
   });
 
   it('should throw on invalid format', async () => {
-    const res = await execa('linkinator', ['./README.md', '--format', 'LOL'], {
-      reject: false,
-    });
+    const res = await execa(
+      node,
+      [linkinator, './README.md', '--format', 'LOL'],
+      {
+        reject: false,
+      }
+    );
     assert.match(res.stderr, /FORMAT must be/);
   });
 
   it('should throw on invalid verbosity', async () => {
     const res = await execa(
-      'linkinator',
-      ['./README.md', '--VERBOSITY', 'LOL'],
+      node,
+      [linkinator, './README.md', '--VERBOSITY', 'LOL'],
       {
         reject: false,
       }
@@ -142,8 +153,8 @@ describe('cli', function () {
 
   it('should throw when verbosity and silent are flagged', async () => {
     const res = await execa(
-      'linkinator',
-      ['./README.md', '--verbosity', 'DEBUG', '--silent'],
+      node,
+      [linkinator, './README.md', '--verbosity', 'DEBUG', '--silent'],
       {
         reject: false,
       }
@@ -153,8 +164,8 @@ describe('cli', function () {
 
   it('should show no output for verbosity=NONE', async () => {
     const res = await execa(
-      'linkinator',
-      ['test/fixtures/basic', '--verbosity', 'NONE'],
+      node,
+      [linkinator, 'test/fixtures/basic', '--verbosity', 'NONE'],
       {
         reject: false,
       }
@@ -166,8 +177,8 @@ describe('cli', function () {
 
   it('should show callstacks for verbosity=DEBUG', async () => {
     const res = await execa(
-      'linkinator',
-      ['test/fixtures/basic', '--verbosity', 'DEBUG'],
+      node,
+      [linkinator, 'test/fixtures/basic', '--verbosity', 'DEBUG'],
       {
         reject: false,
       }
@@ -177,7 +188,8 @@ describe('cli', function () {
   });
 
   it('should allow passing a config', async () => {
-    const res = await execa('linkinator', [
+    const res = await execa(node, [
+      linkinator,
       'test/fixtures/basic',
       '--config',
       'test/fixtures/config/skip-array-config.json',
@@ -207,7 +219,8 @@ describe('cli', function () {
     enableDestroy(server);
     await new Promise<void>(r => server.listen(port, r));
 
-    const res = await execa('linkinator', [
+    const res = await execa(node, [
+      linkinator,
       '--retry',
       'test/fixtures/retryCLI',
     ]);