Due to the LicenseHeaderManager now supporting SQL Projects and various other Project Types, we should add as much supported Languages as possible into the Default Options on the Language Page.

Should add:
.sql
.php
.wxs, .wxl, .wxi
.ts
.py
.php
.fs

To improve performance and memory usage when updating big solutions, we should introduce the possibility of configuring pre and post update commands in the Options Menu..

When a file is linked in a project, we are currently only updating the licenseheader if the original file is located in a project inside the solution (with the licenseheader defined in the local .licenseheader file)

We should also search for the original file in the solution items.

Use "Add license header to all projects" to add or update the license headers in a large solution and you can watch the devenv process continously adding memory while processing the files.

This gets triggered when adding LicenseHeader to an Item inside a Folder.

Its because the ProjectItem of Type Microsoft.VisualStudioTools.Project.Automation.OAFolderItem
returns itself instead of the Parent when we are trying to move up the hierarchie with projectItem.Collection.Parent. This leads to infinite recursion -> StackOverflow.

Running VS 2015 on Windows 10 and I'm getting the following error message:

"Access to c:\Program Files (x86)\Microsoft Visual Studio 14.0\Common7\IDE.licenseheader" is denied

I also tried with a manually created .licenseheader file in the above directory, but that was not successful either.

When using "Add existing License Header Definition File" in the folder contextmenu, the License Header Manager only copies the given definition file. It should create a Link instead.

I am working on adding headers to all of the files in one of the frameworks I am working on (https://github.com/XLabs/Xamarin-Forms-Labs) and I am trying to use the LHM to help with this however it is not working. I have created the definition file and added it to my projects however when I go to actually add the header -- nothing happens (no error, no changes to the files, nothing).

Any idea on how I can track down what the issue is?

When working with .sql files, the LicenseHeaderManager seems not to recognize header inserted by himself. As a consequence it is impossible to remove or update the inserted Header automatically.

%Filename% currently returns the Filename in all lower and does not retain the correct casing. It is expected that the Filename gets inserted with the correct casing.

Any to remove .licenseheader file?
I think use the default header without the .licenseheader file is a good option.

When trying to add an Licenseheader to a .py file in a Folder in a Python Tools Project, an InvalidOperationException gets thrown with Error message "Operation is not valid due to the current state of the object":

This is due to us trying to access projectItem.Collection. Collection is not implemented by Python Tools in OAFileItem. While the Base class provides an implementation for the root directory, it throws an InvalidOperationException in other cases (see Base Class Implementation, Line 157: https://github.com/Microsoft/PTVS/blob/master/Common/Product/SharedProject/Automation/OAProjectItem.cs ).

This can be fixed by accessing the Parent "Microsoft.VisualStudioTools.Project.Automation.OAFileItem" via the supplied object with reflection - the same fashion as #36 .

it looks it doesn't support VS2015 Shared project template.
It said "Specified cast is not valid." in Shared Project.

%FileName% expands to lower case filename.

Sometimes when right clicking an ProjectItem after updating to 1.7.0, following Error Screen appears

It is not reproduceable 100%.

Using VS 2015 Community Edition. Windows 10

I have had LHM for some time and like it a lot but recently when I start VS, LHM is disabled. I enable it restart VS and LHM is there, but next time I start VS LHM is disabled once again.

When trying to add an existing License Header Definition File in a WixProj the License Header gets copied into the Project and not added as link.

It seems like the Function projectItems.AddFromFile(string filename) behaves different in this Project type, as we use this function to add the existing file for every project type and the other projects add the file as link. As .wixproj is a custom project type it is possible that their implementation behaves different than other project types. However, this behaviour does not occur in other custom Project Types (tested with PhP Project).

The Project Type seems to support Linked Files somehow, as it is possible to add other existing items as link (with Add -> Add Existing Item -> Add as Link). So there may be a workaround.

Hi,

This occurs whenever I try to "Add license header to all files" from the project context menu. I do have a .licenseheader file in the project's folder.

Any idea?

Thanks,
Marcel

Happens in WixProj with .wxs, .wxl, .wxi
Happens in F# Projects with .fs

Probably same as #36 .
Additionally to adding a workaround for the parent we should guard this recursive Call against further Stackoverflow Exceptions and give the user an error message if projectItem.Collection.Parent returns the ProjectItem again. Maybe there is a more reliable way to access the Parent.

When an Exception gets thrown, the user should be able to see the type and message of the exception and the stacktrace for better error reporting.

When use the two plugins with each other the Visual Studio 2013/2015 will crash if you open a php project with some files or folders.

This case:
http://support.devsense.com/viewtopic.php?f=21&t=1429&p=6702&hilit=crash#p6702

But I have the same error with phpTools 1.19.8670 and LicenseHeaderManager 1.7.1.

Thanks.

Hi!

Using Visual Studio 2015 Enterprise Update 2, I've tried many times to get the LicenseHeaderManager to work, but it keeps on hanging. It doesn't matter if I have source files open or closed, nor does mater if I use the generic .licenseheader file or create one of my own.

Any help in this regard would be greatly appreciated....

In rare cases the error message "Settings update to VERSION didn't work" appears. So far i have not found a way to reliably reproduce it, so this error may be only be occurring local.

Maybe it should be considered replacing the Trace.Assert with a MessageBox to have a more consistent User Interaction when handling errors. Also, a Trace.Assert adds various other stuff to the message and looks much more dramatic than a clean MessageBox.

The Add and Remove menu items can be located on the project and the folder level. Either customize the message based on the context (project or folder) or simply remove the context information since.

When pressing Alt-L to paste in the license header, I get a message "The type initializer for 'LicenseHeaderManager.Headers.UserInfo' threw an exception.
On further inspection the line in the UserInfo initializer with the code "UserPrincipal.Current.DisplayName" is probably the cause of the exception. I'm running VS on a home computer not connected to a domain. This line will throw an exception, because it cannot find a link to an AD.

New license header definition files are added with whitespace padding, which needs to be removed before the file can be used.

We should introduce a Logging Library (like log4net or NLog) for Debug/Exception Logging.

I would propose using NLog, as we have made some experience with that on another VisualStudio Extension and it seems to have everything we need. We can customize it with a custom Output handler to write to the Visual Studio Output Window.

The only Problem is that it does not find the config file on its own (same problem with log4net) and we have to set it on Package Initialize with this Code (assuming it gets put into the .vsix):

  string assemblyFolder = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
  NLog.LogManager.Configuration = new NLog.Config.XmlLoggingConfiguration(assemblyFolder + "\\NLog.config", true);

When trying to add a new .licensheaderfile in a sql Project, an error Message "URI is invalid" or "Access to path is denied" appears.

This error occurs because the Property "FileName" is used to generate the name and Path of the .licenseheader file. In some Projects, this property contains the FullPath while in sqlproject and custom projects there is only the filename (which - looking at the name of the property - seems to be the correct behaviour.

This can be fixed by using the "FullName" Property instead, as it contains the FullPath in every Project tested so far. Additionally we should include a check if this Property contains the FullPath as expected. For the case that any ProjectType has the wrong value there, we can try the "FileName" Property. If that too does not contain the full path we should abort and fail with a more clear error message.

Using https://github.com/Microsoft/VisualStudio-TestHost VsTest Host it is fairly easy to write Tests for Visual Studio Extensions.

We should introduce an TestSolution containing different Project Types and Nested Folder. Then we can write automated Tests which add .licenseheader Files and Code Files to the Solution and then trigger Add Licensheader Commands on various Items.

When adding/removing License header to a whole solution with many Projects, the status bar only shows the information that the License Header Manager is Updating Files, but no Information on the Progress.

Desired Behaviour: "Updating Files..." in the status bar should be replaced by the progress, something like "Updating Project 5/130", updating after every completed Project.

It might be a cool feature if there could be some expandable tokens that pulled from git (like my github login id)

An unloaded Project currently throws an Exception when adding licenseheaders to the whole solution.
Expectation: LicenseHeaderManager should ignore unloaded Projects

Python Tools Projects contains Python Packages which are deposited as OAProjectItem in the Project (see Snippet):

When we are searching for a LicenseHeader in GetLicenseHeaderRecursive, these things throw InvalidOperationExceptions when trying to access the Property "Collection" in Function GetProjectItemParent (similar to #40 ).

We should probably just ignore those ProjectItems.

When adding a new file, LicenseHeaderManager inserts the LicenseHeader without an extra NewLine.

When updating a file, LicenseHeaderManager inserts the LicenseHeader with an extra NewLine.

LicenseHeaderManager should either insert the extra NewLine every time or never.

I'm using version 1.7.0 with VS2015. When trying to add a new license header then I get the error "The system cannot find the file specified".

The project is a C# Class Library located in a folder named Source relative to the solution folder. The name of the project is different from source. It has the format Domain.Product. When adding a new license header definition file, it suggests the name as Source.licenseheader. I have tried renaming it to Domain.Product.licenseheader. But I get the error no matter what.

Any ideas how to resolve this?

Add the extension to VS 2013 Ultimate with SSDT project. Right click SSAS project node => License Headers => Add new license header definition file. Single extension (.sql) with simple header definition.

Edit a .SQL file. Go to EDIT menu => Advanced => ? No command visible for inserting header.
Go back to project node - right click => License Headers => Options... => General => Link 'Add License Header' command to Before Edit.FormatDocument (Ctrl-E + Ctrl-D) => ? Nothing happens. Try linking to other commands => Nothing happens.

When the .licenseheader File contains Languages which are not yet added to the Languages Option Page, we should inform the user.

TBD if the error should be displayed as MessageBox or only in the Output Window.

A command-line version that applies (and possibly also generate the .licenseheader) the header to all files in a project or solution would be a very welcomed addition. In fact, ideally, the extension would invoke the command-line version behind the scenes and display the output to the result pane in Visual Studio. It would also enable maximum code reuse and behavior parity between the extension and the command-line version.

We have an existing project in VSO (Git) and we'd like to insert a license header to all existing files. However, we've wanted to keep the original creator of the file as the Author in the license header. Is this possible?

Trying to add licenseheader to WixProj Items ".wxi, .wxs or .wxl" does not work. There is no licenseheader added and the file just enters an "unsafed changes" state.

1. Copy a linked license header file
2. Paste into a C++ project
   => all sorts of errors occur.

I'm working with linked files,
i.e.: My files "test.cs, test2.cs, etc", are outside of my project and I'm just linking then to my project.

I guess that this plug-in only update files inside the project and that's the why it's not working.

Well, has anyway? with linked files?

See comment #22 (comment) for details.

Returns error -

"The system cannot find the file specified"

This is VC2013 Community Edition. I get this error on insert.

Otherwise, the solution and the code files get littered with the sample file.

Is there a way to add the license header definition file to all projects in the solution at once?

If you run it for a project or solution, headers of 3rd party files (js,..) are also replaced or sometimes the header is added above the existing one.

When using Add/Remove Licenseheader on an opened file, LicenseHeaderManager closes the file.
It should leave the file open and if it was in a "Saved" state before, save it.