Powershell script to generate a TODO report

You can use this from your CI build process, help keep the code base clean. I am a big fan of the TODO: comment, but you don't want too many building up in the code base at some point you either need 'TO DO IT' or else forget about it.

	$fileName = "_2-DO_log.txt"
	$max = 20
	$encoding = "ASCII"
	# remove previous file if exists
	if(Test-Path $fileName) { Remove-Item $fileName }
	# dump 2-do report to the file system
	Get-ChildItem –rec –include *.config,*.cs,*.js,*.cshtml,*.css,*.aspx |
	where { $_ -notmatch 'lib' } |
	where { $_ -notmatch 'Test' } |
	select-string TODO |
	out-string -width 4096 |
	out-file $fileName -encoding $encoding
	# get the line count of the report
	$content = Get-Content .\$fileName
	$count = $content.Count.ToString()
	# Write-Host "Total count is $count"
	# verify we don't have too many entries
	if($content.Count -gt $max)
	{
	$message = "TO DO comment count has been exceeded. Max Allowed is $max but found $count for the entire solution, excluding lib files and Test projects"
	# prepend the message before the data
	$message | out-file $fileName -encoding $encoding
	$content | add-content $fileName
	Throw [system.Exception]($message)
	}

view raw TODO-Report.ps1 hosted with ❤ by GitHub

the above script is excluding all files found under lib or Test directories, and selecting only a subset of file types. Modify to your needs