fix(agent-cli): add pnpm compatibility by following symlinks in node_modules #5214
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
When running
pnpm exec @db-ux/agent-cli, the tool would not detect or process@db-uxpackages, leaving the.github/copilot-instructions.mdfile empty or unchanged. This was because pnpm uses a uniquenode_modulesstructure with symlinks to manage dependencies efficiently, and the CLI was not following these symlinks.Root Cause
The issue stemmed from using Node.js's
Dirent.isDirectory()method, which returnsfalsefor symlinks even when they point to directories. In pnpm's structure, packages innode_modules/@db-ux/are symlinks to the actual package locations in.pnpm/, so they were being skipped:Solution
Modified the code to use
fs.statSync()instead ofDirent.isDirectory(). ThestatSync()method follows symlinks by default, correctly identifying symlinked directories:findAllNodeModulesDirectories()- Now usesfs.statSync()to detect directories while following symlinksgenerateCopilot()- Now usesfs.statSync()for package directory detectionTesting
Compatibility
This fix maintains full backward compatibility with npm and yarn while adding pnpm support. The tool now works seamlessly with all major Node.js package managers.
Documentation
Updated README.md with pnpm usage example and added a note about package manager compatibility.
Fixes #[issue-number]
Original prompt
Fixes #5202
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.