CodeTwig - A code viewer and analyser

See below for more screenshots

Go to downloadable releases

Go to the user-manual

Forthcoming version: 1.652

Description CodeTwig

CodeTwig (CT) is terminal-program to view the outline of the source-code and to show procedures as usage-trees or used-by-trees. Some features are still to be added. See future-plans below. Currently only meant for Nim.

Features

• CT scans the source-code-files on basis of the project you have defined and adds the files from all underlying directories (after which you can prune the list).
• It creates a declaration-list in which all declarations like procs and templates are listed
• The declaration-list is used to generate 4 text-files that give specific views of the project.
• CT can also show (for a certain declaration / proc) the usage-trees and used-by trees on basis of the dec-list, and gives with it the arguments and the comment-section.
• a source-code-view option (-c:s); search and show the full source-code of the proc /declaration.
• flexible semicolumn-separated search: declaration;module;project
• multiproject-feature; CT can combine dec-list of multiple projects and thus show trees for multiple projects (multiproject-feature).
• all functions are called by entering terminal-commands, allthough the generated view-files can be watched by themselves of course.

Installation by building

Since the program (at this stage) is for Nim only, users = programmers are assumed to be able to build the executable themselves. Developers can download a release, or clone the code (CodeTwig has no external components) and do the following:

Run the command: nim c -d:release ctwig.nim which will compile the code to an executable for you local OS.

Using CodeTwig

Go to the user-manual

What's new in x.y?

Open the whats-new-file

Or look at the commits. Commits-list

Completed from future plans

• 1.62
  • removed bug caused by short project-names
  • added declaration-types method, iterator and converter
• 1.65
  • within search now you can use line-start-appending to uniquify overloaded names use like: someproc~linenumber
  • to limit false positives, dec-usages are now limited to:
    • the imported modules
    • only declarations with the right boundary-characters are added (without param-evaluation false positives are still to be expected; however I have no plans to add param-eval)

Remaining future plans:

• add an options-file (for example for customizing the number of comment-lines)
• multiproject-level regeneration of individual project-files.
• add a command to view a full module (instead of just a declaration)

Maybe ever?

• command-history

More screenshots: Forthcoming.