Skip to content

samirg1/platform-prop-badges

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Platform Prop Badges

Visual Studio Marketplace Downloads Visual Studio Marketplace Version Visual Studio Marketplace Rating (Stars)

A VS Code extension that adds platform badges before property names when docs indicate they are platform-specific.

Badge Legend

Badge Meaning
iOS iOS-only
Android Android-only
Web Web-only

Example

Platform Prop Badges Example

How Detection Works

The extension uses IntelliSense hover/JSDoc (vscode.executeHoverProvider) and detects platform specificity from:

  • @platform ios|android|web
  • markdown variants such as *@platform* - android or *@platform* — android
  • phrases like ios only, android only, web only

If hover text is temporarily unresolved (for example (loading...)), the extension retries automatically.

What Gets Scanned

  • JSX/TSX prop usages.
  • JS/TS property declarations discovered from document symbols (for example interface/type/class/object members).
  • Function-valued members when exposed as symbol kind Method.

Scan Scope

  • scanScope = "paddedVisible": scans visible ranges plus visiblePaddingLines above and below.
  • scanScope = "file": scans the full file and avoids frequent scroll-driven recomputes.

Commands

  • Platform Prop Badges: Refresh
  • Platform Prop Badges: Show Logs

Settings

  • platformPropBadges.enabled (default: true)
  • platformPropBadges.debounceMs (default: 300)
  • platformPropBadges.scanScope (default: "paddedVisible"; options: "paddedVisible" | "file")
  • platformPropBadges.visiblePaddingLines (default: 120)
  • platformPropBadges.loadingRetryMs (default: 700)
  • platformPropBadges.maxLoadingRetries (default: 8)
  • platformPropBadges.debugLogs (default: true)
  • platformPropBadges.debugAlwaysShowBadge (default: false)
  • platformPropBadges.debugShowActivationToast (default: true)

License And Assets

  • Extension code: MIT (LICENSE).
  • Badge source icons in assets/ are derived from Font Awesome Free icons (CC BY 4.0).
  • README badge previews in images/badges/ are PNG exports of those same icons (VS Code Marketplace blocks SVG files in README content).

About

VS Code Extension to add badges to platform specific props

Topics

Resources

License

Stars

Watchers

Forks

Contributors