Warning-free clang-format plugin install for VS 15.0

[hstefan]

Summary

With the new release os VS, it's required that all plugins migrate the new VSIX manifest format. The new format is backwards compatible with all versions newer that Visual Studio 2012, so this migration effectively drops support for older versions of the IDE.

It's also required that these new extensions are built with Visual Studio 2017, so unfortunately it was necessary to migrate the project and solution. Also removed COM references to EnvDTE and Microsoft.VisualStudio.TextManager.Interop from the csproj, as they seem to both be unnecessary and would trigger build warnings because of changes to GAC.

[hstefan]

Related to: https://reviews.llvm.org/D31522.

[hans]

Thanks! I'll need a few days to get VS2017 so I can try this out.

[hans]

Sorry for the delay; I finally got VS2017 installed.

I got these build errors when trying your patch directly:

Microsoft Visual Studio 2017 Version 15.0.26403.3.
Copyright (C) Microsoft Corp. All rights reserved.
1>------ Build started: Project: ClangFormat, Configuration: Release Any CPU ---
---
1>D:\src\llvm\tools\clang\tools\clang-format-vs\ClangFormat\ClangFormatPackage.c
s(15,7,15,13): error CS0246: The type or namespace name 'EnvDTE' could not be fo
und (are you missing a using directive or an assembly reference?)
1>D:\src\llvm\tools\clang\tools\clang-format-vs\ClangFormat\RunningDocTableEvent
sDispatcher.cs(1,7,1,13): error CS0246: The type or namespace name 'EnvDTE' coul
d not be found (are you missing a using directive or an assembly reference?)
1>D:\src\llvm\tools\clang\tools\clang-format-vs\ClangFormat\Vsix.cs(1,7,1,13): e
rror CS0246: The type or namespace name 'EnvDTE' could not be found (are you mis
sing a using directive or an assembly reference?)
1>D:\src\llvm\tools\clang\tools\clang-format-vs\ClangFormat\RunningDocTableEvent
sDispatcher.cs(73,17,73,25): error CS0246: The type or namespace name 'Document'
 could not be found (are you missing a using directive or an assembly reference?
)
1>D:\src\llvm\tools\clang\tools\clang-format-vs\ClangFormat\Vsix.cs(30,44,30,52)
: error CS0246: The type or namespace name 'Document' could not be found (are yo
u missing a using directive or an assembly reference?)
1>D:\src\llvm\tools\clang\tools\clang-format-vs\ClangFormat\Vsix.cs(37,52,37,60)
: error CS0246: The type or namespace name 'Document' could not be found (are yo
u missing a using directive or an assembly reference?)
1>D:\src\llvm\tools\clang\tools\clang-format-vs\ClangFormat\RunningDocTableEvent
sDispatcher.cs(13,17,13,20): error CS0246: The type or namespace name 'DTE' coul
d not be found (are you missing a using directive or an assembly reference?)
1>D:\src\llvm\tools\clang\tools\clang-format-vs\ClangFormat\RunningDocTableEvent
sDispatcher.cs(15,64,15,72): error CS0246: The type or namespace name 'Document'
 could not be found (are you missing a using directive or an assembly reference?
)
1>D:\src\llvm\tools\clang\tools\clang-format-vs\ClangFormat\ClangFormatPackage.c
s(266,50,266,58): error CS0246: The type or namespace name 'Document' could not
be found (are you missing a using directive or an assembly reference?)
1>D:\src\llvm\tools\clang\tools\clang-format-vs\ClangFormat\ClangFormatPackage.c
s(316,37,316,45): error CS0246: The type or namespace name 'Document' could not
be found (are you missing a using directive or an assembly reference?)
========== Build: 0 succeeded, 1 failed, 0 up-to-date, 0 skipped ==========
ninja: build stopped: subcommand failed.

But adding references to those assemblies made it go away:

diff --git a/tools/clang-format-vs/ClangFormat/ClangFormat.csproj b/tools/clang-format-vs/ClangFormat/ClangFormat.csproj
index bb3cd4e..71f4b3d 100644
--- a/tools/clang-format-vs/ClangFormat/ClangFormat.csproj
+++ b/tools/clang-format-vs/ClangFormat/ClangFormat.csproj
@@ -58,6 +58,12 @@
     <Prefer32Bit>false</Prefer32Bit>
   </PropertyGroup>
   <ItemGroup>
+    <Reference Include="envdte, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">^M
+      <EmbedInteropTypes>True</EmbedInteropTypes>^M
+    </Reference>^M
+    <Reference Include="envdte80, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">^M
+      <EmbedInteropTypes>True</EmbedInteropTypes>^M
+    </Reference>^M
     <Reference Include="Microsoft.CSharp" />
     <Reference Include="Microsoft.VisualStudio.CoreUtility, Version=10.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a, processorArchitecture=MSIL">
       <HintPath>..\packages\VSSDK.CoreUtility.10.0.4\lib\net40\Microsoft.VisualStudio.CoreUtility.dll</HintPath>

Is there something different with my machine, or should we just add that to your patch?

I verified that the plugin installs and works on my machine with VS 2012, 2013, 2015 and 2017, which is pretty awesome :-)

Many thanks for working on this!

tools/clang-format-vs/source.extension.vsixmanifest.in

4

Is this just a random UUID, or does it have some significance?

17

What's CoreEditor? 15.0 makes it sound like something from VS2017?

[hstefan]

Dealing with EnvDTE has been a bit of an annoyance in my computer too, but In my case I ran into this https://developercommunity.visualstudio.com/content/problem/15434/cannot-find-wrapper-assembly-for-type-library-envd.html. I didn't have any luck with the solution proposed on that question, but I believe its results would be similar to what you ended up doing yourself, so I think it would be fine to add that to the original patch. Do I need to submit a new patch with those changes included too?

In case you're interested, my answers to your comments were based mainly on what I've found in http://www.visualstudioextensibility.com/2017/01/10/its-time-to-change-the-vsix-manifest-of-your-extension-to-v3-for-visual-studio-2017-compatibility/ and http://www.visualstudioextensibility.com/2016/11/23/some-implications-of-the-new-modular-setup-of-visual-studio-2017-for-vsx-developers/

tools/clang-format-vs/source.extension.vsixmanifest.in

4

I reused the same UUID we had in the previous manifest (Identifier id attribute), I just converted it to the new format.

17

Since VS2017 extensions are expected to declare which minimal "modules" of the IDE they need. CoreEditor is the most basic one, which seems appropriate for this plugin, the version is indeed related to the "VS 15.0".

[hstefan]

Adding the changes suggested on https://reviews.llvm.org/D31740#725320. I verified that this still builds and works well on my computer, so if it fixes the errors in the original diff I think it's an ok change to introduce.

[hans]

LGTM with the version attribute for Microsoft.VisualStudio.Component.CoreEditor changed to 11.0 or higher.

Do you have commit access or would you like me to commit for you?

tools/clang-format-vs/source.extension.vsixmanifest.in

17

I was worried that the 15.0 means this depends on some component of VS2017.

I tried installing the plugin for VS2013 on a machine that has never had VS2017 installed. The plugin did install and show up in "Tools > Extensions and Updates" but the actual commands to format code did not show up in the Tools menu!

I changed the Version attribute to "[11.0,)" instead, and then it worked.

[hstefan]

No, I don't have commit access (though I might request it if I manage to actually continue collaborating).

Thanks for the notes on the 11.0 vs 15.0 issue, I wrongly assumed the prerequisites session would be entirely ignored by older versions.

tools/clang-format-vs/ClangFormat/ClangFormat.csproj

<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
     <DefineConstants>TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
     <RunCodeAnalysis>true</RunCodeAnalysis>
     <Prefer32Bit>false</Prefer32Bit>
   </PropertyGroup>
   <ItemGroup>
     <Reference Include="envdte, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">
-      <HintPath>..\packages\VSSDK.DTE.7.0.3\lib\net20\envdte.dll</HintPath>
-      <EmbedInteropTypes>False</EmbedInteropTypes>
+      <EmbedInteropTypes>True</EmbedInteropTypes>
+    </Reference>
+    <Reference Include="envdte80, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">
+      <EmbedInteropTypes>True</EmbedInteropTypes>
     </Reference>
     <Reference Include="Microsoft.CSharp" />
     <Reference Include="Microsoft.VisualStudio.CoreUtility, Version=10.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a, processorArchitecture=MSIL">
       <HintPath>..\packages\VSSDK.CoreUtility.10.0.4\lib\net40\Microsoft.VisualStudio.CoreUtility.dll</HintPath>
       <Private>False</Private>
     </Reference>
     <Reference Include="Microsoft.VisualStudio.Editor, Version=10.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a, processorArchitecture=MSIL">
       <HintPath>..\packages\VSSDK.Editor.10.0.4\lib\net40\Microsoft.VisualStudio.Editor.dll</HintPath>
<ItemGroup>
     <Reference Include="Microsoft.VisualStudio.Text.UI, Version=10.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a, processorArchitecture=MSIL">
       <HintPath>..\packages\VSSDK.Text.10.0.4\lib\net40\Microsoft.VisualStudio.Text.UI.dll</HintPath>
       <Private>False</Private>
     </Reference>
     <Reference Include="Microsoft.VisualStudio.Text.UI.Wpf, Version=10.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a, processorArchitecture=MSIL">
       <HintPath>..\packages\VSSDK.Text.10.0.4\lib\net40\Microsoft.VisualStudio.Text.UI.Wpf.dll</HintPath>
       <Private>False</Private>
     </Reference>
-    <Reference Include="Microsoft.VisualStudio.TextManager.Interop">
-      <HintPath>..\packages\VSSDK.TextManager.Interop.7.0.4\lib\net20\Microsoft.VisualStudio.TextManager.Interop.dll</HintPath>
-      <Private>True</Private>
-    </Reference>
     <Reference Include="Microsoft.VisualStudio.TextManager.Interop, Version=7.1.40304.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">
       <Private>False</Private>
     </Reference>
     <Reference Include="Microsoft.VisualStudio.TextManager.Interop.8.0, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">
       <HintPath>..\packages\VSSDK.TextManager.Interop.8.8.0.4\lib\net20\Microsoft.VisualStudio.TextManager.Interop.8.0.dll</HintPath>
       <Private>True</Private>
       <Private>False</Private>
     </Reference>
<ItemGroup>
     <Reference Include="System.Design" />
     <Reference Include="System.Drawing" />
     <Reference Include="System.Windows.Forms" />
     <Reference Include="System.Xml" />
     <Reference Include="System.Xml.Linq" />
     <Reference Include="WindowsBase" />
   </ItemGroup>
   <ItemGroup>
-    <COMReference Include="EnvDTE">
-      <Guid>{80CC9F66-E7D8-4DDD-85B6-D9E6CD0E93E2}</Guid>
-      <VersionMajor>8</VersionMajor>
-      <VersionMinor>0</VersionMinor>
-      <Lcid>0</Lcid>
-      <WrapperTool>primary</WrapperTool>
-      <Isolated>False</Isolated>
-      <EmbedInteropTypes>False</EmbedInteropTypes>
-    </COMReference>
-    <COMReference Include="EnvDTE100">
-      <Guid>{26AD1324-4B7C-44BC-84F8-B86AED45729F}</Guid>
-      <VersionMajor>10</VersionMajor>
-      <VersionMinor>0</VersionMinor>
-      <Lcid>0</Lcid>
-      <WrapperTool>primary</WrapperTool>
-      <Isolated>False</Isolated>
-      <EmbedInteropTypes>False</EmbedInteropTypes>
-    </COMReference>
-    <COMReference Include="EnvDTE80">
-      <Guid>{1A31287A-4D7D-413E-8E32-3B374931BD89}</Guid>
-      <VersionMajor>8</VersionMajor>
-      <VersionMinor>0</VersionMinor>
-      <Lcid>0</Lcid>
-      <WrapperTool>primary</WrapperTool>
-      <Isolated>False</Isolated>
-      <EmbedInteropTypes>False</EmbedInteropTypes>
-    </COMReference>
-    <COMReference Include="EnvDTE90">
-      <Guid>{2CE2370E-D744-4936-A090-3FFFE667B0E1}</Guid>
-      <VersionMajor>9</VersionMajor>
-      <VersionMinor>0</VersionMinor>
-      <Lcid>0</Lcid>
-      <WrapperTool>primary</WrapperTool>
-      <Isolated>False</Isolated>
-      <EmbedInteropTypes>False</EmbedInteropTypes>
-    </COMReference>
     <COMReference Include="Microsoft.VisualStudio.CommandBars">
       <Guid>{1CBA492E-7263-47BB-87FE-639000619B15}</Guid>
       <VersionMajor>8</VersionMajor>
       <VersionMinor>0</VersionMinor>
       <Lcid>0</Lcid>
       <WrapperTool>primary</WrapperTool>
       <Isolated>False</Isolated>
       <EmbedInteropTypes>False</EmbedInteropTypes>
<ItemGroup>
     </EmbeddedResource>
     <EmbeddedResource Include="VSPackage.resx">
       <MergeWithCTO>true</MergeWithCTO>
       <ManifestResourceName>VSPackage</ManifestResourceName>
     </EmbeddedResource>
   </ItemGroup>
   <ItemGroup>
     <None Include="Key.snk" />
-    <None Include="packages.config" />
+    <None Include="packages.config">
+      <SubType>Designer</SubType>
+    </None>
     <None Include="source.extension.vsixmanifest">
       <SubType>Designer</SubType>
     </None>
   </ItemGroup>
   <ItemGroup>
     <VSCTCompile Include="ClangFormat.vsct">
       <ResourceName>Menus.ctmenu</ResourceName>
     </VSCTCompile>
<Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003" ToolsVersion="4.0">
   </PropertyGroup>
   <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 
        Other similar extension points exist, see Microsoft.Common.targets.
   <Target Name="BeforeBuild">
   </Target>
   <Target Name="AfterBuild">
   </Target>
   -->
-</Project>
+</Project>
 

tools/clang-format-vs/ClangFormat/packages.config

 <?xml version="1.0" encoding="utf-8"?>
 <packages>
   <package id="VSSDK.CoreUtility" version="10.0.4" targetFramework="net40" />
   <package id="VSSDK.CoreUtility.10" version="10.0.4" targetFramework="net40" />
-  <package id="VSSDK.DTE" version="7.0.3" targetFramework="net40" />
   <package id="VSSDK.Editor" version="10.0.4" targetFramework="net40" />
   <package id="VSSDK.Editor.10" version="10.0.4" targetFramework="net40" />
   <package id="VSSDK.IDE" version="7.0.4" targetFramework="net40" />
   <package id="VSSDK.IDE.10" version="10.0.4" targetFramework="net40" />
   <package id="VSSDK.IDE.8" version="8.0.4" targetFramework="net40" />
   <package id="VSSDK.IDE.9" version="9.0.3" targetFramework="net40" />
   <package id="VSSDK.OLE.Interop" version="7.0.4" targetFramework="net40" />
   <package id="VSSDK.Shell.10" version="10.0.3" targetFramework="net40" />
   <package id="VSSDK.Shell.Immutable.10" version="10.0.3" targetFramework="net40" />
   <package id="VSSDK.Shell.Interop" version="7.0.4" targetFramework="net40" />
   <package id="VSSDK.Shell.Interop.8" version="8.0.3" targetFramework="net40" />
   <package id="VSSDK.Shell.Interop.9" version="9.0.3" targetFramework="net40" />
   <package id="VSSDK.Text" version="10.0.4" targetFramework="net40" />
   <package id="VSSDK.Text.10" version="10.0.4" targetFramework="net40" />
   <package id="VSSDK.TextManager.Interop" version="7.0.4" targetFramework="net40" />
   <package id="VSSDK.TextManager.Interop.8" version="8.0.4" targetFramework="net40" />
 </packages>
 No newline at end of file

tools/clang-format-vs/source.extension.vsixmanifest.in

 <?xml version="1.0" encoding="utf-8"?>
-<Vsix Version="1.0" xmlns="http://schemas.microsoft.com/developer/vsx-schema/2010">
-  <Identifier Id="20dbc914-1c7a-4992-b236-ef58b37850eb">
-    <Name>ClangFormat</Name>
-    <Author>LLVM</Author>
-    <Version>@CLANG_FORMAT_VS_VERSION@</Version>
+<PackageManifest Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vsx-schema/2011" xmlns:d="http://schemas.microsoft.com/developer/vsx-schema-design/2011">
+  <Metadata>
+    <Identity Id="20dbc914-1c7a-4992-b236-ef58b37850eb" Version="@CLANG_FORMAT_VS_VERSION@" Language="en-US" Publisher="LLVM"/>
+    <DisplayName>ClangFormat</DisplayName>
     <Description xml:space="preserve">A tool to format C/C++/Obj-C code.</Description>
-    <Locale>1033</Locale>
-    <MoreInfoUrl>http://clang.llvm.org/docs/ClangFormat.html</MoreInfoUrl>
+    <MoreInfo>http://clang.llvm.org/docs/ClangFormat.html</MoreInfo>
     <License>license.txt</License>
-    <InstalledByMsi>false</InstalledByMsi>
-    <SupportedProducts>
-      <VisualStudio Version="10.0">
-        <Edition>Pro</Edition>
-      </VisualStudio>
-      <VisualStudio Version="11.0">
-        <Edition>Pro</Edition>
-      </VisualStudio>
-      <VisualStudio Version="12.0">
-        <Edition>Pro</Edition>
-      </VisualStudio>
-      <VisualStudio Version="14.0">
-        <Edition>Pro</Edition>
-      </VisualStudio>
-      <VisualStudio Version="15.0">
-        <Edition>Pro</Edition>
-      </VisualStudio>
-    </SupportedProducts>
-    <SupportedFrameworkRuntimeEdition MinVersion="4.0" MaxVersion="4.0" />
-  </Identifier>
-  <References>
-        <Reference Id="Microsoft.VisualStudio.MPF" MinVersion="10.0">
-            <Name>Visual Studio MPF</Name>
-        </Reference>
-  </References>
-  <Content>
-    <VsPackage>|%CurrentProject%;PkgdefProjectOutputGroup|</VsPackage>
-  </Content>
-</Vsix>
+  </Metadata>
+  <Installation InstalledByMsi="false">
+    <InstallationTarget Id="Microsoft.VisualStudio.Pro" Version="[11.0, 15.0]" />
+  </Installation>
+  <Dependencies>
+    <Dependency Id="Microsoft.VisualStudio.MPF" MinVersion="11.0" DisplayName="Visual Studio MPF" />
+  </Dependencies>
+  <Prerequisites>
+    <Prerequisite Id="Microsoft.VisualStudio.Component.CoreEditor" Version="[15.0,)" DisplayName="Visual Studio core editor" />
+  </Prerequisites>
+</PackageManifest>