Code Monkey home page Code Monkey logo

codetopology's Introduction

CodeTopology

A tool to visualise your codebase.

TortoiseSVN install

Supported repositories:

  • Git
  • SVN

Supported presentation modes:

  • Code ownership
  • Programming languages
  • Commits count

How to use it

prerequisites

  1. CodeTopology is using svn.exe to generate svn log. It is a part of TortoiseSVN so you have to install TortoiseSVN with selected "command line client tools" option. This is required only for SVN repositories.

  2. Script file dowloaded from the internet may be blocked. Before running script remember to unblock GenerateReport.ps1 file. In order to unblock script go to file options, find "Security" section on "General" tab and select "Unblock" option.

Generate report

To generate CodeTopology report run the following script from powershell console

  • For Git repository
.\GenerateReport.ps1 -Verbose -VCS Git -CheckoutDir path_to_your_repository_checkout_dir
  • For SVN repository
.\GenerateReport.ps1 -Verbose -VCS SVN -CheckoutDir path_to_your_repository_checkout_dir

By default CodeTopology ignores the following directories: "Bin","Obj","Lib","bin","obj","packages","lib","App_Data","node_modules", "bower_components".

If you want to extend this list use DirToExclude parameter as follows:

  • To ignore single dist directory
.\GenerateReport.ps1 -VCS Git -DirToExclude dist  -CheckoutDir path_to_your_repository_checkout_dir
  • To ignore dist1 and dist2 directories
.\GenerateReport.ps1 -VCS Git -DirToExclude dist1, dist2  -CheckoutDir path_to_your_repository_checkout_dir

TeamCity integration

To get know how to integrate CodeTopology with TeamCity please visit project's Wiki.

codetopology's People

Contributors

cezarypiatek avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.