fix: only check engine-mismatch in package.json

Author: 9romise

src/commands/open-file-in-npmx.ts

@@ -1,7 +1,7 @@
 import { PACKAGE_JSON_BASENAME } from '#constants'
 import { logger } from '#state'
+import { readPackageManifest } from '#utils/file'
 import { npmxFileUrl } from '#utils/links'
-import { resolvePackageJson } from '#utils/resolve'
 import { env, Uri, window } from 'vscode'
 import { findUp } from 'vscode-find-up'
 
@@ -27,7 +27,7 @@ export async function openFileInNpmx(fileUri?: Uri) {
   const pkgJsonUri = await findUp(PACKAGE_JSON_BASENAME, {
     cwd: uri,
   })
-  const manifest = pkgJsonUri ? await resolvePackageJson(pkgJsonUri) : undefined
+  const manifest = pkgJsonUri ? await readPackageManifest(pkgJsonUri) : undefined
   if (!pkgJsonUri || !manifest) {
     logger.warn(`Could not resolve npmx url: ${uri.toString()}`)
     window.showWarningMessage(`npmx: Could not find package.json for ${uri.toString()}`)

src/providers/diagnostics/index.ts

@@ -21,6 +21,7 @@ import { checkUpgrade } from './rules/upgrade'
 import { checkVulnerability } from './rules/vulnerability'
 
 export interface DiagnosticContext {
+  uri: Uri
   dep: DependencyInfo
   name: string
   pkg: PackageInfo
@@ -123,7 +124,7 @@ export function useDiagnostics() {
           : null
 
         for (const rule of rules) {
-          runRule(rule, { dep, name, pkg, parsed, exactVersion, engines })
+          runRule(rule, { uri: document.uri, dep, name, pkg, parsed, exactVersion, engines })
         }
       } catch (err) {
         logger.warn(`[diagnostics] fail to check ${dep.name}: ${err}`)

src/providers/diagnostics/rules/engine-mismatch.ts

@@ -1,5 +1,6 @@
 import type { Engines } from 'fast-npm-meta'
 import type { DiagnosticRule } from '..'
+import { isPackageManifestPath } from '#utils/file'
 import { npmxPackageUrl } from '#utils/links'
 import { formatPackageId } from '#utils/package'
 import Range from 'semver/classes/range'
@@ -46,7 +47,9 @@ export function resolveEngineMismatches(
   return mismatches
 }
 
-export const checkEngineMismatch: DiagnosticRule = ({ dep, name, pkg, parsed, exactVersion, engines }) => {
+export const checkEngineMismatch: DiagnosticRule = ({ uri, dep, name, pkg, parsed, exactVersion, engines }) => {
+  if (!isPackageManifestPath(uri))
+    return
   if (!parsed || !exactVersion || !engines)
     return
 

src/utils/resolve.ts src/utils/file.tssrc/utils/resolve.ts renamed to src/utils/file.ts

@@ -1,6 +1,11 @@
 import type { Uri } from 'vscode'
+import { PACKAGE_JSON_BASENAME } from '#constants'
 import { workspace } from 'vscode'
 
+export function isPackageManifestPath(uri: Uri) {
+  return uri.path.endsWith(`/${PACKAGE_JSON_BASENAME}`)
+}
+
 /** A parsed `package.json` manifest file. */
 interface PackageManifest {
   /** Package name. */
@@ -16,7 +21,7 @@ interface PackageManifest {
  * @returns A promise that resolves to the parsed manifest,
  *     or `undefined` if the file is invalid or missing required fields.
  */
-export async function resolvePackageJson(pkgJsonUri: Uri): Promise<PackageManifest | undefined> {
+export async function readPackageManifest(pkgJsonUri: Uri): Promise<PackageManifest | undefined> {
   try {
     const content = await workspace.fs.readFile(pkgJsonUri)
     const manifest = JSON.parse(new TextDecoder().decode(content)) as PackageManifest

tests/diagnostics/context.ts

@@ -4,6 +4,7 @@ import type { Engines } from 'fast-npm-meta'
 import type { DiagnosticContext } from '../../src/providers/diagnostics'
 import { resolveExactVersion, resolvePackageName } from '#utils/package'
 import { isSupportedProtocol, parseVersion } from '#utils/version'
+import { Uri } from 'vscode'
 
 interface CreateContextOptions {
   name: string
@@ -24,5 +25,5 @@ export function createContext(options: CreateContextOptions): DiagnosticContext
   const exactVersion = parsed && isSupportedProtocol(parsed.protocol)
     ? resolveExactVersion(pkg, parsed.version)
     : null
-  return { dep, name: resolvePackageName(name, parsed), pkg, parsed, exactVersion, engines }
+  return { uri: Uri.file('package.json'), dep, name: resolvePackageName(name, parsed), pkg, parsed, exactVersion, engines }
 }