fix: get npm client and install command correctly (#383)

Author: JounQin

.changeset/ready-rules-attack.md

@@ -0,0 +1,5 @@
+---
+"eslint-plugin-import-x": patch
+---
+
+fix: get npm client and install command correctly

src/rules/no-extraneous-dependencies.ts

@@ -13,6 +13,7 @@ import {
   pkgUp,
   importType,
   getFilePackageName,
+  getNpmInstallCommand,
 } from '../utils/index.js'
 
 export type PackageDeps = ReturnType<typeof extractDepFields>
@@ -397,8 +398,7 @@ export default createRule<[Options?], MessageId>({
         "'{{packageName}}' should be listed in the project's dependencies, not devDependencies.",
       optDep:
         "'{{packageName}}' should be listed in the project's dependencies, not optionalDependencies.",
-      missing:
-        "'{{packageName}}' should be listed in the project's dependencies. Run 'npm i -S {{packageName}}' to add it",
+      missing: `'{{packageName}}' should be listed in the project's dependencies. Run '${getNpmInstallCommand('{{packageName}}')}' to add it`,
     },
   },
   defaultOptions: [],

src/types.ts

@@ -156,3 +156,6 @@ export interface Ranks {
 export interface CjsRequire extends NodeJS.Require {
   <T>(id: string): T
 }
+
+export type SetValue<T extends Set<unknown>> =
+  T extends Set<infer U> ? U : never

src/utils/index.ts

@@ -24,6 +24,7 @@ export * from './import-type.js'
 export * from './module-cache.js'
 export * from './module-require.js'
 export * from './module-visitor.js'
+export * from './npm-client.js'
 export * from './lazy-value.js'
 export * from './legacy-resolver-settings.js'
 export * from './package-path.js'

src/utils/npm-client.ts

@@ -0,0 +1,30 @@
+import type { SetValue } from '../types.js'
+
+const NPM = 'npm'
+
+export const NPM_CLIENTS = new Set([
+  NPM,
+  'yarn',
+  'pnpm',
+  'bun',
+  'deno',
+] as const)
+
+export type NpmClient = SetValue<typeof NPM_CLIENTS>
+
+let npmClient: NpmClient | undefined
+
+export const getNpmClient = (): NpmClient => {
+  if (npmClient) {
+    return npmClient
+  }
+
+  const client = process.env.npm_config_user_agent?.split('/')[0]
+
+  npmClient = client && NPM_CLIENTS.has(client) ? (client as NpmClient) : NPM
+
+  return npmClient
+}
+
+export const getNpmInstallCommand = (packageName: string) =>
+  `${getNpmClient()} ${npmClient === NPM ? 'i' : 'add'} ${npmClient === 'deno' ? `${NPM}:` : ''}${packageName}`

test/utils/npm-client.spec.ts

@@ -0,0 +1,39 @@
+import { jest } from '@jest/globals'
+
+import type { NpmClient } from 'eslint-plugin-import-x/utils'
+
+describe('npm-client', () => {
+  let getNpmClient!: () => NpmClient
+  let getNpmInstallCommand!: (packageName: string) => string
+
+  beforeEach(async () => {
+    delete process.env.npm_config_user_agent
+    jest.resetModules()
+    ;({ getNpmClient, getNpmInstallCommand } = await import(
+      'eslint-plugin-import-x/utils'
+    ))
+  })
+
+  it('should return npm as default client', () => {
+    expect(getNpmClient()).toBe('npm')
+    expect(getNpmInstallCommand('foo')).toBe('npm i foo')
+  })
+
+  it('should read npm client from environment variable', () => {
+    process.env.npm_config_user_agent = 'yarn/1.22.10'
+    expect(getNpmClient()).toBe('yarn')
+    expect(getNpmInstallCommand('foo')).toBe('yarn add foo')
+  })
+
+  it('should support deno specially', () => {
+    process.env.npm_config_user_agent = 'deno/1.0.0'
+    expect(getNpmClient()).toBe('deno')
+    expect(getNpmInstallCommand('foo')).toBe('deno add npm:foo')
+  })
+
+  it('should return npm for unknown clients', () => {
+    process.env.npm_config_user_agent = 'unknown'
+    expect(getNpmClient()).toBe('npm')
+    expect(getNpmInstallCommand('foo')).toBe('npm i foo')
+  })
+})