KeywordOwners VSCode Extension

Features:

• Syntax Highlighting for KEYWORDOWNERS files
  • Groups and Users
  • GitHub Teams (@@GitHubTeam:team-slug)
  • Comments and Tasks
  • Exclusions
  • Required reviewers with required() syntax
  • additionalReviewersToSatisfyRequirement parameter
• Collapsible Sections
• Code Completion for:
  • Groups
  • Users
  • GitHub Teams
  • Comments and Tasks
  • Exclusions
  • required() function
  • additionalReviewersToSatisfyRequirement parameter inside required()
• Hover Context for:
  • Groups (shows members and additional reviewers if applicable)
  • GitHub Teams (shows team info and additional reviewers if applicable)
  • Comments and Tasks
  • Exclusions

Usage Examples:

Required Reviewers

*.py required(@user1)                    # User must approve
*.py required(@@security-team)           # Any member of group must approve
*.py required(@@GitHubTeam:dev-team)     # Any member of GitHub team must approve

Additional Reviewers to Satisfy Requirement

Allow alternative reviewers to satisfy a requirement:

*.py required(@lead, additionalReviewersToSatisfyRequirement=[@backup1, @backup2])
*.py required(@@team1, additionalReviewersToSatisfyRequirement=[@@team2, @@GitHubTeam:backup-team])

Any reviewer from the primary list OR the additional list can satisfy the requirement.

GitHub Teams Autocomplete

The extension can fetch and cache GitHub teams from your organization for autocomplete suggestions.

Note: This feature is enabled by default. You can disable it in settings if you prefer not to use it.

Setup:

1. Authenticate: When you first open a KEYWORDOWNERS file, you'll be prompted to sign in to GitHub
   • Click "Sign In" to enable GitHub teams autocomplete
   • Click "Disable Feature" to turn off this feature and open settings
2. Manual Control: You can toggle keywordowners.enableGitHubTeams in VSCode settings (default: true)
3. Auto-refresh: Teams are automatically fetched when you open a KEYWORDOWNERS file (cached for 24 hours)
4. Organization Detection: The extension automatically detects your GitHub org from your Git remote URL (no configuration needed!)
   • If auto-detection fails, you must set keywordowners.githubOrg in settings

Manual Commands:

• Refresh GitHub Teams: Cmd/Ctrl+Shift+P → "KeywordOwners: Refresh GitHub Teams"
• Clear Cache: Cmd/Ctrl+Shift+P → "KeywordOwners: Clear GitHub Teams Cache"

How it works:

• Type @@ → See regular groups and GitHubTeam: option
• Select or type @@GitHubTeam: → See actual team names from your GitHub org
• Teams show their full name and description in autocomplete
• Cache is stored locally and refreshed automatically every 24 hours
• Two-stage autocomplete prevents overwhelming the initial @@ suggestions

Privacy & Control:

• Set keywordowners.enableGitHubTeams to false to completely disable GitHub API calls
• When disabled, you can still manually type @@GitHubTeam:team-slug (just no autocomplete)
• Cache is stored locally in VSCode's global state (not synced)