Calculate suggestion server side

wojtekmaj · wojtekmaj · commit df5823822759 · 2026-02-08T01:11:56.000+01:00
diff --git a/app/components/Terminal/Install.vue b/app/components/Terminal/Install.vue
@@ -1,12 +1,13 @@
 <script setup lang="ts">
 import type { JsrPackageInfo } from '#shared/types/jsr'
+import type { DevDependencySuggestion } from '#shared/utils/dev-dependency'
 import type { PackageManagerId } from '~/utils/install-command'
 
 const props = defineProps<{
   packageName: string
   requestedVersion?: string | null
   jsrInfo?: JsrPackageInfo | null
-  readmeHtml?: string | null
+  devDependencySuggestion?: DevDependencySuggestion | null
   typesPackageName?: string | null
   executableInfo?: { hasExecutable: boolean; primaryCommand?: string } | null
   createPackageInfo?: { packageName: string } | null
@@ -29,8 +30,8 @@ function getInstallPartsForPM(pmId: PackageManagerId) {
   })
 }
 
-const devDependencySuggestion = computed(() =>
-  getDevDependencySuggestion(props.packageName, props.readmeHtml),
+const devDependencySuggestion = computed(
+  () => props.devDependencySuggestion ?? { recommended: false as const },
 )
 
 function getDevInstallPartsForPM(pmId: PackageManagerId) {
diff --git a/app/composables/usePackageAnalysis.ts b/app/composables/usePackageAnalysis.ts
@@ -1,10 +1,12 @@
 import type { ModuleFormat, TypesStatus, CreatePackageInfo } from '#shared/utils/package-analysis'
+import type { DevDependencySuggestion } from '#shared/utils/dev-dependency'
 
 export interface PackageAnalysisResponse {
   package: string
   version: string
   moduleFormat: ModuleFormat
   types: TypesStatus
+  devDependencySuggestion: DevDependencySuggestion
   engines?: {
     node?: string
     npm?: string
diff --git a/app/pages/package/[[org]]/[name].vue b/app/pages/package/[[org]]/[name].vue
@@ -1046,7 +1046,7 @@ onKeyStroke(
             :package-name="pkg.name"
             :requested-version="requestedVersion"
             :jsr-info="jsrInfo"
-            :readme-html="readmeData?.html"
+            :dev-dependency-suggestion="packageAnalysis?.devDependencySuggestion"
             :types-package-name="typesPackageName"
             :executable-info="executableInfo"
             :create-package-info="createPackageInfo"
diff --git a/app/utils/install-command.ts b/app/utils/install-command.ts
@@ -71,111 +71,6 @@ export interface InstallCommandOptions {
   dev?: boolean
 }
 
-export type DevDependencySuggestionReason = 'known-package' | 'readme-hint'
-
-export interface DevDependencySuggestion {
-  recommended: boolean
-  reason?: DevDependencySuggestionReason
-}
-
-const KNOWN_DEV_DEPENDENCY_PACKAGES = new Set<string>([
-  'biome',
-  'chai',
-  'eslint',
-  'esbuild',
-  'husky',
-  'jest',
-  'lint-staged',
-  'mocha',
-  'oxc',
-  'oxfmt',
-  'oxlint',
-  'playwright',
-  'prettier',
-  'rolldown',
-  'rollup',
-  'stylelint',
-  'ts-jest',
-  'ts-node',
-  'tsx',
-  'turbo',
-  'typescript',
-  'vite',
-  'vitest',
-  'webpack',
-])
-
-function isKnownDevDependencyPackage(packageName: string): boolean {
-  const normalized = packageName.toLowerCase()
-  if (normalized.startsWith('@types/')) {
-    return true
-  }
-  // Match scoped packages by name segment, e.g. @scope/eslint-config
-  const namePart = normalized.includes('/') ? normalized.split('/').pop() : normalized
-  if (!namePart) return false
-
-  return (
-    KNOWN_DEV_DEPENDENCY_PACKAGES.has(normalized) ||
-    KNOWN_DEV_DEPENDENCY_PACKAGES.has(namePart) ||
-    normalized.startsWith('@typescript-eslint/') ||
-    namePart.startsWith('eslint-') ||
-    namePart.startsWith('prettier-') ||
-    namePart.startsWith('vite-') ||
-    namePart.startsWith('webpack-') ||
-    namePart.startsWith('babel-')
-  )
-}
-
-function escapeRegExp(text: string): string {
-  return text.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')
-}
-
-function hasReadmeDevInstallHint(packageName: string, readmeHtml?: string | null): boolean {
-  if (!readmeHtml) return false
-
-  const escapedName = escapeRegExp(packageName)
-  const escapedNpmName = escapeRegExp(`npm:${packageName}`)
-  const packageSpec = `(?:${escapedName}|${escapedNpmName})(?:@[\\w.-]+)?`
-
-  const patterns = [
-    // npm install -D pkg / pnpm add --save-dev pkg
-    new RegExp(
-      String.raw`(?:npm|pnpm|yarn|bun|vlt)\s+(?:install|add|i)\s+(?:--save-dev|--dev|-d)\s+${packageSpec}`,
-      'i',
-    ),
-    // npm install pkg --save-dev / pnpm add pkg -D
-    new RegExp(
-      String.raw`(?:npm|pnpm|yarn|bun|vlt)\s+(?:install|add|i)\s+${packageSpec}\s+(?:--save-dev|--dev|-d)`,
-      'i',
-    ),
-    // deno add -D npm:pkg
-    new RegExp(String.raw`deno\s+add\s+(?:--dev|-d)\s+${packageSpec}`, 'i'),
-  ]
-
-  return patterns.some(pattern => pattern.test(readmeHtml))
-}
-
-export function getDevDependencySuggestion(
-  packageName: string,
-  readmeHtml?: string | null,
-): DevDependencySuggestion {
-  if (isKnownDevDependencyPackage(packageName)) {
-    return {
-      recommended: true,
-      reason: 'known-package',
-    }
-  }
-
-  if (hasReadmeDevInstallHint(packageName, readmeHtml)) {
-    return {
-      recommended: true,
-      reason: 'readme-hint',
-    }
-  }
-
-  return { recommended: false }
-}
-
 export function getDevDependencyFlag(packageManager: PackageManagerId): '-D' | '-d' {
   return packageManager === 'bun' ? '-d' : '-D'
 }
diff --git a/server/api/registry/analysis/[...pkg].get.ts b/server/api/registry/analysis/[...pkg].get.ts
@@ -12,6 +12,10 @@ import {
   getCreatePackageName,
   hasBuiltInTypes,
 } from '#shared/utils/package-analysis'
+import {
+  getDevDependencySuggestion,
+  type DevDependencySuggestion,
+} from '#shared/utils/dev-dependency'
 import {
   NPM_REGISTRY,
   CACHE_MAX_AGE_ONE_DAY,
@@ -54,10 +58,12 @@ export default defineCachedEventHandler(
       const createPackage = await findAssociatedCreatePackage(packageName, pkg)
 
       const analysis = analyzePackage(pkg, { typesPackage, createPackage })
+      const devDependencySuggestion = getDevDependencySuggestion(packageName, pkg.readme)
 
       return {
         package: packageName,
         version: pkg.version ?? version ?? 'latest',
+        devDependencySuggestion,
         ...analysis,
       } satisfies PackageAnalysisResponse
     } catch (error: unknown) {
@@ -72,7 +78,7 @@ export default defineCachedEventHandler(
     swr: true,
     getKey: event => {
       const pkg = getRouterParam(event, 'pkg') ?? ''
-      return `analysis:v1:${pkg.replace(/\/+$/, '').trim()}`
+      return `analysis:v2:${pkg.replace(/\/+$/, '').trim()}`
     },
   },
 )
@@ -209,4 +215,5 @@ function hasSameRepositoryOwner(
 export interface PackageAnalysisResponse extends PackageAnalysis {
   package: string
   version: string
+  devDependencySuggestion: DevDependencySuggestion
 }
diff --git a/shared/utils/dev-dependency.ts b/shared/utils/dev-dependency.ts
@@ -0,0 +1,110 @@
+export type DevDependencySuggestionReason = 'known-package' | 'readme-hint'
+
+export interface DevDependencySuggestion {
+  recommended: boolean
+  reason?: DevDependencySuggestionReason
+}
+
+const KNOWN_DEV_DEPENDENCY_PACKAGES = new Set<string>([
+  'biome',
+  'chai',
+  'eslint',
+  'esbuild',
+  'husky',
+  'jest',
+  'lint-staged',
+  'mocha',
+  'oxc',
+  'oxfmt',
+  'oxlint',
+  'playwright',
+  'prettier',
+  'rolldown',
+  'rollup',
+  'stylelint',
+  'ts-jest',
+  'ts-node',
+  'tsx',
+  'turbo',
+  'typescript',
+  'vite',
+  'vitest',
+  'webpack',
+])
+
+const KNOWN_DEV_DEPENDENCY_PACKAGE_PREFIXES = [
+  '@typescript-eslint/',
+  'eslint-',
+  'prettier-',
+  'vite-',
+  'webpack-',
+  'babel-',
+]
+
+function isKnownDevDependencyPackage(packageName: string): boolean {
+  const normalized = packageName.toLowerCase()
+  if (normalized.startsWith('@types/')) {
+    return true
+  }
+  // Match scoped packages by name segment, e.g. @scope/eslint-config
+  const namePart = normalized.includes('/') ? normalized.split('/').pop() : normalized
+  if (!namePart) return false
+
+  return (
+    KNOWN_DEV_DEPENDENCY_PACKAGES.has(normalized) ||
+    KNOWN_DEV_DEPENDENCY_PACKAGES.has(namePart) ||
+    KNOWN_DEV_DEPENDENCY_PACKAGE_PREFIXES.some(prefix =>
+      prefix.startsWith('@') ? normalized.startsWith(prefix) : namePart.startsWith(prefix),
+    )
+  )
+}
+
+function escapeRegExp(text: string): string {
+  return text.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')
+}
+
+function hasReadmeDevInstallHint(packageName: string, readmeContent?: string | null): boolean {
+  if (!readmeContent) return false
+
+  const escapedName = escapeRegExp(packageName)
+  const escapedNpmName = escapeRegExp(`npm:${packageName}`)
+  const packageSpec = `(?:${escapedName}|${escapedNpmName})(?:@[\\w.-]+)?`
+
+  const patterns = [
+    // npm install -D pkg / pnpm add --save-dev pkg
+    new RegExp(
+      String.raw`(?:npm|pnpm|yarn|bun|vlt)\s+(?:install|add|i)\s+(?:--save-dev|--dev|-d)\s+${packageSpec}`,
+      'i',
+    ),
+    // npm install pkg --save-dev / pnpm add pkg -D
+    new RegExp(
+      String.raw`(?:npm|pnpm|yarn|bun|vlt)\s+(?:install|add|i)\s+${packageSpec}\s+(?:--save-dev|--dev|-d)`,
+      'i',
+    ),
+    // deno add -D npm:pkg
+    new RegExp(String.raw`deno\s+add\s+(?:--dev|-D)\s+${packageSpec}`, 'i'),
+  ]
+
+  return patterns.some(pattern => pattern.test(readmeContent))
+}
+
+export function getDevDependencySuggestion(
+  packageName: string,
+  readmeContent?: string | null,
+): DevDependencySuggestion {
+  if (isKnownDevDependencyPackage(packageName)) {
+    return {
+      recommended: true,
+      reason: 'known-package',
+    }
+  }
+
+  if (hasReadmeDevInstallHint(packageName, readmeContent)) {
+    return {
+      recommended: true,
+      reason: 'readme-hint',
+    }
+  }
+
+  return { recommended: false }
+}
diff --git a/shared/utils/package-analysis.ts b/shared/utils/package-analysis.ts
@@ -34,6 +34,8 @@ export interface ExtendedPackageJson {
   dependencies?: Record<string, string>
   devDependencies?: Record<string, string>
   peerDependencies?: Record<string, string>
+  readme?: string
+  readmeFilename?: string
   /** npm maintainers (returned by registry API) */
   maintainers?: Array<{ name: string; email?: string }>
   /** Repository info (returned by registry API) */
diff --git a/test/unit/app/utils/install-command.spec.ts b/test/unit/app/utils/install-command.spec.ts
@@ -5,7 +5,6 @@ import {
   getPackageSpecifier,
   getExecuteCommand,
   getExecuteCommandParts,
-  getDevDependencySuggestion,
   getDevDependencyFlag,
 } from '../../../../app/utils/install-command'
 import type { JsrPackageInfo } from '../../../../shared/types/jsr'
@@ -285,55 +284,6 @@ describe('install command generation', () => {
     })
   })
 
-  describe('dev dependency suggestion heuristic', () => {
-    it('suggests dev dependency for known tooling packages', () => {
-      expect(getDevDependencySuggestion('eslint')).toEqual({
-        recommended: true,
-        reason: 'known-package',
-      })
-      expect(getDevDependencySuggestion('@types/node')).toEqual({
-        recommended: true,
-        reason: 'known-package',
-      })
-      expect(getDevDependencySuggestion('@typescript-eslint/parser')).toEqual({
-        recommended: true,
-        reason: 'known-package',
-      })
-    })
-
-    it('suggests dev dependency from README install command hints', () => {
-      const readmeHtml = '<p>Install with <code>npm install --save-dev some-tool</code></p>'
-
-      expect(getDevDependencySuggestion('some-tool', readmeHtml)).toEqual({
-        recommended: true,
-        reason: 'readme-hint',
-      })
-    })
-
-    it('suggests dev dependency from README --dev flag hints', () => {
-      const readmeHtml = '<p><code>yarn add --dev some-tool</code></p>'
-
-      expect(getDevDependencySuggestion('some-tool', readmeHtml)).toEqual({
-        recommended: true,
-        reason: 'readme-hint',
-      })
-    })
-
-    it('does not suggest dev dependency for runtime packages without hints', () => {
-      expect(getDevDependencySuggestion('react')).toEqual({
-        recommended: false,
-      })
-    })
-
-    it('does not suggest dev dependency when README hint targets a different package', () => {
-      const readmeHtml = '<p>Install with <code>yarn add -D bar</code></p>'
-
-      expect(getDevDependencySuggestion('foo', readmeHtml)).toEqual({
-        recommended: false,
-      })
-    })
-  })
-
   describe('getDevDependencyFlag', () => {
     it('returns lowercase flag only for bun', () => {
       expect(getDevDependencyFlag('bun')).toBe('-d')
diff --git a/test/unit/shared/utils/dev-dependency.spec.ts b/test/unit/shared/utils/dev-dependency.spec.ts
