Add guidance for plugins vs config options in emitters #8982
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added a new section in the emitters-basics documentation explaining when to use plugins versus configuration options. This includes: - Clear definitions of plugins (composable visitor sets for specific scenarios) - When to use config options (independent toggleable features) - Best practices for avoiding unnecessary configuration - Practical examples to help emitter authors make the right choice Co-authored-by: JoshLove-msft <[email protected]>
Copilot
AI
changed the title
[WIP] Add guidance on using plugins versus config options
Add guidance for plugins vs config options in emitters
Nov 12, 2025
Copilot finished work on behalf of
JoshLove-msft
November 12, 2025 00:02
| - The feature has trade-offs that different users might evaluate differently | ||
| - Backward compatibility requires making a change opt-in | ||
|
|
||
| For example, if you're adding support for generating additional utility functions, consider whether this should be: |
| **Best practice:** Whenever possible, enable features by default without requiring configuration. Only add configuration when: | ||
|
|
||
| - Different users have genuinely different needs or preferences | ||
| - The feature has trade-offs that different users might evaluate differently |
As requested in PR feedback, removed the example section (lines 159-163) that didn't provide clear guidance on which route to take. Co-authored-by: JoshLove-msft <[email protected]>
Removed the unclear "trade-offs" line from best practices as it didn't provide actionable guidance. Co-authored-by: JoshLove-msft <[email protected]>
Copilot finished work on behalf of
JoshLove-msft
November 12, 2025 00:10
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
✅ Completed: Add guidance for plugins vs config options in emitters
Summary
Added a new "Plugins vs. config options" section to the emitters-basics documentation (placed after "Emitter options vs. decorators" section). The guidance includes:
Plugins
Composable sets of visitors/components for specific scenarios:
Config Options
Independent flags that can be mixed and matched:
Best Practice
Enable features by default; only add configuration when:
Updates:
Original prompt
💡 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.