github-linguist 5.0.6 → 5.0.7

data/grammars/source.jsdoc.json

@@ -0,0 +1,485 @@
+{
+  "scopeName": "source.jsdoc",
+  "name": "JSDoc",
+  "patterns": [
+    {
+      "captures": {
+        "1": {
+          "name": "storage.type.class.jsdoc"
+        },
+        "2": {
+          "name": "punctuation.definition.block.tag.jsdoc"
+        },
+        "3": {
+          "name": "constant.language.access-type.jsdoc"
+        }
+      },
+      "match": "(?x)\n((@)access)\n\\s+\n(private|protected|public)\n\\b"
+    },
+    {
+      "match": "(?x)\n((@)author)\n\\s+\n(\n  [^@\\s<>*/]\n  (?:[^@<>*/]|\\*[^/])*\n)\n(?:\n  \\s*\n  (<)\n  ([^>\\s]+)\n  (>)\n)?",
+      "captures": {
+        "1": {
+          "name": "storage.type.class.jsdoc"
+        },
+        "2": {
+          "name": "punctuation.definition.block.tag.jsdoc"
+        },
+        "3": {
+          "name": "entity.name.type.instance.jsdoc"
+        },
+        "4": {
+          "name": "punctuation.definition.bracket.angle.begin.jsdoc"
+        },
+        "5": {
+          "name": "constant.other.email.link.underline.jsdoc"
+        },
+        "6": {
+          "name": "punctuation.definition.bracket.angle.end.jsdoc"
+        }
+      }
+    },
+    {
+      "match": "(?x)\n((@)borrows) \\s+\n((?:[^@\\s*/]|\\*[^/])+)    # <that namepath>\n\\s+ (as) \\s+              # as\n((?:[^@\\s*/]|\\*[^/])+)    # <this namepath>",
+      "captures": {
+        "1": {
+          "name": "storage.type.class.jsdoc"
+        },
+        "2": {
+          "name": "punctuation.definition.block.tag.jsdoc"
+        },
+        "3": {
+          "name": "entity.name.type.instance.jsdoc"
+        },
+        "4": {
+          "name": "keyword.operator.control.jsdoc"
+        },
+        "5": {
+          "name": "entity.name.type.instance.jsdoc"
+        }
+      }
+    },
+    {
+      "name": "meta.example.jsdoc",
+      "begin": "((@)example)\\s+",
+      "end": "(?=@|\\*/)",
+      "beginCaptures": {
+        "1": {
+          "name": "storage.type.class.jsdoc"
+        },
+        "2": {
+          "name": "punctuation.definition.block.tag.jsdoc"
+        }
+      },
+      "patterns": [
+        {
+          "match": "^\\s\\*\\s+"
+        },
+        {
+          "begin": "\\G(<)caption(>)",
+          "beginCaptures": {
+            "0": {
+              "name": "entity.name.tag.inline.jsdoc"
+            },
+            "1": {
+              "name": "punctuation.definition.bracket.angle.begin.jsdoc"
+            },
+            "2": {
+              "name": "punctuation.definition.bracket.angle.end.jsdoc"
+            }
+          },
+          "contentName": "constant.other.description.jsdoc",
+          "end": "(</)caption(>)|(?=\\*/)",
+          "endCaptures": {
+            "0": {
+              "name": "entity.name.tag.inline.jsdoc"
+            },
+            "1": {
+              "name": "punctuation.definition.bracket.angle.begin.jsdoc"
+            },
+            "2": {
+              "name": "punctuation.definition.bracket.angle.end.jsdoc"
+            }
+          }
+        },
+        {
+          "match": "[^\\s@*](?:[^*]|\\*[^/])*",
+          "captures": {
+            "0": {
+              "name": "source.embedded.js",
+              "patterns": [
+                {
+                  "include": "source.js"
+                }
+              ]
+            }
+          }
+        }
+      ]
+    },
+    {
+      "captures": {
+        "1": {
+          "name": "storage.type.class.jsdoc"
+        },
+        "2": {
+          "name": "punctuation.definition.block.tag.jsdoc"
+        },
+        "3": {
+          "name": "constant.language.symbol-type.jsdoc"
+        }
+      },
+      "match": "(?x)\n((@)kind)\n\\s+\n(class|constant|event|external|file|function|member|mixin|module|namespace|typedef)\n\\b"
+    },
+    {
+      "captures": {
+        "1": {
+          "name": "storage.type.class.jsdoc"
+        },
+        "2": {
+          "name": "punctuation.definition.block.tag.jsdoc"
+        },
+        "3": {
+          "name": "variable.other.link.underline.jsdoc"
+        },
+        "4": {
+          "name": "entity.name.type.instance.jsdoc"
+        }
+      },
+      "match": "(?x)\n((@)see)\n\\s+\n(?:\n  # URL\n  (\n    (?=https?://)\n    (?:[^\\s*]|\\*[^/])+\n  )\n  |\n  # JSDoc namepath\n  (\n    (?!https?://)\n    (?:[^@\\s*/]|\\*[^/])+\n  )\n)"
+    },
+    {
+      "captures": {
+        "1": {
+          "name": "storage.type.class.jsdoc"
+        },
+        "2": {
+          "name": "punctuation.definition.block.tag.jsdoc"
+        },
+        "3": {
+          "name": "variable.other.jsdoc",
+          "patterns": [
+            {
+              "match": ",",
+              "name": "punctuation.delimiter.object.comma.jsdoc"
+            }
+          ]
+        }
+      },
+      "match": "(?x)\n((@)template)\n\\s+\n# One or more valid identifiers\n(\n  [A-Za-z_$]        # First character: non-numeric word character\n  [\\w$.\\[\\]]*    # Rest of identifier\n  (?:               # Possible list of additional identifiers\n    \\s* , \\s*\n    [A-Za-z_$]\n    [\\w$.\\[\\]]*\n  )*\n)"
+    },
+    {
+      "captures": {
+        "1": {
+          "name": "storage.type.class.jsdoc"
+        },
+        "2": {
+          "name": "punctuation.definition.block.tag.jsdoc"
+        },
+        "3": {
+          "name": "variable.other.jsdoc"
+        }
+      },
+      "match": "(?x)\n(\n  (@)\n  (?:arg|argument|const|constant|member|namespace|param|var)\n)\n\\s+\n(\n  [A-Za-z_$]\n  [\\w$.\\[\\]]*\n)"
+    },
+    {
+      "begin": "((@)typedef)\\s+(?={)",
+      "beginCaptures": {
+        "1": {
+          "name": "storage.type.class.jsdoc"
+        },
+        "2": {
+          "name": "punctuation.definition.block.tag.jsdoc"
+        }
+      },
+      "end": "(?=\\s|\\*/|[^{}\\[\\]A-Za-z_$])",
+      "patterns": [
+        {
+          "include": "#type"
+        },
+        {
+          "name": "entity.name.type.instance.jsdoc",
+          "match": "(?:[^@\\s*/]|\\*[^/])+"
+        }
+      ]
+    },
+    {
+      "begin": "((@)(?:arg|argument|const|constant|member|namespace|param|prop|property|var))\\s+(?={)",
+      "beginCaptures": {
+        "1": {
+          "name": "storage.type.class.jsdoc"
+        },
+        "2": {
+          "name": "punctuation.definition.block.tag.jsdoc"
+        }
+      },
+      "end": "(?=\\s|\\*/|[^{}\\[\\]A-Za-z_$])",
+      "patterns": [
+        {
+          "include": "#type"
+        },
+        {
+          "match": "([A-Za-z_$][\\w$.\\[\\]]*)",
+          "name": "variable.other.jsdoc"
+        },
+        {
+          "name": "variable.other.jsdoc",
+          "begin": "\\[",
+          "end": "\\]|(?=\\*/)",
+          "patterns": [
+            {
+              "match": "(=)((?:[^\\]*]|\\*[^/])*)",
+              "captures": {
+                "1": {
+                  "name": "keyword.operator.assignment.jsdoc"
+                },
+                "2": {
+                  "name": "source.embedded.js",
+                  "patterns": [
+                    {
+                      "include": "#inline-tags"
+                    },
+                    {
+                      "include": "source.js"
+                    }
+                  ]
+                }
+              }
+            },
+            {
+              "include": "#brackets"
+            },
+            {
+              "include": "#quotes"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "begin": "((@)(?:define|enum|exception|implements|modifies|namespace|private|protected|returns?|suppress|throws|type))\\s+(?={)",
+      "beginCaptures": {
+        "1": {
+          "name": "storage.type.class.jsdoc"
+        },
+        "2": {
+          "name": "punctuation.definition.block.tag.jsdoc"
+        }
+      },
+      "end": "(?=\\s|\\*/|[^{}\\[\\]A-Za-z_$])",
+      "patterns": [
+        {
+          "include": "#type"
+        }
+      ]
+    },
+    {
+      "captures": {
+        "1": {
+          "name": "storage.type.class.jsdoc"
+        },
+        "2": {
+          "name": "punctuation.definition.block.tag.jsdoc"
+        },
+        "3": {
+          "name": "entity.name.type.instance.jsdoc"
+        }
+      },
+      "match": "(?x)\n(\n  (@)\n  (?:alias|augments|callback|constructs|emits|event|fires|exports?\n  |extends|external|function|func|host|lends|listens|interface|memberof!?\n  |method|module|mixes|mixin|name|requires|see|this|typedef|uses)\n)\n\\s+\n(\n  (?:\n    [^{}@\\s*] | \\*[^/]\n  )+\n)"
+    },
+    {
+      "begin": "((@)(?:default(?:value)?|license|version))\\s+((['\"]))",
+      "beginCaptures": {
+        "1": {
+          "name": "storage.type.class.jsdoc"
+        },
+        "2": {
+          "name": "punctuation.definition.block.tag.jsdoc"
+        },
+        "3": {
+          "name": "variable.other.jsdoc"
+        },
+        "4": {
+          "name": "punctuation.definition.string.begin.jsdoc"
+        }
+      },
+      "contentName": "variable.other.jsdoc",
+      "end": "(\\3)|(?=$|\\*/)",
+      "endCaptures": {
+        "0": {
+          "name": "variable.other.jsdoc"
+        },
+        "1": {
+          "name": "punctuation.definition.string.end.jsdoc"
+        }
+      }
+    },
+    {
+      "captures": {
+        "1": {
+          "name": "storage.type.class.jsdoc"
+        },
+        "2": {
+          "name": "punctuation.definition.block.tag.jsdoc"
+        },
+        "3": {
+          "name": "variable.other.jsdoc"
+        }
+      },
+      "match": "((@)(?:default(?:value)?|license|tutorial|variation|version))\\s+([^\\s*]+)"
+    },
+    {
+      "captures": {
+        "1": {
+          "name": "punctuation.definition.block.tag.jsdoc"
+        }
+      },
+      "match": "(?x) (@)\n(?:abstract|access|alias|arg|argument|async|attribute|augments|author|beta|borrows|bubbles\n|callback|chainable|class|classdesc|code|config|const|constant|constructor|constructs|copyright\n|default|defaultvalue|define|deprecated|desc|description|dict|emits|enum|event|example|exception\n|exports?|extends|extension(?:_?for)?|external|externs|file|fileoverview|final|fires|for|func\n|function|global|host|ignore|implements|implicitCast|inherit[Dd]oc|inner|instance|interface|kind\n|lends|license|listens|main|member|memberof!?|method|mixes|mixins?|modifies|module|name|namespace\n|noalias|nocollapse|nocompile|nosideeffects|override|overview|package|param|preserve|private|prop\n|property|protected|public|read[Oo]nly|record|require[ds]|returns?|see|since|static|struct|submodule\n|summary|suppress|template|this|throws|todo|tutorial|type|typedef|unrestricted|uses|var|variation\n|version|virtual|writeOnce)\n\\b",
+      "name": "storage.type.class.jsdoc"
+    },
+    {
+      "include": "#inline-tags"
+    }
+  ],
+  "repository": {
+    "brackets": {
+      "patterns": [
+        {
+          "begin": "{",
+          "end": "}|(?=\\*/)",
+          "patterns": [
+            {
+              "include": "#brackets"
+            }
+          ]
+        },
+        {
+          "begin": "\\[",
+          "end": "\\]|(?=\\*/)",
+          "patterns": [
+            {
+              "include": "#brackets"
+            }
+          ]
+        }
+      ]
+    },
+    "inline-tags": {
+      "patterns": [
+        {
+          "captures": {
+            "1": {
+              "name": "punctuation.definition.bracket.square.begin.jsdoc"
+            },
+            "2": {
+              "name": "punctuation.definition.bracket.square.end.jsdoc"
+            }
+          },
+          "match": "(\\[)[^\\]]+(\\])(?={@(?:link|linkcode|linkplain|tutorial))",
+          "name": "constant.other.description.jsdoc"
+        },
+        {
+          "begin": "({)((@)(?:link(?:code|plain)?|tutorial))\\s*",
+          "beginCaptures": {
+            "1": {
+              "name": "punctuation.definition.bracket.curly.begin.jsdoc"
+            },
+            "2": {
+              "name": "storage.type.class.jsdoc"
+            },
+            "3": {
+              "name": "punctuation.definition.inline.tag.jsdoc"
+            }
+          },
+          "end": "}|(?=\\*/)",
+          "endCaptures": {
+            "0": {
+              "name": "punctuation.definition.bracket.curly.end.jsdoc"
+            }
+          },
+          "name": "entity.name.type.instance.jsdoc",
+          "patterns": [
+            {
+              "captures": {
+                "1": {
+                  "name": "variable.other.link.underline.jsdoc"
+                },
+                "2": {
+                  "name": "punctuation.separator.pipe.jsdoc"
+                }
+              },
+              "match": "\\G((?=https?://)(?:[^|}\\s*]|\\*[/])+)(\\|)?"
+            },
+            {
+              "captures": {
+                "1": {
+                  "name": "variable.other.description.jsdoc"
+                },
+                "2": {
+                  "name": "punctuation.separator.pipe.jsdoc"
+                }
+              },
+              "match": "\\G((?:[^{}@\\s|*]|\\*[^/])+)(\\|)?"
+            }
+          ]
+        }
+      ]
+    },
+    "quotes": {
+      "patterns": [
+        {
+          "begin": "'",
+          "end": "'|(?=\\*/)",
+          "patterns": [
+            {
+              "include": "#quotes"
+            }
+          ]
+        },
+        {
+          "begin": "\"",
+          "end": "\"|(?=\\*/)",
+          "patterns": [
+            {
+              "include": "#quotes"
+            }
+          ]
+        }
+      ]
+    },
+    "type": {
+      "patterns": [
+        {
+          "match": "\\G{(?:[^}*]|\\*[^/}])+$",
+          "name": "invalid.illegal.type.jsdoc"
+        },
+        {
+          "begin": "\\G({)",
+          "beginCaptures": {
+            "0": {
+              "name": "entity.name.type.instance.jsdoc"
+            },
+            "1": {
+              "name": "punctuation.definition.bracket.curly.begin.jsdoc"
+            }
+          },
+          "contentName": "entity.name.type.instance.jsdoc",
+          "end": "((}))\\s*|(?=\\*/)",
+          "endCaptures": {
+            "1": {
+              "name": "entity.name.type.instance.jsdoc"
+            },
+            "2": {
+              "name": "punctuation.definition.bracket.curly.end.jsdoc"
+            }
+          },
+          "patterns": [
+            {
+              "include": "#brackets"
+            }
+          ]
+        }
+      ]
+    }
+  }
+}