Fabio Cicerchia - English

Web 2.0 Developer & PHP Programmer (ZCE)

September 3, 2008

TODO List

This is a draft, until it becomes a final version can undergo frequent changes over time

How to simplify the development of applications based web development environments? Tired of having to search the source code of the comments that you remember what to do or what change? I created a little script very useful for this purpose, that I use in my daily work. The operating principle is to check the files of a project for you to find specific comments included in the code and generate a page of report, or through command line print in the terminal the report generated. Once downloaded and decompressed the script in your folder on the web server that simply go to the url:

http://localhost/todo/?demo

Or from the command line:

cd /path/to/todolist/
./index.php demo

where instead of demo put the name of configuration files to upload, which carryover below the version by default customize:

[settings]
; token for grep the fix comments
comment_token           =   "///"
; token that mark the fix as fixed
fixed_token             =   "#FIXED"
; token to set the priority level
priority_token          =   "!"
; token to set the hold status
hold_token              =   "@"
; token to set the workinprogress status
wip_token               =   "."
; show file without fix
show_file_without_fix   =   0
; show additional info
show_info               =   1
; set the refresh time (0 = disabled)
refresh                 =   30
; set the url path to cvs/svn web interface
version_control_web     = "http://localhost/cvsw/"
 
[paths]
; list of path to be parse
directories = /path/to/be/analyze/
 
[filters]
; allowed extensions
extensions = php, js, tpl, inc
 
[exceptions]
; blocked pattern in path &amp; file name
blocked =

The syntax of default is the follows, but can be customized in the configuration file:

/// comment to be displayed in the report
/// comment to be displayed in the report with priority 3!!!
/// comment to be displayed in the report with priority 4!!!!
///@ comment to be displayed in the report with status "pending"
///. comment to be displayed in the report with status "in progress"
///#FIXED comment fix to be displayed in the report as resolved

NOTE: To perform as a command line you need to modify the hashbang (the #!) With the correct path to the compiler php, in the file index.php.