【问题标题】:Visual Studio VSIX Extension not showing in Tools menuVisual Studio VSIX 扩展未显示在“工具”菜单中
【发布时间】:2019-10-09 20:35:59
【问题描述】:

自 2013 版以来,我一直在 Visual Studio 中使用我非常喜欢的 extension。该扩展不由其创建者维护,但他在 GitHub 上发布了源代码。对于 Visual Studio 的每个新版本,我都会尽我所能更新扩展,以便它仍然可以工作(我没有其他扩展经验)。

不幸的是,在 Visual Studio 2019 中,Microsoft 弃用了此扩展严重依赖的库之一(工作项跟踪)。我一直在尝试关注他们的migration guide,但它只有几个我可以使用的代码示例(主要涉及查询)。大多数需要转换的代码都在我头上(例如:WorkItemStore 或 WorkItemCollection)。

我已经能够成功构建/编译项目,但由于上述原因,它有许多关于过时项目的警告('QueryItem' 已过时。有关更多信息,请参阅http://aka.ms/witclientom 的文档)。但是,没有构建错误,我可以安装扩展。

安装后,可以通过扩展程序 - 管理扩展程序页面查看(和卸载)扩展程序,并且可以在帮助 - 关于屏幕中查看有关扩展程序的信息。然而,扩展应该在工具菜单中添加两个项目——而且大多数时候,它不会。我设法让这些项目出现了几次,但是在尝试访问它们时会出现异常(通过 Visual Studio 的实验实例或常规实例)。当我停止调试以修复错误,然后卸载、构建并重新安装扩展时,工具菜单项再次丢失。我不知道如何取回它们,也不知道如何找出它们丢失的原因 - 可能是由于错误,但调试/实验实例在这里没有帮助,因为它不会破坏或显示任何错误。

还有其他方法可以查看工具菜单项未显示的原因吗?

更新:这是我的扩展的 .vsct 文件的内容。我检查了一下,似乎每个项目都有自己的唯一 ID。

<?xml version="1.0" encoding="utf-8"?>
<CommandTable xmlns="http://schemas.microsoft.com/VisualStudio/2005-10-18/CommandTable" xmlns:xs="http://www.w3.org/2001/XMLSchema">

  <!--  This is the file that defines the actual layout and type of the commands.
        It is divided in different sections (e.g. command definition, command
        placement, ...), with each defining a specific set of properties.
        See the comment before each section for more details about how to
        use it. -->

  <!--  The VSCT compiler (the tool that translates this file into the binary 
        format that VisualStudio will consume) has the ability to run a preprocessor 
        on the vsct file; this preprocessor is (usually) the C++ preprocessor, so 
        it is possible to define includes and macros with the same syntax used 
        in C++ files. Using this ability of the compiler here, we include some files 
        defining some of the constants that we will use inside the file. -->

  <!--This is the file that defines the IDs for all the commands exposed by VisualStudio. -->
  <Extern href="stdidcmd.h"/>

  <!--This header contains the command ids for the menus provided by the shell. -->
  <Extern href="vsshlids.h"/>

  <!--The Commands section is where we the commands, menus and menu groups are defined.
      This section uses a Guid to identify the package that provides the command defined inside it. -->
  <Commands package="guidTeamPilgrimPkg">
    <!-- Inside this section we have different sub-sections: one for the menus, another  
    for the menu groups, one for the buttons (the actual commands), one for the combos 
    and the last one for the bitmaps used. Each element is identified by a command id that  
    is a unique pair of guid and numeric identifier; the guid part of the identifier is usually  
    called "command set" and is used to group different command inside a logically related  
    group; your package should define its own command set in order to avoid collisions  
    with command ids defined by other packages. -->

    <!-- In this section you can define new menu groups. A menu group is a container for 
         other menus or buttons (commands); from a visual point of view you can see the 
         group as the part of a menu contained between two lines. The parent of a group 
         must be a menu. -->
    <Groups>

      <Group guid="guidTeamPilgrimCmdSet" id="TeamPilgrimMenuGroup" priority="0x0600">
        <Parent guid="guidSHLMainMenu" id="IDM_VS_MENU_TOOLS"/>
      </Group>
    </Groups>

    <!--Buttons section. -->
    <!--This section defines the elements the user can interact with, like a menu command or a button 
        or combo box in a toolbar. -->
    <Buttons>
      <!--To define a menu group you have to specify its ID, the parent menu and its display priority. 
          The command is visible and enabled by default. If you need to change the visibility, status, etc, you can use
          the CommandFlag node.
          You can add more than one CommandFlag node e.g.:
              <CommandFlag>DefaultInvisible</CommandFlag>
              <CommandFlag>DynamicVisibility</CommandFlag>
          If you do not want an image next to your command, remove the Icon node /> -->

      <Button guid="guidTeamPilgrimCmdSet" id="toolTeamPilgrimExplorer" priority="0x0100" type="Button">
        <Parent guid="guidSHLMainMenu" id="IDG_VS_WNDO_OTRWNDWS1"/>
        <Icon guid="guidImages" id="bmpPic1" />
        <Strings>
          <ButtonText>Team Pilgrim Explorer</ButtonText>
        </Strings>
      </Button>

      <Button guid="guidTeamPilgrimCmdSet" id="toolTeamPilgrimPendingChanges" priority="0x0100" type="Button">
        <Parent guid="guidSHLMainMenu" id="IDG_VS_WNDO_OTRWNDWS1"/>
        <Icon guid="guidImages" id="bmpPendingChanges" />
        <Strings>
          <ButtonText>Team Pilgrim Pending Changes</ButtonText>
        </Strings>
      </Button>

      <Button guid="guidTeamPilgrimCmdSet" id="cmdTeamPilgrimExplorer" priority="0x0100" type="Button">
        <Parent guid="guidTeamPilgrimCmdSet" id="TeamPilgrimMenuGroup" />
        <Icon guid="guidImages" id="bmpPic1" />
        <Strings>
          <ButtonText>Team Pilgrim Explorer</ButtonText>
        </Strings>
      </Button>

      <Button guid="guidTeamPilgrimCmdSet" id="cmdTeamPilgrimPendingChanges" priority="0x0100" type="Button">
        <Parent guid="guidTeamPilgrimCmdSet" id="TeamPilgrimMenuGroup" />
        <Icon guid="guidImages" id="bmpPendingChanges" />
        <Strings>
          <ButtonText>Team Pilgrim Pending Changes</ButtonText>
        </Strings>
      </Button>
    </Buttons>

    <!--The bitmaps section is used to define the bitmaps that are used for the commands.-->
    <Bitmaps>
      <!--  The bitmap id is defined in a way that is a little bit different from the others: 
            the declaration starts with a guid for the bitmap strip, then there is the resource id of the 
            bitmap strip containing the bitmaps and then there are the numeric ids of the elements used 
            inside a button definition. An important aspect of this declaration is that the element id 
            must be the actual index (1-based) of the bitmap inside the bitmap strip. -->
      <Bitmap guid="guidImages" href="Resources\Images.png" usedList="bmpPic1, bmpPendingChanges"/>

    </Bitmaps>
  </Commands>

  <Symbols>
    <!-- This is the package guid. -->
    <GuidSymbol name="guidTeamPilgrimPkg" value="{f56b8666-3ef2-46e5-ac26-8aa0efe1f484}" />

    <!-- This is the guid used to group the menu commands together -->
    <GuidSymbol name="guidTeamPilgrimCmdSet" value="{064ac9aa-5aa9-498a-a5d9-2077be8d9ad6}">

      <IDSymbol name="TeamPilgrimMenuGroup" value="0x1020" />
      <IDSymbol name="cmdTeamPilgrimExplorer" value="0x0100" />
      <IDSymbol name="toolTeamPilgrimExplorer" value="0x0101" />
      <IDSymbol name="cmdTeamPilgrimPendingChanges" value="0x0102" />
      <IDSymbol name="toolTeamPilgrimPendingChanges" value="0x0103" />
    </GuidSymbol>  

    <GuidSymbol name="guidImages" value="{91572e9b-72ad-453b-93df-dfc995721a79}" >
      <IDSymbol name="bmpPic1" value="1" />
      <IDSymbol name="bmpPendingChanges" value="2" />
      <IDSymbol name="bmpPicSearch" value="3" />
      <IDSymbol name="bmpPicX" value="4" />
      <IDSymbol name="bmpPicArrows" value="5" />
      <IDSymbol name="bmpPicStrikethrough" value="6" />
    </GuidSymbol>
  </Symbols>

</CommandTable>

【问题讨论】:

  • this document,该命令的位置自VS2019以来发生了变化。
  • @LanceLi-MSFT - 我很困惑。您链接到的文档明确指出“现在转到实验实例中的工具菜单。您应该看到 Invoke FirstCommand 命令。” - 这是我正在寻找的地方,菜单命令不在那里。
  • 可能是我误会了什么,我稍后再做测试。但是由于您的项目未显示的原因,可能类似于this 之类的问题,您能否分享您有问题的xx.vsct 文件的内容,以便我为您检查:)
  • @LanceLi-MSFT - 我按要求添加了 vsct 文件。让我知道那里有什么我可以解决的。
  • 我猜在你的情况下你找不到Team Pilgrim ExplorerTeam Pilgrim Pending Changes 按钮。我在一个新的 vsix 项目中使用了您的 vsct 文件的类似内容,但按钮显示良好。 (而且在我看来,大多数时候,在 vsix 中显示的 UI 都与 vsct 相关,但是您的 vsct 文件看起来是正确的,很奇怪。)如果您的 VS 中安装了该扩展程序,请卸载它,并重置 VS 实验性安装。如果此问题仍然存在,请尝试repair vs 以避免 IDE 出现问题。 (我在VS2019 16.3.6,如果可以的话,请更新到最新版本。)

标签: visual-studio visual-studio-2019 visual-studio-extensions


【解决方案1】:

如果你像我一样来到这里,试图找出为什么你的工作扩展突然(对你来说)丢失了所有工具栏和菜单 - 然后请检查你的 .vsct 文件是否真的由 VSCT 编译器处理 - 它应该是一个 VSCTCompile 项 -像这样的

<VSCTCompile Include="MainPackage.vsct">
  <AutoGen>True</AutoGen>
  <DesignTime>True</DesignTime>
  <DependentUpon>MainPackage.tt</DependentUpon>
  <ResourceName>Menus.ctmenu</ResourceName>
  <SubType>Designer</SubType>
</VSCTCompile>  </ItemGroup>

在我的情况下不是这个

<Content Include="MainPackage.vsct">
  <AutoGen>True</AutoGen>
  <DesignTime>True</DesignTime>
  <DependentUpon>MainPackage.tt</DependentUpon>
</Content>

【讨论】:

  • 在将我的扩展移植到 VS2022 时遇到了同样的问题 - 命令有效(通过键绑定),但没有显示它们的菜单项,并且从未调用过 QueryStatus 方法。 vsct 只是从未加载过。带有菜单命令的新 VSIX 项目运行良好。直到我卸载了 VS2022,删除了 HKLM 和 HKCU Software/Microsoft/VisualStudio 下的所有注册表项,然后从头开始重新安装了 VS2022,才修复它。
  • 我发现和@yatagarasu一样。在 MSDN 关于迁移到 VS2022 的文章之后,涉及将 vsct 文件重新添加为链接。但是,至关重要的是,这将删除这些重要行:&lt;ResourceName&gt;Menus.ctmenu&lt;/ResourceName&gt; &lt;SubType&gt;Designer&lt;/SubType&gt; 您需要将它们重新添加,菜单和命令才能重新出现。因此它应该看起来像这样:&lt;VSCTCompile Include="..\SharedFiles\&lt;yourFile&gt;.vsct"&gt; &lt;Link&gt;&lt;yourFile&gt;.vsct&lt;/Link&gt; &lt;ResourceName&gt;Menus.ctmenu&lt;/ResourceName&gt; &lt;SubType&gt;Designer&lt;/SubType&gt; &lt;/VSCTCompile&gt;
  • 感谢@GrantTheAnt!我还必须运行重置实验实例快捷方式才能使更改生效。
【解决方案2】:

但是,扩展程序应该在“工具”菜单中添加两个项目 - 和 大多数时候,它不会。

1.自VS2019以来,它将阻止任何扩展同步自动加载。如果您收到任何警告,您可能需要升级扩展以支持异步后台加载。更多详情请参考this blog

2.可能你的xx.vsct文件有问题,如果里面的结构无效,构建不会失败并抛出错误,但是你可能看不到显示的Item...

Microsoft 已弃用此扩展所依赖的库之一 重度上(工作项跟踪)

这个API更像TFS API,而不是VS SDK API,我猜你找不到这两个项目的原因是关于tip1或tip2,而你尝试访问它们时出现异常的原因是关于那些 APIS 已被弃用,所以我猜你可能需要使用新的REST APIS

【讨论】:

  • 感谢您的回复。 1. 我没有收到任何关于自动加载的警告,但以防万一,我在选项屏幕中启用了允许同步的选项,如链接文档中所示,然后重新启动了 Visual Studio。不用找了。 2.我在扩展中的唯一选项是“管理扩展”,我可以在其中查看扩展是否已安装,或禁用/删除它。 (在调试模式和常规模式下)编辑:对于 API,我意识到它必须是 REST 但没有文档如何移动/翻译我需要的大部分内容。
【解决方案3】:

我的旧扩展也使用了已弃用的 API,也遇到了类似的问题。在 Visual Studio 2019 的第一个版本中,它工作正常,但在 VS 更新后,其中一个窗口停止正常工作并变成“空白窗口”。我花了几个月的时间在谷歌上搜索解决这个问题的方法,我可以通过禁用工具 -> 选项 -> 环境 -> 常规 -> “优化具有不同像素密度的屏幕的渲染”中的选项来修复它

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2022-06-17
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多