Use one #codetags rule in comments and docstrings

Yury Selivanov · Yury Selivanov · commit ca56cac35849 · 2015-10-17T15:36:15.000-04:00
diff --git a/grammars/MagicPython.YAML-tmLanguage b/grammars/MagicPython.YAML-tmLanguage
@@ -105,7 +105,7 @@ repository:
           '1': {name: punctuation.definition.string.end.python}
         patterns:
           - include: '#docstring-prompt'
-          - include: '#docstring-codetags'
+          - include: '#codetags'
           - include: '#docstring-guts-unicode'
 
       - name: string.quoted.docstring.raw.multi.python
@@ -119,7 +119,7 @@ repository:
         patterns:
           - include: '#string-consume-escape'
           - include: '#docstring-prompt'
-          - include: '#docstring-codetags'
+          - include: '#codetags'
 
       - name: string.quoted.docstring.python
         begin: (\'|\")
@@ -130,7 +130,7 @@ repository:
           '1': {name: punctuation.definition.string.end.python}
           '2': {name: invalid.illegal.newline.python}
         patterns:
-          - include: '#docstring-codetags'
+          - include: '#codetags'
           - include: '#docstring-guts-unicode'
 
       - name: string.quoted.docstring.raw.python
@@ -144,7 +144,7 @@ repository:
           '2': {name: invalid.illegal.newline.python}
         patterns:
           - include: '#string-consume-escape'
-          - include: '#docstring-codetags'
+          - include: '#codetags'
 
   docstring-guts-unicode:
     patterns:
@@ -162,10 +162,10 @@ repository:
     captures:
       '1': {name: keyword.control.flow.python}
 
-  docstring-codetags:
+  codetags:
     match: (?:\b(NOTE|XXX|HACK|FIXME|BUG|TODO)\b)
     captures:
-      '1': {name: keyword.string.quoted.docstring.note.python}
+      '1': {name: keyword.codetag.notation.python}
 
   statement-keyword:
     patterns:
diff --git a/grammars/MagicPython.cson b/grammars/MagicPython.cson
@@ -91,7 +91,7 @@ repository:
             include: "#docstring-prompt"
           }
           {
-            include: "#docstring-codetags"
+            include: "#codetags"
           }
           {
             include: "#docstring-guts-unicode"
@@ -118,7 +118,7 @@ repository:
             include: "#docstring-prompt"
           }
           {
-            include: "#docstring-codetags"
+            include: "#codetags"
           }
         ]
       }
@@ -136,7 +136,7 @@ repository:
             name: "invalid.illegal.newline.python"
         patterns: [
           {
-            include: "#docstring-codetags"
+            include: "#codetags"
           }
           {
             include: "#docstring-guts-unicode"
@@ -162,7 +162,7 @@ repository:
             include: "#string-consume-escape"
           }
           {
-            include: "#docstring-codetags"
+            include: "#codetags"
           }
         ]
       }
@@ -191,11 +191,11 @@ repository:
     captures:
       "1":
         name: "keyword.control.flow.python"
-  "docstring-codetags":
+  codetags:
     match: "(?:\\b(NOTE|XXX|HACK|FIXME|BUG|TODO)\\b)"
     captures:
       "1":
-        name: "keyword.string.quoted.docstring.note.python"
+        name: "keyword.codetag.notation.python"
   "statement-keyword":
     patterns: [
       {
@@ -1676,10 +1676,7 @@ repository:
     end: "($)"
     patterns: [
       {
-        match: "(?:\\b(NOTE|XXX|HACK|FIXME|BUG|TODO)\\b)"
-        captures:
-          "1":
-            name: "keyword.comment.line.note.notation.python"
+        include: "#codetags"
       }
     ]
   "comments-string-single-three":
@@ -1691,10 +1688,7 @@ repository:
     end: "($|(?='''))"
     patterns: [
       {
-        match: "(?:\\b(NOTE|XXX|HACK|FIXME|BUG|TODO)\\b)"
-        captures:
-          "1":
-            name: "keyword.comment.line.note.notation.python"
+        include: "#codetags"
       }
     ]
   "comments-string-double-three":
@@ -1706,10 +1700,7 @@ repository:
     end: "($|(?=\"\"\"))"
     patterns: [
       {
-        match: "(?:\\b(NOTE|XXX|HACK|FIXME|BUG|TODO)\\b)"
-        captures:
-          "1":
-            name: "keyword.comment.line.note.notation.python"
+        include: "#codetags"
       }
     ]
   "single-one-regexp-expression":
diff --git a/grammars/MagicPython.tmLanguage b/grammars/MagicPython.tmLanguage
@@ -147,7 +147,7 @@
               </dict>
               <dict>
                 <key>include</key>
-                <string>#docstring-codetags</string>
+                <string>#codetags</string>
               </dict>
               <dict>
                 <key>include</key>
@@ -195,7 +195,7 @@
               </dict>
               <dict>
                 <key>include</key>
-                <string>#docstring-codetags</string>
+                <string>#codetags</string>
               </dict>
             </array>
           </dict>
@@ -231,7 +231,7 @@
             <array>
               <dict>
                 <key>include</key>
-                <string>#docstring-codetags</string>
+                <string>#codetags</string>
               </dict>
               <dict>
                 <key>include</key>
@@ -280,7 +280,7 @@
               </dict>
               <dict>
                 <key>include</key>
-                <string>#docstring-codetags</string>
+                <string>#codetags</string>
               </dict>
             </array>
           </dict>
@@ -322,7 +322,7 @@
           </dict>
         </dict>
       </dict>
-      <key>docstring-codetags</key>
+      <key>codetags</key>
       <dict>
         <key>match</key>
         <string>(?:\b(NOTE|XXX|HACK|FIXME|BUG|TODO)\b)</string>
@@ -331,7 +331,7 @@
           <key>1</key>
           <dict>
             <key>name</key>
-            <string>keyword.string.quoted.docstring.note.python</string>
+            <string>keyword.codetag.notation.python</string>
           </dict>
         </dict>
       </dict>
@@ -2669,16 +2669,8 @@ indirectly through syntactic constructs
         <key>patterns</key>
         <array>
           <dict>
-            <key>match</key>
-            <string>(?:\b(NOTE|XXX|HACK|FIXME|BUG|TODO)\b)</string>
-            <key>captures</key>
-            <dict>
-              <key>1</key>
-              <dict>
-                <key>name</key>
-                <string>keyword.comment.line.note.notation.python</string>
-              </dict>
-            </dict>
+            <key>include</key>
+            <string>#codetags</string>
           </dict>
         </array>
       </dict>
@@ -2701,16 +2693,8 @@ indirectly through syntactic constructs
         <key>patterns</key>
         <array>
           <dict>
-            <key>match</key>
-            <string>(?:\b(NOTE|XXX|HACK|FIXME|BUG|TODO)\b)</string>
-            <key>captures</key>
-            <dict>
-              <key>1</key>
-              <dict>
-                <key>name</key>
-                <string>keyword.comment.line.note.notation.python</string>
-              </dict>
-            </dict>
+            <key>include</key>
+            <string>#codetags</string>
           </dict>
         </array>
       </dict>
@@ -2733,16 +2717,8 @@ indirectly through syntactic constructs
         <key>patterns</key>
         <array>
           <dict>
-            <key>match</key>
-            <string>(?:\b(NOTE|XXX|HACK|FIXME|BUG|TODO)\b)</string>
-            <key>captures</key>
-            <dict>
-              <key>1</key>
-              <dict>
-                <key>name</key>
-                <string>keyword.comment.line.note.notation.python</string>
-              </dict>
-            </dict>
+            <key>include</key>
+            <string>#codetags</string>
           </dict>
         </array>
       </dict>
diff --git a/grammars/comment.inc.yaml b/grammars/comment.inc.yaml
@@ -7,7 +7,5 @@ repository:
       '1': {name: punctuation.definition.comment.python}
     end: ($${marker})
     patterns:
-      - match: (?:\b(NOTE|XXX|HACK|FIXME|BUG|TODO)\b)
-        captures:
-          '1': {name: keyword.comment.line.note.notation.python}
+      - include: '#codetags'
 ...
diff --git a/test/comments/comment1.py b/test/comments/comment1.py
@@ -7,25 +7,25 @@
 
 #             : comment.line.number-sign.python, punctuation.definition.comment.python, source.python
               : comment.line.number-sign.python, source.python
-XXX           : comment.line.number-sign.python, keyword.comment.line.note.notation.python, source.python
+XXX           : comment.line.number-sign.python, keyword.codetag.notation.python, source.python
  foo          : comment.line.number-sign.python, source.python
 #             : comment.line.number-sign.python, punctuation.definition.comment.python, source.python
               : comment.line.number-sign.python, source.python
-FIXME         : comment.line.number-sign.python, keyword.comment.line.note.notation.python, source.python
+FIXME         : comment.line.number-sign.python, keyword.codetag.notation.python, source.python
 : bug         : comment.line.number-sign.python, source.python
 #             : comment.line.number-sign.python, punctuation.definition.comment.python, source.python
  NB: XXXx xXXX but  : comment.line.number-sign.python, source.python
-XXX           : comment.line.number-sign.python, keyword.comment.line.note.notation.python, source.python
+XXX           : comment.line.number-sign.python, keyword.codetag.notation.python, source.python
 !             : comment.line.number-sign.python, source.python
 #             : comment.line.number-sign.python, punctuation.definition.comment.python, source.python
  ALSO         : comment.line.number-sign.python, source.python
-HACK          : comment.line.number-sign.python, keyword.comment.line.note.notation.python, source.python
+HACK          : comment.line.number-sign.python, keyword.codetag.notation.python, source.python
  and          : comment.line.number-sign.python, source.python
-NOTE          : comment.line.number-sign.python, keyword.comment.line.note.notation.python, source.python
+NOTE          : comment.line.number-sign.python, keyword.codetag.notation.python, source.python
  and          : comment.line.number-sign.python, source.python
-TODO          : comment.line.number-sign.python, keyword.comment.line.note.notation.python, source.python
+TODO          : comment.line.number-sign.python, keyword.codetag.notation.python, source.python
  highlight    : comment.line.number-sign.python, source.python
-XXX           : comment.line.number-sign.python, keyword.comment.line.note.notation.python, source.python
+XXX           : comment.line.number-sign.python, keyword.codetag.notation.python, source.python
  and          : comment.line.number-sign.python, source.python
-FIXME         : comment.line.number-sign.python, keyword.comment.line.note.notation.python, source.python
+FIXME         : comment.line.number-sign.python, keyword.codetag.notation.python, source.python
 .             : comment.line.number-sign.python, source.python
diff --git a/test/docstrings/codetag1.py b/test/docstrings/codetag1.py
@@ -7,7 +7,7 @@ def foo():
 
 '''           : punctuation.definition.string.begin.python, source.python, string.quoted.docstring.multi.python
  foo bar      : source.python, string.quoted.docstring.multi.python
-XXX           : keyword.string.quoted.docstring.note.python, source.python, string.quoted.docstring.multi.python
+XXX           : keyword.codetag.notation.python, source.python, string.quoted.docstring.multi.python
  baz          : source.python, string.quoted.docstring.multi.python
 '''           : punctuation.definition.string.end.python, source.python, string.quoted.docstring.multi.python
               : source.python
@@ -20,6 +20,6 @@ def           : meta.function.python, source.python, storage.type.function.pytho
               : source.python
 '''           : punctuation.definition.string.begin.python, source.python, string.quoted.docstring.multi.python
  foo          : source.python, string.quoted.docstring.multi.python
-FIXME         : keyword.string.quoted.docstring.note.python, source.python, string.quoted.docstring.multi.python
+FIXME         : keyword.codetag.notation.python, source.python, string.quoted.docstring.multi.python
  baz          : source.python, string.quoted.docstring.multi.python
 '''           : punctuation.definition.string.end.python, source.python, string.quoted.docstring.multi.python
diff --git a/test/docstrings/codetag2.py b/test/docstrings/codetag2.py
@@ -7,7 +7,7 @@ def foo():
 
 '             : punctuation.definition.string.begin.python, source.python, string.quoted.docstring.python
  foo bar      : source.python, string.quoted.docstring.python
-XXX           : keyword.string.quoted.docstring.note.python, source.python, string.quoted.docstring.python
+XXX           : keyword.codetag.notation.python, source.python, string.quoted.docstring.python
  baz          : source.python, string.quoted.docstring.python
 '             : punctuation.definition.string.end.python, source.python, string.quoted.docstring.python
               : source.python
@@ -20,6 +20,6 @@ def           : meta.function.python, source.python, storage.type.function.pytho
               : source.python
 '             : punctuation.definition.string.begin.python, source.python, string.quoted.docstring.python
  foo          : source.python, string.quoted.docstring.python
-FIXME         : keyword.string.quoted.docstring.note.python, source.python, string.quoted.docstring.python
+FIXME         : keyword.codetag.notation.python, source.python, string.quoted.docstring.python
  baz          : source.python, string.quoted.docstring.python
 '             : punctuation.definition.string.end.python, source.python, string.quoted.docstring.python

Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,7 @@ repository:`
`91`	`91`	`include: "#docstring-prompt"`
`92`	`92`	`}`
`93`	`93`	`{`
`94`		`- include: "#docstring-codetags"`
	`94`	`+ include: "#codetags"`
`95`	`95`	`}`
`96`	`96`	`{`
`97`	`97`	`include: "#docstring-guts-unicode"`
`@@ -118,7 +118,7 @@ repository:`
`118`	`118`	`include: "#docstring-prompt"`
`119`	`119`	`}`
`120`	`120`	`{`
`121`		`- include: "#docstring-codetags"`
	`121`	`+ include: "#codetags"`
`122`	`122`	`}`
`123`	`123`	`]`
`124`	`124`	`}`
`@@ -136,7 +136,7 @@ repository:`
`136`	`136`	`name: "invalid.illegal.newline.python"`
`137`	`137`	`patterns: [`
`138`	`138`	`{`
`139`		`- include: "#docstring-codetags"`
	`139`	`+ include: "#codetags"`
`140`	`140`	`}`
`141`	`141`	`{`
`142`	`142`	`include: "#docstring-guts-unicode"`
`@@ -162,7 +162,7 @@ repository:`
`162`	`162`	`include: "#string-consume-escape"`
`163`	`163`	`}`
`164`	`164`	`{`
`165`		`- include: "#docstring-codetags"`
	`165`	`+ include: "#codetags"`
`166`	`166`	`}`
`167`	`167`	`]`
`168`	`168`	`}`
`@@ -191,11 +191,11 @@ repository:`
`191`	`191`	`captures:`
`192`	`192`	`"1":`
`193`	`193`	`name: "keyword.control.flow.python"`
`194`		`- "docstring-codetags":`
	`194`	`+ codetags:`
`195`	`195`	`match: "(?:\\b(NOTE\|XXX\|HACK\|FIXME\|BUG\|TODO)\\b)"`
`196`	`196`	`captures:`
`197`	`197`	`"1":`
`198`		`- name: "keyword.string.quoted.docstring.note.python"`
	`198`	`+ name: "keyword.codetag.notation.python"`
`199`	`199`	`"statement-keyword":`
`200`	`200`	`patterns: [`
`201`	`201`	`{`
`@@ -1676,10 +1676,7 @@ repository:`
`1676`	`1676`	`end: "($)"`
`1677`	`1677`	`patterns: [`
`1678`	`1678`	`{`
`1679`		`- match: "(?:\\b(NOTE\|XXX\|HACK\|FIXME\|BUG\|TODO)\\b)"`
`1680`		`- captures:`
`1681`		`- "1":`
`1682`		`- name: "keyword.comment.line.note.notation.python"`
	`1679`	`+ include: "#codetags"`
`1683`	`1680`	`}`
`1684`	`1681`	`]`
`1685`	`1682`	`"comments-string-single-three":`
`@@ -1691,10 +1688,7 @@ repository:`
`1691`	`1688`	`end: "($\|(?='''))"`
`1692`	`1689`	`patterns: [`
`1693`	`1690`	`{`
`1694`		`- match: "(?:\\b(NOTE\|XXX\|HACK\|FIXME\|BUG\|TODO)\\b)"`
`1695`		`- captures:`
`1696`		`- "1":`
`1697`		`- name: "keyword.comment.line.note.notation.python"`
	`1691`	`+ include: "#codetags"`
`1698`	`1692`	`}`
`1699`	`1693`	`]`
`1700`	`1694`	`"comments-string-double-three":`
`@@ -1706,10 +1700,7 @@ repository:`
`1706`	`1700`	`end: "($\|(?=\"\"\"))"`
`1707`	`1701`	`patterns: [`
`1708`	`1702`	`{`
`1709`		`- match: "(?:\\b(NOTE\|XXX\|HACK\|FIXME\|BUG\|TODO)\\b)"`
`1710`		`- captures:`
`1711`		`- "1":`
`1712`		`- name: "keyword.comment.line.note.notation.python"`
	`1703`	`+ include: "#codetags"`
`1713`	`1704`	`}`
`1714`	`1705`	`]`
`1715`	`1706`	`"single-one-regexp-expression":`