Navigation Menu

Skip to content

pawelklimczyk/CodeWatch

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

56 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Gmtl.CodeWatch library

Build Status

Build status NuGet

Idea

Idea behind creating CodeWatch was to add quality layer in developed product. Developers may use different IDE and programming techniques in the same project. Some tools (like FxCop) are difficult to use outside expected IDE. Developers agree to follow "coding standards" and forget to do that later.

This tool is not a panacea. It's rather a complementary piece that can help you achieve better code quality. It does not think on your behave, but automates it a little.

What CodeWatch can solve?

  • Automates rules checking during unit/integration testing
  • Keep code conventions along with the project (in XML file)

Examples

All fields in given assembly has to be uppercase

[TestFixture]
public class GlobalContextTests
{
    [Test]
    public void FluentConfigurationBuilder()
    {
        CodeWatcherConfig config = CodeWatcherConfig.Create()
            .WithWatcher(c => new FieldNamingWatcher(c).Configure(Naming.UpperCase))
            .WatchAssembly(typeof(DomainModel).Assembly)
            .Build();
            
        var result = config.Execute(); 
        
        //this will fail
        Assert.IsFalse(result.HasIssues);
    }
}

All properties in given assembly have to be uppercase, but skip DomainModel class from checking

[TestFixture]
public class GlobalContextTests
{
    [Test]
    public void FluentConfigurationBuilder()
    {
        CodeWatcherConfig config = CodeWatcherConfig.Create()
            .WithWatcher(c => new PropertyNamingWatcher(c).Configure(Naming.UpperCase))
            .WatchAssembly(typeof(DomainModel).Assembly)
            .SkipType(typeof(DomainModel))
            .Build();

        var result = config.Execute(); 
        
        //this will fail
        Assert.IsFalse(result.HasIssues);
    }
}

All properties in multiple assemblies have to be uppercase

[TestFixture]
public class GlobalContextTests
{
    [Test]
    public void FluentConfigurationBuilder()
    {
        CodeWatcherConfig config = CodeWatcherConfig.Create()
            .WithWatcher(c => new PropertyNamingWatcher(c).Configure(Naming.UpperCase))
            .WatchAssembly(typeof(DomainModel).Assembly)
            .WatchAssembly(typeof(PersistenceLayer).Assembly)
            .WatchAssembly(typeof(DomainServices).Assembly)
            .Build();

        var result = config.Execute(); 
        
        //this will fail
        Assert.IsFalse(result.HasIssues);
    }
}

All try/catch clauses in given assembly have to be handled

[TestFixture]
public class GlobalContextTests
{
    [Test]
    public void FluentConfigurationBuilder()
    {
        CodeWatcherConfig config = CodeWatcherConfig.Create()
            .WithWatcher(c => new ExceptionHandlingWatcher(c))
            .WatchAssembly(typeof(DomainModel).Assembly)
            .Build();

        var result = config.Execute(); 
        
        //this will fail
        Assert.IsFalse(result.HasIssues);
    }
}

All methods in assembly neet to have at most 4 parameters

[TestFixture]
public class GlobalContextTests
{
    [Test]
    public void FluentConfigurationBuilder()
    {
        CodeWatcherConfig config = CodeWatcherConfig.Create()
            .WithWatcher(c => new MaxMethodParametersWatcher(c).Configure(4))
            .WatchAssembly(typeof(DomainModel).Assembly)
            .Build();

        var result = config.Execute(); 
        
        //this will fail
        Assert.IsFalse(result.HasIssues);
    }
}

All methods return types must be of type IList

[TestFixture]
public class GlobalContextTests
{
    [Test]
    public void FluentConfigurationBuilder()
    {
        CodeWatcherConfig config = CodeWatcherConfig.Create()
            .WithWatcher(c => new MethodReturnTypeWatcher(c).Configure(typeof(IList<object>)))
            .WatchAssembly(typeof(DomainModel).Assembly)
            .Build();

        var result = config.Execute(); 

        //this will fail
        Assert.IsFalse(result.HasIssues);
    }
}

I miss a feature....

You are very welcome to add a pull request.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages