Microsoft StyleCop

NEW POST: thread safety

Pieter — Fri, 21 Nov 2008 13:04:52 GMT

Hi,

I have create an plugin for StyleCop with my own rules. Sometimes we encounter strange unpredictable behavier in the usage pf stylecopy.
For instance
- it hangs and takes all cpu time
- my rules plugin sometimes incorrectly reports errors and when running it for a second time the errors are gone.

I found out that the stylecop uses multiple threads for analyzing the document. This shouldn't be a problem if it was properly documented (i haven't found anything in the docs). Or if it was implemented in such a way, that there was an instance of your SourceAnalyzer class created for every thread of stylecop. Then your own class derived from SourceAnalyzer doesn't have to be thread safe.
At this moment there will be only one instance created of your class that inherits from SourceAnalyzer and the AnalyzeDocument method is called from multiple StyleCop threads.

Is it possible to document this, or make sure that classes that inhered from SourceAnalyzer don't have to be thread safe.

COMMENTED ISSUE: warning: SA0102: A syntax error has been discovered in file ... (unsupported characters)

AlexeyR — Fri, 21 Nov 2008 10:56:45 GMT

The problem was for instance that the name of a textbox was "textBoxSonderprüfungen". After replacing to "textBoxSonderpruefungen" it works.

Sorry, I don't know how I can send the whole file to you.

Comments: This issue appears when a source file (.cs file) is stored in a format different from UTF-8 format. For example if we store a file in Windows-1251 encoding and use cyrillic letters in C# indentfiers then we get exactlty the same error. At the same time C# compiler processes this file without errors.

EDITED ISSUE: SA1642: Error with generics

jasonall — Thu, 20 Nov 2008 19:25:54 GMT

When documenting a generic class, only allows <see cref="MyClass"/> and not <see cref="MyClass`1"/>.

MyClass and MyClass<T> may both exist and aren't the same.

COMMENTED ISSUE: SA1642: Error with generics

jasonall — Thu, 20 Nov 2008 19:25:53 GMT

When documenting a generic class, only allows <see cref="MyClass"/> and not <see cref="MyClass`1"/>.

MyClass and MyClass<T> may both exist and aren't the same.
Comments: A fix for this issue has been identified and will be included in the next update to StyleCop 4.3

COMMENTED ISSUE: warning: SA0102: A syntax error has been discovered in file ... (unsupported characters)

serega — Thu, 20 Nov 2008 15:34:12 GMT

COMMENTED ISSUE: warning: SA0102: A syntax error has been discovered in file ... (unsupported characters)

uth — Thu, 20 Nov 2008 14:32:55 GMT

EDITED FEATURE: New '#region' rules

jasonall — Tue, 18 Nov 2008 13:55:46 GMT

I would like to have some rules about spacing around the '#region' and '#endregion' code elements.
- '#region' must be preceeded by a blank line or other '#region'
- '#region' must not be followed by a blank line
- '#endregion' must not be preceeded by a blank line
- '#endregion' must be followed by a blank line or other '#endregion' (except curly braces, etc)

For example, the following must not be allowed:
#region MyRegion

void Foo()
{
}

#endregion

and replaced by:
#region MyRegion
void Foo()
{
}
#endregion

CREATED ISSUE: New '#region' rules

Cheetah — Tue, 18 Nov 2008 12:48:32 GMT

CLOSED ISSUE: SA1643: Error with generics

jasonall — Mon, 17 Nov 2008 10:18:15 GMT

When documenting a generic class, only allows <see cref="MyClass"/> and not <see cref="MyClass`1"/>.

MyClass and MyClass<T> may both exist and aren't the same.
Comments: Closing as duplicate of issue number 63

EDITED ISSUE: Equality operator recommendations wrong.

jasonall — Mon, 17 Nov 2008 10:12:47 GMT

COMMENTED ISSUE: Equality operator recommendations wrong.

jasonall — Mon, 17 Nov 2008 10:12:46 GMT

So I have the following code in a class;

public static bool operator ==(Resource left, Resource right)
{
return Equals(left, right);
}

public static bool operator !=(Resource left, Resource right)
{
return !Equals(left, right);
}

public bool Equals(Resource resource)
{
if (ReferenceEquals(null, resource))
{
return false;
}

if (ReferenceEquals(this, resource))
{
return true;
}

return string.Equals(...)&& etc;
}

public override bool Equals(object obj)
{
if (ReferenceEquals(null, obj))
{
return false;
}

if (ReferenceEquals(this, obj))
{
return true;
}

return obj.GetType() == typeof(Resource) && this.Equals((Resource) obj);
}

As you can see the == and != are static; but the Equals functions aren't (no surprise there). However for some reason style cop complains at the == and != demanding a this qualifier;

"The call to Equals must begin with the 'this.' prefix to indicate that the item is a member of the class."

Except of course that can't happen as it's a static method ....
Comments: This is due to a current limitation in the tool. The StyleCop analysis engine does not have access to the type definition for the object type and thus does not realize that the Equals method being called in these cases is the static Object.Equals. This will be fixed in a later version of the tool. For now, this issue can be worked around by changing "return Equals(left, right);" to "return object.Equals(left, right);" This arguably makes the code more readable as well. Thanks for filing the issue.

EDITED ISSUE: Class without explicit access modifier marked as "public" instead of "internal"

jasonall — Mon, 17 Nov 2008 10:06:59 GMT

While analysing a file named

COMMENTED ISSUE: Class without explicit access modifier marked as "public" instead of "internal"

jasonall — Mon, 17 Nov 2008 10:06:56 GMT

While analysing a file named
Comments: From the C# 3.0 Language Specification: • Types declared in compilation units or namespaces can have public or internal declared accessibility and default to internal declared accessibility. A fix for this bug is ready and will be included in the next update to StyleCop 4.3

EDITED ISSUE: Equality operator recommendations wrong.

jasonall — Mon, 17 Nov 2008 09:17:19 GMT

EDITED ISSUE: warning: SA0102: A syntax error has been discovered in file ... (unsupported characters)

jasonall — Mon, 17 Nov 2008 09:14:41 GMT

COMMENTED ISSUE: warning: SA0102: A syntax error has been discovered in file ... (unsupported characters)

jasonall — Mon, 17 Nov 2008 09:14:41 GMT

EDITED ISSUE: Certain projects cause error message on "Run StyleCop"

jasonall — Mon, 17 Nov 2008 09:12:56 GMT

Certain non-standard VS projects cause StyleCop 4.3 to error out if you choose Run StyleCop on the solution. For example, having an AQTime profiler project loaded as part of your solution causes this. (This is a new error as of StyleCop 4.3).

The error received on run is:
The method or operation is not implemented.

You can still run Style Cop on individual projects in the solution successfully. Unloading the profile project will allow StyleCop to run, but it will fail if the project is loaded.

COMMENTED ISSUE: Certain projects cause error message on "Run StyleCop"

jasonall — Mon, 17 Nov 2008 09:12:53 GMT

EDITED ISSUE: VS crashed for webservices.

jasonall — Mon, 17 Nov 2008 09:11:43 GMT

Woupiiiii. I finally was able to repro the problem (why am I happy? :) )

So this is definetly a bug in the tool, here are the exact repro steps I used:
Open VS.
In the menus, choose File->New->Website which brings up the dialog "new web site"
In the dialog choose ->Asp.Net Web Service.
Set location to HTTP and use a URL like this: http://localhost/WebSite
Once the project is loaded in the solution explorer, right click the website project node and choose "Run StyleCop"

Expected result, the tool runs.
Actual result: VS crashes due to an unhandled exception occurring on the background thread.

It seems logical to me that we have a problem here. The tools is trying to merge settings with settings files in the parent folder of the project (that works for folders on the harddisk). but the parent on the webserver has a different meaning than a parent folder for a regular folder on disk.

COMMENTED ISSUE: VS crashed for webservices.

jasonall — Mon, 17 Nov 2008 09:11:41 GMT