Cake.NDepend

A Cake AddIn that extends the NDepend.Console command line tool.

Usage

Prerequisites

The addin is based on the NDepend.Console command line tool. Before using it, make sure the NDepend installation location is part of the environment variable PATH, and you have a valid license.

Including the addin

To include the addin, add the following to the beginning of the cake script:

#addin "Cake.NDepend"

Use the addin

To use the addin, you need to configure the settings and run the NDepend.Console alias:

#addin "Cake.NDepend"
...
Task("NDepend-Analyse")
    .Description("Runs the NDepend analyser on the project.")
    .Does(() => 
    {
        var settings = new NDependSettings
        {
            ProjectPath = ndependProjectFullPath // Full path to the NDepend project.
        };

        NDependAnalyse(settings);
    });
...

Settings

The NDependSettings have one mandatory option, ProjectPath. The remain options are optional, however, there are certain option combinations that need to be used together. For more information about the usage read the NDepend.Console documentation.

Built With

.NET Framework 4.6 & .NET Core 2.0 - The Framework(s)
NuGet - Dependency Management
Cake - Cross Platform Build Automation System
AppVeyor - Continuous Integration & Delivery Service
TravisCI - Continuous Integration Platform for GitHub
NDepend - Code Quality Platform

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository. For the release notes, see the release notes.

Authors

João Rosa - Initial work - joaoasrosa

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details

Project Support

This project is supported by NDepend with 2 licenses.

laurentkempe / cake-ndepend