Document TypeScript binder and symbols system #17
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.
This PR adds comprehensive technical documentation explaining how TypeScript's binder and symbols work internally. The documentation covers the core concepts needed to understand symbol resolution and name lookup behavior.
What's Added
Technical Documentation in
.github/copilot-library.md
The new documentation explains:
flags
,escapedName
,declarations
,members
,exports
)resolveName
works with context-sensitive scope chain walkingKey Example Explained
The documentation thoroughly explains the classic name shadowing example:
Shows how:
x
resolves to the global type alias (number
)x
resolves to the function parameter (string
)Validation Test Case
Added
tests/cases/compiler/symbolsDocumentationTest.ts
demonstrating:The test baselines clearly show how the same name resolves to different symbols based on context and scope.
Additional Improvements
.github/copilot-questions.md
about complex symbol merging scenariosThis documentation enables developers to understand the finer points of how
resolveName
works and debug complex symbol resolution issues.Fixes #16.
💡 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.