[vscode] Public API Explorer

A vscode extension that leverages semver-audit indexers to browse the public api of packages.

• Dart - ✅
• Typescript - ✅
• Go - 🚧

Features

Browse the public api of package within a tree view. Clicking on entities on will open them in your editor, where the individual exported symbols can be observed

https://github.com/user-attachments/assets/5b1682a1-e906-4f6d-b2df-d2ec36d68e14

Installation

• Make sure semver_audit (dart) is installed (typescript support uses npxand does not need to be manually installed)

  # activate globally
  dart pub global activate --hosted-url https://pub.workiva.org semver_audit
  
  # and make sure the install worked
  dart pub global run semver_audit --help # should see output from running this
  

• Download the latest .vsix file from the most recent build artifact: https://ci.webfilings.com/builds/Workiva/public-api-extension

• Open the folder containing your .vsix file within vscode, right click the file within the explorer, and click Install Extension VSIX

• This should install the public-api-extension into your vscode instance.

[!IMPORTANT] Note, this WILL NOT auto update. Please check back to this repo for any updates if thats something you're interested in.

Telemetry

The Frontend Developer Experience squad has interest in keeping an eye on usages of this extension so we can best prioritize where our focus is. Because of this we have some telemetry implemented during regular usage of the extension

The extension does adhere to vscode's telemetry best practices. This means everything can be fully disabled using telemetry.telemetryLevel, and all recorded telemetry can be found in the telemetry.json file at the root of this repo