🚨 Lint against extraneous dependencies (#670)

In all circumstances where it matters in this repo, the extraneous dependencies are guaranteed to be
present and resolve to their expected versions. However, to better support Yarn 2+ and any other
potential node loaders that might block on this, this eslint rule will help ensure that packages
only import from their specific dependencies.

.eslintrc

@@ -6,6 +6,7 @@ rules:
   prefer-const: off
   no-unused-expressions: off
   babel/no-unused-expressions: warn
+  import/no-extraneous-dependencies: error
   node/no-callback-literal: off
   promise/param-names: off
   semi: [error, always]

packages/cli-build/package.json

@@ -33,7 +33,6 @@
   "dependencies": {
     "@percy/cli-command": "1.0.0-beta.71",
     "@percy/client": "1.0.0-beta.71",
-    "@percy/env": "1.0.0-beta.71",
     "@percy/logger": "1.0.0-beta.71"
   },
   "repository": {

packages/cli-build/test/.eslintrc

@@ -1,2 +1,4 @@
 env:
   jasmine: true
+rules:
+  import/no-extraneous-dependencies: off

packages/cli-command/package.json

@@ -25,6 +25,7 @@
     "@oclif/command": "^1.8.0",
     "@oclif/config": "^1.17.0",
     "@oclif/plugin-help": "^3.2.0",
+    "@percy/core": "1.0.0-beta.71",
     "@percy/config": "1.0.0-beta.71",
     "@percy/logger": "1.0.0-beta.71"
   },

packages/cli-command/test/.eslintrc

@@ -1,2 +1,4 @@
 env:
   jasmine: true
+rules:
+  import/no-extraneous-dependencies: off

packages/cli-config/test/.eslintrc

@@ -1,2 +1,4 @@
 env:
   jasmine: true
+rules:
+  import/no-extraneous-dependencies: off

packages/cli-exec/src/commands/exec/ping.js

@@ -1,5 +1,5 @@
 import Command, { flags } from '@percy/cli-command';
-import request from '@percy/client/dist/request';
+import { request } from '@percy/core/dist/utils';
 import logger from '@percy/logger';
 import execFlags from '../../flags';
 

packages/cli-exec/src/commands/exec/stop.js

@@ -1,5 +1,5 @@
 import Command, { flags } from '@percy/cli-command';
-import request from '@percy/client/dist/request';
+import { request } from '@percy/core/dist/utils';
 import logger from '@percy/logger';
 import execFlags from '../../flags';
 

packages/cli-exec/src/hooks/init.js

@@ -1,3 +1,4 @@
+/* eslint-disable import/no-extraneous-dependencies */
 import PercyConfig from '@percy/config';
 import * as CoreConfig from '@percy/core/dist/config';
 

packages/cli-exec/test/.eslintrc

@@ -1,2 +1,4 @@
 env:
   jasmine: true
+rules:
+  import/no-extraneous-dependencies: off

packages/cli-exec/test/helpers.js

@@ -1,10 +1,7 @@
-import logger from '@percy/logger/test/helpers';
-import mockAPI from '@percy/client/test/helpers';
+import { logger, mockAPI } from '@percy/core/test/helpers';
 
 beforeEach(() => {
   process.env.PERCY_TOKEN = '<<PERCY_TOKEN>>';
-  mockAPI.start();
-  logger.mock();
 });
 
 afterEach(() => {

packages/cli-exec/test/start.test.js

@@ -1,4 +1,4 @@
-import request from '@percy/client/dist/request';
+import { request } from '@percy/core/dist/utils';
 import { logger } from './helpers';
 import { Start } from '../src/commands/exec/start';
 import { Stop } from '../src/commands/exec/stop';

packages/cli-snapshot/package.json

@@ -32,7 +32,6 @@
     "@percy/cli-command": "1.0.0-beta.71",
     "@percy/config": "1.0.0-beta.71",
     "@percy/core": "1.0.0-beta.71",
-    "@percy/dom": "1.0.0-beta.71",
     "@percy/logger": "1.0.0-beta.71",
     "globby": "^11.0.4",
     "path-to-regexp": "^6.2.0",

packages/cli-snapshot/src/commands/snapshot.js

@@ -2,8 +2,8 @@ import fs from 'fs';
 import path from 'path';
 import PercyConfig from '@percy/config';
 import Command, { flags } from '@percy/cli-command';
-import request from '@percy/client/dist/request';
 import Percy from '@percy/core';
+import { request } from '@percy/core/dist/utils';
 import logger from '@percy/logger';
 import globby from 'globby';
 import YAML from 'yaml';

packages/cli-snapshot/test/.eslintrc

@@ -1,2 +1,4 @@
 env:
   jasmine: true
+rules:
+  import/no-extraneous-dependencies: off

packages/cli-snapshot/test/directory.test.js

@@ -2,8 +2,7 @@ import fs from 'fs';
 import path from 'path';
 import rimraf from 'rimraf';
 import PercyConfig from '@percy/config';
-import mockAPI from '@percy/client/test/helpers';
-import logger from '@percy/logger/test/helpers';
+import { logger, mockAPI } from '@percy/core/test/helpers';
 import { Snapshot } from '../src/commands/snapshot';
 
 describe('percy snapshot <directory>', () => {

packages/cli-snapshot/test/file.test.js

@@ -2,9 +2,7 @@ import fs from 'fs';
 import path from 'path';
 import { inspect } from 'util';
 import rimraf from 'rimraf';
-import mockAPI from '@percy/client/test/helpers';
-import logger from '@percy/logger/test/helpers';
-import { createTestServer } from '@percy/core/test/helpers';
+import { logger, mockAPI, createTestServer } from '@percy/core/test/helpers';
 import { Snapshot } from '../src/commands/snapshot';
 
 describe('percy snapshot <file>', () => {

packages/cli-snapshot/test/sitemap.test.js

@@ -1,9 +1,7 @@
 import fs from 'fs';
 import path from 'path';
 import rimraf from 'rimraf';
-import mockAPI from '@percy/client/test/helpers';
-import logger from '@percy/logger/test/helpers';
-import { createTestServer } from '@percy/core/test/helpers';
+import { logger, mockAPI, createTestServer } from '@percy/core/test/helpers';
 import { Snapshot } from '../src/commands/snapshot';
 
 describe('percy snapshot <sitemap>', () => {

packages/cli-upload/src/commands/upload.js

@@ -5,7 +5,10 @@ import logger from '@percy/logger';
 import globby from 'globby';
 import imageSize from 'image-size';
 import PercyClient from '@percy/client';
+
+// eslint-disable-next-line import/no-extraneous-dependencies
 import Queue from '@percy/core/dist/queue';
+
 import createImageResources from '../resources';
 import { schema } from '../config';
 import pkg from '../../package.json';

packages/cli-upload/test/.eslintrc

@@ -1,2 +1,4 @@
 env:
   jasmine: true
+rules:
+  import/no-extraneous-dependencies: off

packages/cli/package.json

@@ -34,6 +34,7 @@
     ]
   },
   "dependencies": {
+    "@oclif/command": "^1.8.0",
     "@oclif/plugin-help": "^3.2.0",
     "@percy/cli-build": "1.0.0-beta.71",
     "@percy/cli-config": "1.0.0-beta.71",

packages/cli/test/.eslintrc

@@ -1,2 +1,4 @@
 env:
   jasmine: true
+rules:
+  import/no-extraneous-dependencies: off

packages/client/test/.eslintrc

@@ -1,2 +1,4 @@
 env:
   jasmine: true
+rules:
+  import/no-extraneous-dependencies: off

packages/config/test/.eslintrc

@@ -1,2 +1,4 @@
 env:
   jasmine: true
+rules:
+  import/no-extraneous-dependencies: off

packages/core/test/.eslintrc

@@ -1,5 +1,6 @@
 env:
   jasmine: true
 rules:
+  import/no-extraneous-dependencies: off
   no-return-assign: off
   no-sequences: off

packages/dom/test/.eslintrc

@@ -1,2 +1,4 @@
 env:
   jasmine: true
+rules:
+  import/no-extraneous-dependencies: off

packages/env/test/.eslintrc

@@ -1,2 +1,4 @@
 env:
   jasmine: true
+rules:
+  import/no-extraneous-dependencies: off

packages/logger/test/.eslintrc

@@ -1,2 +1,4 @@
 env:
   jasmine: true
+rules:
+  import/no-extraneous-dependencies: off

packages/sdk-utils/src/percy-enabled.js

@@ -4,16 +4,17 @@ import request from './request';
 
 // Create a socket to connect to a remote logger
 async function connectRemoteLogger() {
-  await logger.remote(() => {
+  await logger.remote(async () => {
     let url = percy.address.replace('http', 'ws');
 
     if (process.env.__PERCY_BROWSERIFIED__) {
       return new window.WebSocket(url);
     } else {
-      let socket = new (require('ws'))(url);
+      /* eslint-disable-next-line import/no-extraneous-dependencies */
+      let { default: WebSocket } = await import('ws');
+      let ws = new WebSocket(url);
       // allow node to exit with an active connection
-      socket.once('open', () => socket._socket.unref());
-      return socket;
+      return ws.once('open', () => ws._socket.unref());
     }
   });
 }

packages/sdk-utils/test/.eslintrc

@@ -1,2 +1,4 @@
 env:
   jasmine: true
+rules:
+  import/no-extraneous-dependencies: off

scripts/build.js

@@ -1,6 +1,7 @@
+/* eslint-disable import/no-extraneous-dependencies */
 const cwd = process.cwd();
 const path = require('path');
-const colors = require('colors');
+const colors = require('colors/safe');
 
 process.env.NODE_ENV = 'production';
 

scripts/test-helpers.js

@@ -1,4 +1,5 @@
 /* eslint-env jasmine */
+/* eslint-disable import/no-extraneous-dependencies */
 
 beforeAll(() => {
   // default timeout to 10s

scripts/test.js

@@ -1,3 +1,4 @@
+/* eslint-disable import/no-extraneous-dependencies */
 const cwd = process.cwd();
 const path = require('path');
 const colors = require('colors/safe');

scripts/watch.js

@@ -1,6 +1,7 @@
+/* eslint-disable import/no-extraneous-dependencies */
 const path = require('path');
 const { readFileSync } = require('fs');
-const colors = require('colors');
+const colors = require('colors/safe');
 const gaze = require('gaze');
 
 // executes the callback when files within the current working directory have been modified