vscode-pull-request-github icon indicating copy to clipboard operation
vscode-pull-request-github copied to clipboard

Add 'effect' to JSDoc tag exclusion list

Open Copilot opened this issue 2 months ago • 0 comments

The custom JSDoc tag @effect was incorrectly triggering GitHub user hovers, linking to https://github.com/effect instead of being treated as documentation.

Changes

  • Added 'effect' to JSDOC_NON_USERS array in src/common/user.ts (alphabetically between 'desc' and 'enum')
  • Added test coverage in src/test/common/user.test.ts to verify the exclusion

Example

export enum _ {
  /**
   * @effect
   */
}

Previously hovering over @effect would show a GitHub user card for the 'effect' user. Now it's correctly ignored as a JSDoc tag, consistent with @param, @returns, and other standard tags.

[!WARNING]

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • jsdoc.app
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/ghcca-node/node/bin/node --enable-source-maps /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

This section details on the original issue you should resolve

<issue_title>@effect github ?</issue_title> <issue_description>can you tell me why when i mouse hover a jsdoc @effect vscode show me link to this guy profile ?! https://github.com/effect

image

  • VS Code Version:
Version : 1.89.1 (user setup)
Validation : dc96b837cf6bb4af9cd736aa3af08cf8279f7685
Date : 2024-05-07T05:13:33.891Z
Electron : 28.2.8
ElectronBuildId : 27744544
Chromium : 120.0.6099.291
Node.js : 18.18.2
V8 : 12.0.267.19-electron.0
Système d’exploitation : Windows_NT x64 10.0.19045

Steps to Reproduce:

mouse hover @effect

export enum _ {

	/**
	 * @effect
	 */
}

</issue_description>

<agent_instructions>Add effect to the list of excluded user hovers.</agent_instructions>

Comments on the Issue (you are @copilot in this section)

@alexr00 @jonlepage what library are you using where `@effect` is a jsdoc tag? @alexr00 For common `@` tags in jsdoc we have them excluded from the GitHub user hovers, but since it's custom we don't know which `@` tags are part of your jsdoc and which ones are supposed to reference users. I guess we need to have a setting so that you can choose which ones you want to exclude.
  • Fixes microsoft/vscode-pull-request-github#6003

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot avatar Dec 10 '25 11:12 Copilot