Detect private and workspace packages

Author: jdalton

src/commands/optimize.ts

@@ -234,11 +234,13 @@ const modifyManifestByAgent: Record<Agent, ModifyManifest> = (() => {
 
 type AddOverridesConfig = {
   agent: Agent
+  isPrivate: boolean
+  isWorkspace: boolean
   lockSrc: string
   lockIncludes: LockIncludes
-  pkgPath: string
-  pkgJson: PackageJSONObject
+  pkgJsonPath: string
   pkgJsonStr: string
+  pkgJson: PackageJSONObject
   overrides?: Overrides | undefined
 }
 
@@ -250,9 +252,11 @@ type AddOverridesState = {
 async function addOverrides(
   {
     agent,
+    isPrivate,
+    isWorkspace,
     lockSrc,
     lockIncludes,
-    pkgPath,
+    pkgJsonPath,
     pkgJson,
     overrides
   }: AddOverridesConfig,
@@ -288,7 +292,9 @@ async function addOverrides(
           null,
           2
         )
-    await writeFileUtf8(pkgPath, aoState.output)
+    if (!isPrivate && !isWorkspace) {
+    }
+    await writeFileUtf8(pkgJsonPath, aoState.output)
   }
   return aoState
 }
@@ -303,15 +309,23 @@ export const optimize: CliSubcommand = {
       importMeta
     )
     if (commandContext) {
-      const { agent, lockSrc, pkgJson, pkgPath, pkgJsonStr, supported } =
-        await detect({
-          cwd: process.cwd(),
-          onUnknown: (pkgManager: string | undefined) => {
-            console.log(
-              `⚠️ Unknown package manager${pkgManager ? ` ${pkgManager}` : ''}: Defaulting to npm`
-            )
-          }
-        })
+      const {
+        agent,
+        isPrivate,
+        isWorkspace,
+        lockSrc,
+        pkgJsonPath,
+        pkgJsonStr,
+        pkgJson,
+        supported
+      } = await detect({
+        cwd: process.cwd(),
+        onUnknown(pkgManager: string | undefined) {
+          console.log(
+            `⚠️ Unknown package manager${pkgManager ? ` ${pkgManager}` : ''}: Defaulting to npm`
+          )
+        }
+      })
       if (!supported) {
         console.log('✘ The engines.node range is not supported.')
         return
@@ -355,10 +369,12 @@ export const optimize: CliSubcommand = {
           await addOverrides(
             <AddOverridesConfig>{
               __proto__: null,
+              isPrivate,
+              isWorkspace,
               lockSrc,
-              pkgPath,
-              pkgJson,
+              pkgJsonPath,
               pkgJsonStr,
+              pkgJson,
               ...config
             },
             aoState

src/utils/package-manager-detector.ts

@@ -53,10 +53,12 @@ export type DetectOptions = {
 export type DetectResult = Readonly<{
   agent: AgentPlusBun
   agentVersion: string | undefined
+  isPrivate: boolean
+  isWorkspace: boolean
   lockPath: string | undefined
   lockSrc: string | undefined
   pkgJson: PackageJSONObject | undefined
-  pkgPath: string | undefined
+  pkgJsonPath: string | undefined
   pkgJsonStr: string | undefined
   supported: boolean
   targets: {
@@ -104,14 +106,14 @@ export async function detect({
   const lockPath = await findUp(Object.keys(LOCKS), { cwd })
   const isHiddenLockFile = lockPath?.endsWith('.package-lock.json') ?? false
 
-  const pkgPath = lockPath
+  const pkgJsonPath = lockPath
     ? path.resolve(lockPath, `${isHiddenLockFile ? '../' : ''}../package.json`)
     : await findUp('package.json', { cwd })
 
   // Read Corepack `packageManager` field in package.json:
   // https://nodejs.org/api/packages.html#packagemanager
-  const pkgJsonStr = existsSync(pkgPath)
-    ? await readFileUtf8(pkgPath)
+  const pkgJsonStr = existsSync(pkgJsonPath)
+    ? await readFileUtf8(pkgJsonPath)
     : undefined
 
   const pkgJson =
@@ -128,12 +130,14 @@ export async function detect({
   let agent: AgentPlusBun | undefined
   let agentVersion: string | undefined
   if (pkgManager) {
-    const parts = pkgManager.split('@')
-    const name = <AgentPlusBun>parts[0]
-    const maybeVersion = parts.length > 1 ? parts[1] : undefined
-    if (maybeVersion && AGENTS.includes(name)) {
-      agent = name
-      agentVersion = maybeVersion
+    const atSignIndex = pkgManager.lastIndexOf('@')
+    if (atSignIndex !== -1) {
+      const name = <AgentPlusBun>pkgManager.slice(0, atSignIndex)
+      const version = pkgManager.slice(atSignIndex + 1)
+      if (version && AGENTS.includes(name)) {
+        agent = name
+        agentVersion = version
+      }
     }
   }
   if (
@@ -154,7 +158,16 @@ export async function detect({
     node: true
   }
 
+  let isPrivate = false
+  let isWorkspace = false
   if (pkgJson) {
+    const pkgPath = path.dirname(pkgJsonPath!)
+    isPrivate = !!pkgJson['private']
+    isWorkspace =
+      !!pkgJson['workspaces'] ||
+      (agent === 'pnpm' &&
+        existsSync(path.join(pkgPath, 'pnpm-workspace.yaml')))
+
     let browser: boolean | undefined
     let node: boolean | undefined
     const browserField = getOwn(pkgJson, 'browser')
@@ -195,10 +208,12 @@ export async function detect({
   return <DetectResult>{
     agent,
     agentVersion,
+    isPrivate,
+    isWorkspace,
     lockPath,
     lockSrc,
     pkgJson,
-    pkgPath,
+    pkgJsonPath,
     pkgJsonStr,
     supported: targets.browser || targets.node,
     targets