feat: eliminate "which" dependency

justinmk · justinmk · commit 77282c5fd659 · 2024-03-16T19:34:29.000+01:00
Use findNvim() instead of "which".
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/integration-tests/CHANGELOG.md b/packages/integration-tests/CHANGELOG.md
diff --git a/packages/integration-tests/README.md b/packages/integration-tests/README.md
@@ -0,0 +1 @@
+TODO: why is this a separate project? move this to packages/neovim
diff --git a/packages/integration-tests/__tests__/integration.test.ts b/packages/integration-tests/__tests__/integration.test.ts
@@ -4,7 +4,7 @@ import * as fs from 'fs';
 import * as path from 'path';
 import * as http from 'http';
 
-import { NeovimClient, attach } from 'neovim';
+import { NeovimClient, attach, findNvim } from 'neovim';
 
 describe('Node host', () => {
   const testdir = process.cwd();
@@ -36,10 +36,18 @@ describe('Node host', () => {
     let g:node_host_prog = '${path.resolve(plugdir, '../../neovim/bin/cli')}'
       `
     );
-    cp.spawnSync('nvim', args);
+
+    const minVersion = '0.9.5'
+    const nvimInfo = findNvim({ minVersion: minVersion });
+    const nvimPath = nvimInfo.matches[0]?.path;
+    if (!nvimPath) {
+      throw new Error(`nvim ${minVersion} not found`)
+    }
+
+    cp.spawnSync(nvimPath, args);
 
     proc = cp.spawn(
-      'nvim',
+      nvimPath,
       ['-u', nvimrc, '-i', 'NONE', '--headless', '--embed', '-n'],
       {}
     );
diff --git a/packages/neovim/package.json b/packages/neovim/package.json
@@ -59,14 +59,12 @@
     "@babel/preset-typescript": "^7.23.3",
     "@types/jest": "^29.5.12",
     "@types/node": "16.9.x",
-    "@types/which": "^3.0.3",
     "babel-jest": "^29.7.0",
     "jest": "^29.7.0",
     "jest-haste-map": "^29.7.0",
     "jest-resolve": "^29.6.1",
     "typedoc": "^0.25.7",
-    "typescript": "^5.3.3",
-    "which": "^4.0.0"
+    "typescript": "^5.3.3"
   },
   "scripts": {
     "doc": "typedoc --out doc --exclude '**/*.test.ts' src",
diff --git a/packages/neovim/src/api/Buffer.test.ts b/packages/neovim/src/api/Buffer.test.ts
@@ -1,6 +1,4 @@
 /* eslint-env jest */
-// eslint-disable-next-line import/no-extraneous-dependencies
-import * as which from 'which';
 import * as testUtil from '../testUtil';
 
 function wait(ms: number): Promise<void> {
@@ -11,17 +9,6 @@ function wait(ms: number): Promise<void> {
   });
 }
 
-try {
-  which.sync('nvim');
-} catch (e) {
-  // eslint-disable-next-line no-console
-  console.error(
-    'A Neovim installation is required to run the tests',
-    '(see https://github.com/neovim/neovim/wiki/Installing)'
-  );
-  process.exit(1);
-}
-
 describe('Buffer API', () => {
   let nvim: ReturnType<typeof testUtil.getNvim>;
 
@@ -405,7 +392,7 @@ describe('Buffer event updates', () => {
   });
 
   afterAll(() => {
-    testUtil.startNvim2();
+    testUtil.stopNvim2();
   });
 
   beforeEach(async () => {
diff --git a/packages/neovim/src/api/Neovim.test.ts b/packages/neovim/src/api/Neovim.test.ts
@@ -1,21 +1,8 @@
 /* eslint-env jest */
 import * as path from 'node:path';
-// eslint-disable-next-line import/no-extraneous-dependencies
-import * as which from 'which';
 import { Neovim } from './Neovim';
 import * as testUtil from '../testUtil';
 
-try {
-  which.sync('nvim');
-} catch (e) {
-  // eslint-disable-next-line no-console
-  console.error(
-    'A Neovim installation is required to run the tests',
-    '(see https://github.com/neovim/neovim/wiki/Installing)'
-  );
-  process.exit(1);
-}
-
 describe('Neovim API', () => {
   let nvim: ReturnType<typeof testUtil.getNvim>;
 
diff --git a/packages/neovim/src/api/Tabpage.test.ts b/packages/neovim/src/api/Tabpage.test.ts
@@ -1,19 +1,6 @@
 /* eslint-env jest */
-// eslint-disable-next-line import/no-extraneous-dependencies
-import * as which from 'which';
 import * as testUtil from '../testUtil';
 
-try {
-  which.sync('nvim');
-} catch (e) {
-  // eslint-disable-next-line no-console
-  console.error(
-    'A Neovim installation is required to run the tests',
-    '(see https://github.com/neovim/neovim/blob/master/INSTALL.md)'
-  );
-  process.exit(1);
-}
-
 describe('Tabpage API', () => {
   let nvim: ReturnType<typeof testUtil.getNvim>;
 
diff --git a/packages/neovim/src/api/Window.test.ts b/packages/neovim/src/api/Window.test.ts
@@ -1,19 +1,6 @@
 /* eslint-env jest */
-// eslint-disable-next-line import/no-extraneous-dependencies
-import * as which from 'which';
 import * as testUtil from '../testUtil';
 
-try {
-  which.sync('nvim');
-} catch (e) {
-  // eslint-disable-next-line no-console
-  console.error(
-    'A Neovim installation is required to run the tests',
-    '(see https://github.com/neovim/neovim/wiki/Installing)'
-  );
-  process.exit(1);
-}
-
 describe('Window API', () => {
   let nvim: ReturnType<typeof testUtil.getNvim>;
 
diff --git a/packages/neovim/src/attach/attach.test.ts b/packages/neovim/src/attach/attach.test.ts
@@ -1,21 +1,8 @@
 /* eslint-env jest */
-// eslint-disable-next-line import/no-extraneous-dependencies
-import * as which from 'which';
 import { attach } from './attach';
 import { Logger } from '../utils/logger';
 import * as testUtil from '../testUtil';
 
-try {
-  which.sync('nvim');
-} catch (e) {
-  // eslint-disable-next-line no-console
-  console.error(
-    'A Neovim installation is required to run the tests',
-    '(see https://github.com/neovim/neovim/wiki/Installing)'
-  );
-  process.exit(1);
-}
-
 describe('Nvim API', () => {
   let nvim: ReturnType<typeof testUtil.getNvim>;
   let requests;
diff --git a/packages/neovim/src/testSetup.ts b/packages/neovim/src/testSetup.ts
@@ -0,0 +1,5 @@
+// Global test setup. Runs before each test.
+
+import { findNvimOrFail } from './testUtil';
+
+findNvimOrFail();
diff --git a/packages/neovim/src/testUtil.ts b/packages/neovim/src/testUtil.ts
@@ -1,6 +1,7 @@
 import * as cp from 'node:child_process';
 import { NeovimClient } from './api/client';
 import { attach } from './attach';
+import { findNvim } from './utils/findNvim';
 
 let proc: cp.ChildProcessWithoutNullStreams;
 let nvim: NeovimClient;
@@ -49,6 +50,15 @@ export function stopNvim2(): void {
   stopNvim(nvim);
 }
 
+export function findNvimOrFail() {
+  const minVersion = '0.9.5';
+  const found = findNvim({ minVersion });
+  if (found.matches.length === 0) {
+    throw new Error(`nvim ${minVersion} not found`);
+  }
+  return found.matches[0].path;
+}
+
 // beforeAll(async () => {
 //   [proc, nvim] = testUtil.startNvim();
 // });
diff --git a/packages/neovim/src/utils/findNvim.test.ts b/packages/neovim/src/utils/findNvim.test.ts
@@ -1,20 +1,9 @@
 /* eslint-env jest */
-// eslint-disable-next-line import/no-extraneous-dependencies
-import which from 'which';
 import { findNvim, exportsForTesting, FindNvimResult } from './findNvim';
 
 const parseVersion = exportsForTesting.parseVersion;
 const compareVersions = exportsForTesting.compareVersions;
 
-try {
-  which.sync('nvim');
-} catch (e) {
-  // eslint-disable-next-line no-console
-  throw new Error(
-    'Nvim is required to run the tests (see https://github.com/neovim/neovim/wiki/Installing)'
-  );
-}
-
 describe('findNvim', () => {
   it('parseVersion()', () => {
     expect(parseVersion('0.5.0-dev+1357-g192f89ea1')).toEqual([

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+TODO: why is this a separate project? move this to packages/neovim`