Verifying Header Comments - Revision history

Bombe: Adjust for Kotlin source files

2019-02-22T23:18:03Z

Adjust for Kotlin source files

Bombe: Escape wiki expression

2015-11-27T06:11:53Z

Escape wiki expression

Bombe: Add script to update years in copyright lines

2015-11-27T06:11:13Z

Add script to update years in copyright lines

Bombe: Fix formatting

2015-11-26T19:23:38Z

Fix formatting

Bombe: Add shell script to find files with non-current copyright years

2015-11-26T19:23:18Z

Add shell script to find files with non-current copyright years

Bombe: Added categories.

2013-01-17T13:07:38Z

Added categories.

Bombe: Add page.

2013-01-17T13:06:25Z

Add page.

New page

A normal Java source file (in my projects) consists of a header like the following one:

<pre>
/*
* FreenetSone - EditImagePage.java - Copyright © 2010–2012 David Roden
*
…
</pre>

It should contain the name of the project and the name of the file. Sometimes, due to refactoring or copy/paste, the filename in the header does not match the name of the file in question. The following bash script will locate those files:

# grep -r "Copyright" src/ | grep "java:" | while read line; do f="$(echo "$line" | cut -d: -f1)"; c="$(echo "$line" | cut -d- -f2 | cut -d' ' -f2)"; f2="$(basename "$f")"; [ "$c" != "$f2" ] && echo "$f: $c"; done

And sometimes you even changed the name of the project at some point in the past. Use the following oneliner to find those files that have a different project name than the one you substitute at the end of the command:

# grep -r "Copyright" src/ | grep "java:" | while read line; do f="$(echo "$line" | cut -d: -f1)"; project="$(echo "$line" | cut -d' ' -f3)"; [ $project != "''Sone''" ] && echo "$f: $project"; done

@@ Line 10: / Line 10: @@
 It should contain the name of the project and the name of the file. Sometimes, due to refactoring or copy/paste, the filename in the header does not match the name of the file in question. The following bash script will locate those files:
-  # grep -r "Copyright" src/ | grep "java:" | while read line; do f="$(echo "$line" | cut -d: -f1)"; c="$(echo "$line" | cut -d- -f2 | cut -d' ' -f2)"; f2="$(basename "$f")"; [ "$c" != "$f2" ] && echo "$f: $c"; done
+  # grep -r "Copyright" src/ | grep -E "\.(java|kt):" | while read line; do f="$(echo "$line" | cut -d: -f1)"; c="$(echo "$line" | cut -d- -f2 | cut -d' ' -f2)"; f2="$(basename "$f")"; [ "$c" != "$f2" ] && echo "$f: $c"; done
 And sometimes you even changed the name of the project at some point in the past. Use the following oneliner to find those files that have a different project name than the one you substitute at the end of the command:
-  # grep -r "Copyright" src/ | grep "java:" | while read line; do f="$(echo "$line" | cut -d: -f1)"; project="$(echo "$line" | cut -d' ' -f3)"; [ $project != "''Sone''" ] && echo "$f: $project"; done
+  # grep -r "Copyright" src/ | grep -E "\.(java|kt):" | while read line; do f="$(echo "$line" | cut -d: -f1)"; project="$(echo "$line" | cut -d' ' -f3)"; [ $project != "''Sone''" ] && echo "$f: $project"; done
 And then there’s the ever-occuring issue with the years in the copyright line. Use this to find files that don’t have the current year as last year in the copyright line.
-  # cy=$(date +%Y); grep -r "Copyright" src/ | grep "java:" | while read line; do f="$(echo "$line" | cut -d: -f1)"; v="$(echo "$line" | cut -d- -f3 | cut -d' ' -f4)"; y="${v:(-4)}"; if [ "$y" != "$cy" ]; then echo "$f: $y"; fi; done
+  # cy=$(date +%Y); grep -r "Copyright" src/ | grep -E "\.(java|kt):" | while read line; do f="$(echo "$line" | cut -d: -f1)"; v="$(echo "$line" | cut -d- -f3 | cut -d' ' -f4)"; y="${v:(-4)}"; if [ "$y" != "$cy" ]; then echo "$f: $y"; fi; done
 To update all files that need updating:
-  # cy=$(date +%Y); sed -i "" -E -e 's,^( \* .*Copyright © )(<nowiki>[[:digit:]]</nowiki>{4})(–<nowiki>[[:digit:]]</nowiki>{4})?(.*)$,\1\2–'$cy'\4,' -- $(grep -r "Copyright" src | grep "java:" | while read line; do f="$(echo "$line" | cut -d: -f1)"; v="$(echo "$line" | cut -d- -f3 | cut -d' ' -f4)"; y="${v:(-4)}"; if [ "$y" != "$cy" ]; then echo "$f"; fi; done)
+  # cy=$(date +%Y); sed -i "" -E -e 's,^( \* .*Copyright © )(<nowiki>[[:digit:]]</nowiki>{4})(–<nowiki>[[:digit:]]</nowiki>{4})?(.*)$,\1\2–'$cy'\4,' -- $(grep -r "Copyright" src | grep -E "\.(java|kt):" | while read line; do f="$(echo "$line" | cut -d: -f1)"; v="$(echo "$line" | cut -d- -f3 | cut -d' ' -f4)"; y="${v:(-4)}"; if [ "$y" != "$cy" ]; then echo "$f"; fi; done)
 [[Category:Programming]]
 [[Category:Java]]
 [[Category:Shell]]

@@ Line 22: / Line 22: @@
 To update all files that need updating:
-  # cy=$(date +%Y); sed -i "" -E -e 's,^( \* .*Copyright © )([[:digit:]]{4})(–[[:digit:]]{4})?(.*)$,\1\2–'$cy'\4,' -- $(grep -r "Copyright" src | grep "java:" | while read line; do f="$(echo "$line" | cut -d: -f1)"; v="$(echo "$line" | cut -d- -f3 | cut -d' ' -f4)"; y="${v:(-4)}"; if [ "$y" != "$cy" ]; then echo "$f"; fi; done)
+  # cy=$(date +%Y); sed -i "" -E -e 's,^( \* .*Copyright © )(<nowiki>[[:digit:]]</nowiki>{4})(–<nowiki>[[:digit:]]</nowiki>{4})?(.*)$,\1\2–'$cy'\4,' -- $(grep -r "Copyright" src | grep "java:" | while read line; do f="$(echo "$line" | cut -d: -f1)"; v="$(echo "$line" | cut -d- -f3 | cut -d' ' -f4)"; y="${v:(-4)}"; if [ "$y" != "$cy" ]; then echo "$f"; fi; done)
 [[Category:Programming]]
 [[Category:Java]]
 [[Category:Shell]]

@@ Line 19: / Line 19: @@
   # cy=$(date +%Y); grep -r "Copyright" src/ | grep "java:" | while read line; do f="$(echo "$line" | cut -d: -f1)"; v="$(echo "$line" | cut -d- -f3 | cut -d' ' -f4)"; y="${v:(-4)}"; if [ "$y" != "$cy" ]; then echo "$f: $y"; fi; done
 [[Category:Programming]]
 [[Category:Java]]
 [[Category:Shell]]

@@ Line 18: / Line 18: @@
 And then there’s the ever-occuring issue with the years in the copyright line. Use this to find files that don’t have the current year as last year in the copyright line.
-# cy=$(date +%Y); grep -r "Copyright" src/ | grep "java:" | while read line; do f="$(echo "$line" | cut -d: -f1)"; v="$(echo "$line" | cut -d- -f3 | cut -d' ' -f4)"; y="${v:(-4)}"; if [ "$y" != "$cy" ]; then echo "$f: $y"; fi; done
+ # cy=$(date +%Y); grep -r "Copyright" src/ | grep "java:" | while read line; do f="$(echo "$line" | cut -d: -f1)"; v="$(echo "$line" | cut -d- -f3 | cut -d' ' -f4)"; y="${v:(-4)}"; if [ "$y" != "$cy" ]; then echo "$f: $y"; fi; done
 [[Category:Programming]]
 [[Category:Java]]
 [[Category:Shell]]

@@ Line 15: / Line 15: @@
   # grep -r "Copyright" src/ | grep "java:" | while read line; do f="$(echo "$line" | cut -d: -f1)"; project="$(echo "$line" | cut -d' ' -f3)"; [ $project != "''Sone''" ] && echo "$f: $project"; done
 [[Category:Programming]]
 [[Category:Java]]
 [[Category:Shell]]

← Older revision		Revision as of 13:07, 17 January 2013
Line 15:		Line 15:

	# grep -r "Copyright" src/ \| grep "java:" \| while read line; do f="$(echo "$line" \| cut -d: -f1)"; project="$(echo "$line" \| cut -d' ' -f3)"; [ $project != "''Sone''" ] && echo "$f: $project"; done		# grep -r "Copyright" src/ \| grep "java:" \| while read line; do f="$(echo "$line" \| cut -d: -f1)"; project="$(echo "$line" \| cut -d' ' -f3)"; [ $project != "''Sone''" ] && echo "$f: $project"; done
		+
		+	[[Category:Programming]]
		+	[[Category:Java]]
		+	[[Category:Shell]]