The Technical Insights for Stash plugin lets you track the technical debt that is in a repository's code in the form of TODO or FIXME comments.
Viewing Tasks
Technical Insights for Stash has one screen per repository. You find it by selecting the "Tasks" tab once you have navigated to the repository.
| Area | Title | Description |
|---|---|---|
| 1 | Type | Is the comment a TODO or FIXME. |
| 2 | Task | The task in the comment in the source |
| 3 | Path | The file that has the task. Clicking this link will take you to the changeset that first introduced the task. |
| 4 | Last Seen | How long ago it was until a git push was made that contained a change in the file that has the task. |
| 5 | Age | How long has it been since the first git push was made to the repository with a change in this file. |
| 6 | Occurrences | How many times has there been git push's with a change in this file. |
| 7 | Branches | Which branches does this task exist in (and out of those - which one has it been removed from). |
What Administrators see if there are no comments or the repository hasn't been scanned
Scanning the repository can take quite a long time and be system-intensive. So, take care of when you do this and ensure it won't cause usage issues.
Non-administrator users will not see the "scan the repository" button, but rather a message to contact the administrator.
Supported formats
Currently Technical Insights for Stash supports the following extensions and patterns to contain the TODO's or FIXME:
| Parser | Default File extensions | Comment format |
|---|---|---|
| Markup style | *.htm | <!-- TODO: FIXME: --> |
| Java/C style | *.js | // TODO: // FIXME: /* TODO: FIXME: */ |
| Ruby/Perl/Hash style | *.rb | # TODO: |
If there are any other extensions matching the same patterns which are not included by default, the administrator can add additional extensions to each parser in the administration console for this add-on.
