feat: Clojure support

CHANGELOG.md

@@ -9,7 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Support for CoffeeScript was added.
+- Support for [Clojure](https://clojure.org/) and
+  [CoffeeScript](https://coffeescript.org/) were added.
 
 ### Fixed
 

README.md

@@ -93,6 +93,7 @@ In order for the comments to be more easily parsed keep in mind the following:
 - TODOs should have a colon if a message is present so it can be distingished
   from normal comments.
 - Comments can be on the same line with other code (e.g. `x = f() // TODO: call f`
+- Line comment start sequences can be repeated (e.g. `//// TODO: some comment`)
 - Only the single line where the TODO occurs is printed for multi-line comments.
 - `TODO`,`FIXME`,`BUG`,`HACK`,`XXX`,`COMBAK` are supported by default. You can
   change this with the `--todo-types` flag.

internal/scanner/languages.yml

@@ -61,6 +61,12 @@ C#:
     - start: "'"
       end: "'"
       escape: backslash
+Clojure:
+  line_comment_start: [";"]
+  strings:
+    - start: '"'
+      end: '"'
+      escape: backslash
 CoffeeScript:
   line_comment_start: ["#"]
   multiline_comment:

internal/scanner/scanner_test.go

@@ -154,6 +154,82 @@ var scannerTestCases = []*struct {
 		},
 	},
 
+	// Clojure
+	{
+		name: "line_comments.clj",
+		src: `; file comment
+
+			;; TODO is a function.
+			(defn TODO [] (str "Hello") ) ; Random comment
+			;;; extra comment ;;;`,
+		config: "Clojure",
+		comments: []struct {
+			text string
+			line int
+		}{
+			{
+				text: "; file comment",
+				line: 1,
+			},
+			{
+				text: ";; TODO is a function.",
+				line: 3,
+			},
+			{
+				text: "; Random comment",
+				line: 4,
+			},
+			{
+				text: ";;; extra comment ;;;",
+				line: 5,
+			},
+		},
+	},
+	{
+		name: "comments_in_string.clj",
+		src: `; module comment
+
+			; TODO is a function
+			(defn TODO [] (str "; Random comment") )
+			`,
+		config: "Clojure",
+		comments: []struct {
+			text string
+			line int
+		}{
+			{
+				text: "; module comment",
+				line: 1,
+			},
+			{
+				text: "; TODO is a function",
+				line: 3,
+			},
+		},
+	},
+	{
+		name: "escaped_string.clj",
+		src: `; module comment
+
+			; TODO is a function
+			(defn TODO [] (str "\"; Random comment") )
+			`,
+		config: "Clojure",
+		comments: []struct {
+			text string
+			line int
+		}{
+			{
+				text: "; module comment",
+				line: 1,
+			},
+			{
+				text: "; TODO is a function",
+				line: 3,
+			},
+		},
+	},
+
 	// CoffeeScript
 	{
 		name: "line_comments.coffee",

internal/todos/todos.go

@@ -100,7 +100,7 @@ func NewTODOScanner(s CommentScanner, config *Config) *TODOScanner {
 	sConfig := s.Config()
 	var commentStarts []string
 	for _, lineCommentStart := range sConfig.LineCommentStart {
-		commentStarts = append(commentStarts, regexp.QuoteMeta(lineCommentStart))
+		commentStarts = append(commentStarts, "(?:"+regexp.QuoteMeta(lineCommentStart)+")+")
 	}
 	commentStartMatch := strings.Join(commentStarts, "|")
 

internal/todos/todos_test.go

@@ -718,6 +718,29 @@ func TestTODOScanner(t *testing.T) {
 				},
 			},
 		},
+		"extra_line_comment_prefix.go": {
+			s: &testScanner{
+				comments: []*scanner.Comment{
+					{
+						Text: "//// TODO: comment",
+						Line: 1,
+					},
+				},
+			},
+			config: &Config{
+				Types: []string{"TODO"},
+			},
+			expected: []*TODO{
+				{
+					Type:        "TODO",
+					Text:        "//// TODO: comment",
+					Label:       "",
+					Message:     "comment",
+					Line:        1,
+					CommentLine: 1,
+				},
+			},
+		},
 	}
 
 	for name, tc := range testCases {