todo-tags: rename

Author: domodwyer

.pre-commit-hooks.yaml

@@ -1,6 +1,6 @@
-- id: todo-tagged-jira
-  name: 'TODOs have JIRA tags'
-  entry: todo-jira-check.py
+- id: todo-tags
+  name: 'TODOs have tags'
+  entry: todo-tags.py
   types: [text]
   language: 'script'
   pass_filenames: true

README.md

@@ -3,7 +3,7 @@
 This is a set of [`pre-commit`] hooks for development across multiple languages.
 
 Hooks:
-* `todo-tagged-jira`: ensure all TODO comments reference a JIRA ticket
+* `todo-tags`: ensure all TODO comments reference a JIRA ticket (or any regex matcher)
 * `todo-branch-tags`: show all TODOs tagged with the ticket reference in the branch name
 * `branch-name-check`: checks branch names adhere to the regex `^(feature|bugfix|release|hotfix)\/.+`
 * `go-test`: runs `go test ./...` at the repo root
@@ -24,9 +24,10 @@ repos:
   - repo: https://github.com/domodwyer/pre-commit
     rev: master
     hooks:
-      - id: todo-tagged-jira               # Requires python
+      - id: todo-tags                      # Requires python
         stages: [commit, push, manual]
         args: ["--tag=DEV"]                # JIRA ticket tag (defaults to DEV)
+        # args: ["--regex='.*'"]           # Or specify your own regex
 
       - id: todo-branch-tags
         stages: [post-checkout, manual]    # Show tags when checking out
@@ -79,10 +80,19 @@ repos:
 New TODOs introduced into the codebase should be tracked in JIRA so they're
 eventually done!
 
-The `todo-tagged-jira` hook searches changed files for `TODO` comments (lines
-prefixed by `#` or `//`) that do not reference a JIRA ticket. A valid TODO is in
-the form: `TODO(DEV-4242)`, where the `DEV` tag is configurable, and `4242` is
-the ticket number.
+The `todo-tags` hook searches changed files for `TODO` comments (lines prefixed
+by `#` or `//`) that do not reference a JIRA ticket. A valid TODO is in the
+form: `TODO(DEV-4242)`, where the `DEV` tag is configurable, and `4242` is the
+ticket number.
+
+Instead for more flexibility, you can specify a custom regex to validate TODO
+tags with instead:
+
+```yaml
+      - id: todo-tags
+        stages: [commit, push, manual]
+        args: ["--regex='(dom|clive)'"] 
+```
 
 The `todo-branch-tags` is useful as a [`post-checkout`] hook to print all TODOs
 tagged with the ticket reference in the branch name. If you checkout a branch

todo-jira-check.py todo-tags.pytodo-jira-check.py renamed to todo-tags.py

@@ -13,18 +13,38 @@
 import re
 import sys
 
+DEFAULT_TAG = "DEV"
+
 parser = argparse.ArgumentParser()
-parser.add_argument('-t', '--tag', type=str,
-                    help="The JIRA tag (i.e. DEV) to search for", default="DEV", dest='tag')
+parser.add_argument('-t', '--tag', 
+                    type=str,
+                    help="A JIRA-like tag (i.e. DEV) to search for", 
+                    default=DEFAULT_TAG, 
+                    dest='tag')
+					
+parser.add_argument('-r', '--regex', 
+					type=str,
+                    help="Specify the regex to match inner in TODO(inner)",
+                    dest='regex')
+
 parser.add_argument('files', metavar='FILES', type=str, nargs='+',
                     help='Files to search')
 
 args = parser.parse_args()
 
+# Do not allow specifying a tag and --regex
+if args.regex and args.tag != DEFAULT_TAG:
+	sys.exit("cannot provide tag with --regex")
+
+# Figure out what regex to use
+tag = args.tag + "-[0-9]+"
+if args.regex:
+	tag = args.regex
+
 # This regex matches all TODO comments (prefixed by // or #) that are not
-# immediately followed by "($TAG-0000)"
+# immediately followed by "($TAG)"
 pattern = re.compile(
-    r"(\/\/|#)+\s?TODO((?!\("+args.tag+r"-[0-9]+\)).)*$", re.IGNORECASE)
+    r"(\/\/|#)+\s?TODO((?!\("+tag+r"\)).)*$", re.IGNORECASE)
 
 ret = 0
 for f in args.files: