FxCop Integrator 3.0.0 Preview 1 Released

In Dec 11 2011, I released FxCop Integrator 3.0.0 Preview 1.

 

This release can be installed in VS11 Developer Preview.

So you can use same features as FxCop Integrator 2.0.0 RTW on VS11 Develop Preview.

 

FxCop Integrator 3.0.0 Preview 1 is available here.

FxCop Integrator 2.0.0 RTW Released

In Dec 4 2011, I released FxCop Integrator 2.0.0 RTW.

 

This release contains following new features:

• Supported calculating code metrics with Code Metrics PowerTool.
• Provided MSBuild tasks.
• Supported to filter out auto-generated code from code analysis result.
• Supported exporting report of code analysis result.
• Supported multi-project analysis.
• Supported file level analysis.
• Added the feature to let developers more easily add a "SuppressMessage" tag into the code.

And also it contains many improvements and bug fixes.

 

FxCop Integrator 2.0.0 RTW is available here.

FxCop Integrator 2.0.0 RC Released

In Nov 27 2011, I released FxCop Integrator 2.0.0 RC. You can download it from CodePlex project site.

The 2.0.0 RC contains following new features.

 

 

Provides MSBuild tasks

I implemented MSBuild custom tasks to execute code inspection and code metrics calculation. These MSBuild tasks work the same as FxCop Integrator’s on-demand execution.

You can install MSBuild tasks with the msi installer not VSIX. So, you can install them to the machine that doesn’t have Visual Studio (e.g. CI server).

 

The MSBuild tasks installer creates %PROGRAMFILES%\MSBuild\FxCop Integrator\FxCopIntegrator.targets. When you add

<Import Project="$(PROGRAMFILES)\MSBuild\FxCop Integrator\FxCopIntegrator.targets" />

to the project file and specify

/p:FxCopCmdPath=”the path of FxCopCmd.exe” /p:EnableCodeInspectionOnBuild=true

as MSBuild command line parameter, MSBuild executes code inspection after build.

FYI, when you specify following command line parameter, MSBuild executes code metrics calculation after build.

/p:MetricsPath=”the path of Metrics.exe” /p:EnableCodeMetricsCalculationOnBuild=true

 

The internal specification of the “Code Analysis on Build” feature was changed.

In 2.0.0 Beta 2 or before, the specification of this feature is

1. When the FxCop Integrator extension is loaded, it generates “CodeAnalysis.exe” that can analyze code the same as FxCop Integrator’s on-demand execution.
2. When user enable '”Code Analysis on Build”, FxCop Integrator changes a project file to add the Exec MSBuild task to execute CodeAnalysis.exe into the “AfterBuild” target.

But 2.0.0 RC or later,

1. When user install FxCop Integrator MSBuild tasks and enable “Code Inspection on Build”, FxCop Integrator changes a project file to import the above targets file and to add the EnableCodeInspectionOnBuild property.

For backward compatibility, you can still use the old style “Code Analysis on Build” feature, but it will be deprecated in the future release.

 

 

Warning Filtering Feature

I implemented the warning filtering feature to filter out warnings against the code that is defined in a designer file or an auto-generated file.

You can define filtering patterns with the code analysis configuration editor.

 

 

By default, FxCop Integrator defines filtering patterns to filter out designer code (e.g. *.Designer.cs, etc) and auto-generated code (e.g. *.generated.cs, *.g.cs, etc).

FxCop Integrator 2.0.0 Beta 2 Released

In Nov 11 2011, I released FxCop Integrator 2.0.0 Beta 2. You can download it from CodePlex project site.

FxCop Integrator is a Visual Studio 2010 extension that integrates FxCop to VS2010 and makes it easy to execute FxCop like VS2010 Premium/Ultimate. It also supports to filter code analysis results and shows the FxCop rule detail.

Version 2.0.0 supports to execute Metrics.exe (Visual Studio Code Metrics Power Tools 10.0) and provides some new features.

 

 

Visual Studio Code Metrics Power Tools 10.0 Integration

FxCop Integrator 2.0.0 supports to integrate Visual Studio Code Metrics Power Tools 10.0. You can easily execute Metrics.exe on the Solution Explorer.

 

When you execute code metrics calculation, FxCop Integrator shows calculation result as below.

 

Because FxCop Integrator supports FxCop and Metrics, I added some menus for executing code analysis.

• [Code Analysis] : Execute both FxCop and Metrics.
• [More Tasks…] > [Inspect XXX] : Execute FxCop only. 
• [More Tasks…] > [Calculate Metrics] : Execute Metrics only.

 

But if you don’t want to use Metrics, you can change the [Code Analysis] menu behavior from option page.

 

 

Multi-Project Analysis, File Level Analysis

FxCop Integrator 1.X only supported to analyze all projects in a solution or a single project. But 2.0.0 supports to analyze selected multi-project.

 

Also you can analyze only some types that are defined in the specified file. This feature can be used when the language of source code is C# or VB.NET. And, this doesn’t support code metrics calculation.

 

 

Message Suppression

The Suppress Message is added in the Rule Detail window to let developers more easily add a “SuppressMessage” attribute into the code.

 

 

Export Code Analysis Result

The [Export] menu is added in the Code Inspection Result window and the Code Metrics Calculation Result window. You can export code analysis result as CSV.

 

 

And more improvements and bug fixes.

 

I’ll release FxCop Integrator 2.0.0 RTW in late November or early December.

FxCop Integrator 1.4.0 Planned Feature Set

After I released FxCop Integrator 1.3.0 on Apr 24 2011, I received some bug reports. The cause of them is the "Code Analysis on Build" feature that is implemented in 1.3.0. I don't know why, but event handlers of Visual Studio build events, are used by this feature, don't work in VS2010 SP1. So I immediately released 1.3.0p1 that is disabled this feature.

In 1.4.0, I'll enable the "Code Analysis on Build" feature again. I plan to implement it with a different way, thus it should be able to be used on VS2010 SP1.


I also plan to implement following features,

Enable customization of data grid of code analysis result window. I'll enable data grid of code analysis result window to sort, show/hide columns and persistent column settings.

More useful error report window. I'll add the error report window that makes it easy to send feedback.


I'll release FxCop Integrator 1.4.0 in May 22 2011.

FxCop Integrator 1.3.0p1 Released

I've released FxCop Integrator 1.3.0p1.

In this release, I temporarily disabled the "Code Analysis on Build" feature that is implemented in ver1.3.0, because I realized that events of EnvDTE.BuildEventsClass don't raised on VS2010 SP1(*). "Code Analysis on Build" depends to their events, so I had no choice but to disable it. I'll enable this feature in the future release if I can find out a workaround.
This version is also improved performance and fixed some bugs.


* I sent a feedback about this problem to Microsoft Connect.

How to store/restore UI state of Visual Studio tool window pane

A tool window pane of Visual Studio is a class that inherits from Microsoft.VisualStudio.Shell.ToolWindowPane. We can create a sub classes of this to add custom a tool window pane to our VSPackage.

ToolWindowPane class has overridable SaveUIState and LoadUIState methods. It seems that we can use them to store/restore UI state of tool window pane, but thier methods are never called. According to this thread, it looks like their methods are only called on document windows not tool window panes.

Instead of SaveUIState and LoadUIState, we can use OnCreate and OnClose methods. Just like the name implies, OnCreate is called when a tool window pane is created, and OnClose is called when a tool window pane is closed. So if we override them, we can implement the feature to store/restore UI state.

For example, we can store UI state to xml file and restore UI state from xml file like this.

public CustomToolWindowPane : ToolWindowPane
{
    private string path;

    public CustomToolWindowPane()
    {
        ...
        var directory = Path.GetDirectoryName(typeof(CustomToolWindowPane).Assembly.Location);
        path = Path.Combine(directory, "uistate.xml");
    }

    protected override void OnCreate()
    {
        using (var stream = File.Open(path, FileMode.Open))
        {
            var serializer = new XmlSerializer(typeof(UIState));
            var state = (UIState)serializer.Deserialize(stream);
            ApplyUIState(state);
        }
    }

    private void ApplyUIState(UIState state)
    {
        ...
    }

    protected override void OnClose()
    {
        var state = BuildUpUIState();
        using (var stream = File.Open(path, FileMode.Create))
        {
            var serializer = new XmlSerializer(typeof(UIState));
            serializer.Serialize(stream, state);
        }
    }

    private UIState BuildUpUIState()
    {
        ...
    }


    public class UIState
    {
        ...
    }
}