Version 34 (modified by giel, 6 years ago) (diff)

Update for addition of exclude_files

A plugin for displaying code tags (XXX, FIXME, TODO, etc.)

Demo here, git repository. Since I cannot find any documentation directly I just wanted to tell you people that you need a subdirectory named cache thats writeable by your trac to make this work. Oh and dont wonder that it takes so much time the first time used ;). Also don't forget to grant the CODETAGS_VIEW permission.

To enable in the trac.ini:

codetags.* = enabled

Additional configuration options in trac.ini:

scan_files = *.html, *.py, *.c, *.h, *.hh, *.m, *.pch, *.hpp
scan_folders = trunk/*, branches/*

scan_files allows you to define specific file types to scan (default: *)
scan_folders specifies which directories within the repository to scan (default: *)
exclude_folders specifies directories that are subdirectories of scan_folders but don't need to be scanned
exclude_files specifies files that shouldn't be scanned even though they're included by scan_files
tags allows you to specify what tags to locate, though only the defaults are colored at all. (default: XXX, TODO, FIXME)

By default, this plugin doesn't ignore binary files. If you use svn/trac in a web-dev environment, this is a pain, since the tagger finds tags in files such as .gif.

User submitted patch seems to work:

This patch is now most likely unnecessary though, because CodeTagsPlugin plugin now searches for word boundaries (regex '\b') at the edges of words.

Last Release Version

The last CodeTagsPlugin release is codetags-0.2.tar.gz.


  • When moving/deleting files with TODO tags in them, they will not disappear from the list
    • I've tested this and it works fine for me - rjollos 2009-08-03.
      • I am seeing this running Trac 0.12dev-r8983 and codetags-0.2 - aaron@…
        • Running trac 0.11 (debian repo) I see this issue in codetags-0.2 - dagherad_at_gmail_dot_com (27th January 2010)

Feature Request

Since the tracker has no CodeTags component I will put that here:

  • Having a huge code base makes the table with the tags so huge that even modern browsers can hardly display it. Maybe:
    • Split it up into multiple pages
    • Choose display for only specified tags
    • Chose display for only specified path in repository
  • Allowing regex's for the [code-tags] fields would increase flexibility (scan_files, scan_folders, tags).

Attachments (2)

Download all attachments as: .zip