@carlwr/docopt-tmlanguage 0.1.1

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2026 Carl Wernhoff
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,32 @@
+# docopt.tmLanguage
+
+A TextMate grammar for _docopt-style command synopsis notation_ — which may look like e.g.:
+
+```
+cat [OPTION]... [FILE]...
+
+cd [ -qsLP ] {+|-}n
+
+prog -a [-bc -e param] --arg0 val0 --arg1=val1
+
+prog <thing> [[+-]feature ...]
+```
+
+The closest to an authoritative "docopt spec" would be [POSIX _12.1 Utility Argument Syntax_][posix-12.1] or [docopt.org]. The grammar generally supports the syntax each of these specify, but also accommodates other forms commonly seen in the wild, e.g. `prog {+|-}`.
+
+## AI/human authorship
+
+This `README.md` file [is written by](./AGENTS.md) me, Carl, a human developer. The grammar itself is written by LLMs. 
+
+## Similar/related grammars
+
+- https://github.com/Vallentin/vscode-bnf (`bnf.tmLanguage`)
+- https://github.com/victor-gp/cmd-help-sublime-syntax (`text.cmd-help`)
+
+## References
+
+- [POSIX _12.1 Utility Argument Syntax_][posix-12.1]
+- [docopt.org]
+
+[posix-12.1]: https://pubs.opengroup.org/onlinepubs/9799919799/
+[docopt.org]: http://docopt.org/

package/docopt.tmLanguage.json

@@ -0,0 +1,160 @@
+{
+  "$schema": "https://raw.githubusercontent.com/martinring/tmlanguage/master/tmlanguage.json",
+  "name": "docopt",
+  "scopeName": "source.docopt",
+  "patterns": [
+    {
+      "include": "#tokens"
+    }
+  ],
+  "repository": {
+    "tokens": {
+      "patterns": [
+        { "include": "#comment" },
+        { "include": "#usage-header" },
+        { "include": "#program" },
+        { "include": "#string" },
+        { "include": "#repetition" },
+        { "include": "#argument" },
+        { "include": "#alternation" },
+        { "include": "#bracket-open" },
+        { "include": "#bracket-close" },
+        { "include": "#brace-open" },
+        { "include": "#brace-close" },
+        { "include": "#paren-open" },
+        { "include": "#paren-close" },
+        { "include": "#assignment" },
+        { "include": "#separator-comma" },
+        { "include": "#separator-colon" },
+        { "include": "#option-long" },
+        { "include": "#option-short" },
+        { "include": "#option-bare" },
+        { "include": "#sign" },
+        { "include": "#identifier" }
+      ]
+    },
+    "comment": {
+      "match": "^#.*$",
+      "name": "comment.line.number-sign.docopt"
+    },
+    "usage-header": {
+      "match": "^[ \\t]*(?:[Uu][Ss][Aa][Gg][Ee]:|SYNOPSIS)[ \\t]*$",
+      "name": "comment.line.usage.docopt"
+    },
+    "program": {
+      "match": "^[ \\t]*([_a-zA-Z][_a-zA-Z0-9]*)",
+      "captures": {
+        "1": { "name": "entity.name.function.docopt" }
+      }
+    },
+    "identifier": {
+      "match": "\\b[_a-zA-Z][_a-zA-Z0-9]*(?:[./][_a-zA-Z0-9]+)*",
+      "name": "variable.parameter.docopt"
+    },
+    "argument": {
+      "begin": "<",
+      "end": ">",
+      "name": "variable.parameter.docopt",
+      "beginCaptures": {
+        "0": { "name": "punctuation.definition.variable.begin.docopt" }
+      },
+      "endCaptures": {
+        "0": { "name": "punctuation.definition.variable.end.docopt" }
+      }
+    },
+    "string": {
+      "patterns": [
+        {
+          "name": "string.quoted.single.docopt",
+          "begin": "'",
+          "end": "'",
+          "patterns": [
+            {
+              "name": "constant.character.escape.docopt",
+              "match": "\\\\."
+            }
+          ]
+        },
+        {
+          "name": "string.quoted.double.docopt",
+          "begin": "\"",
+          "end": "\"",
+          "patterns": [
+            {
+              "name": "constant.character.escape.docopt",
+              "match": "\\\\."
+            }
+          ]
+        }
+      ]
+    },
+    "repetition": {
+      "match": "\\.\\.\\.",
+      "name": "keyword.operator.ellipsis.docopt"
+    },
+    "alternation": {
+      "match": "\\|",
+      "name": "keyword.operator.alternation.docopt"
+    },
+    "bracket-open": {
+      "match": "\\[",
+      "name": "punctuation.section.brackets.begin.docopt"
+    },
+    "bracket-close": {
+      "match": "\\]",
+      "name": "punctuation.section.brackets.end.docopt"
+    },
+    "brace-open": {
+      "match": "\\{",
+      "name": "punctuation.section.braces.begin.docopt"
+    },
+    "brace-close": {
+      "match": "\\}",
+      "name": "punctuation.section.braces.end.docopt"
+    },
+    "paren-open": {
+      "match": "\\(",
+      "name": "punctuation.section.parens.begin.docopt"
+    },
+    "paren-close": {
+      "match": "\\)",
+      "name": "punctuation.section.parens.end.docopt"
+    },
+    "assignment": {
+      "match": "=",
+      "name": "keyword.operator.assignment.docopt"
+    },
+    "separator-comma": {
+      "match": ",",
+      "name": "punctuation.separator.comma.docopt"
+    },
+    "separator-colon": {
+      "match": ":",
+      "name": "punctuation.separator.colon.docopt"
+    },
+    "option-long": {
+      "match": "(--)([_a-zA-Z][-_a-zA-Z0-9]*)(?:(=)([_a-zA-Z0-9][_a-zA-Z0-9]*(?:[./][_a-zA-Z0-9]+)*))?",
+      "captures": {
+        "1": { "name": "punctuation.definition.option.long.docopt" },
+        "2": { "name": "entity.name.tag.docopt" },
+        "3": { "name": "keyword.operator.assignment.docopt" },
+        "4": { "name": "variable.parameter.docopt" }
+      }
+    },
+    "option-short": {
+      "match": "([-+])([_a-zA-Z][_a-zA-Z0-9]*)",
+      "captures": {
+        "1": { "name": "punctuation.definition.option.short.docopt" },
+        "2": { "name": "entity.name.tag.docopt" }
+      }
+    },
+    "option-bare": {
+      "match": "--",
+      "name": "keyword.operator.docopt"
+    },
+    "sign": {
+      "match": "[-+]",
+      "name": "punctuation.definition.option.short.docopt"
+    }
+  }
+}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@carlwr/docopt-tmlanguage",
+  "version": "0.1.1",
+  "description": "TextMate grammar for docopt-style command synopsis notation",
+  "license": "MIT",
+  "author": "Carl Wernhoff",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/carlwr/docopt-tmlanguage.git"
+  },
+  "homepage": "https://github.com/carlwr/docopt-tmlanguage#readme",
+  "bugs": {
+    "url": "https://github.com/carlwr/docopt-tmlanguage/issues"
+  },
+  "type": "module",
+  "files": [
+    "docopt.tmLanguage.json",
+    "LICENSE"
+  ],
+  "exports": {
+    ".": "./docopt.tmLanguage.json",
+    "./grammar.json": "./docopt.tmLanguage.json",
+    "./package.json": "./package.json"
+  },
+  "keywords": [
+    "textmate",
+    "tmlanguage",
+    "grammar",
+    "syntax-highlighting",
+    "docopt",
+    "shiki"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@carlwr/textmate-validate": "^1.0.1",
+    "vscode-tmgrammar-test": "^0.1.3"
+  },
+  "scripts": {
+    "check": "textmate-validate -v ./docopt.tmLanguage.json",
+    "test": "vscode-tmgrammar-test -g ./docopt.tmLanguage.json 'tests/**/*.docopt'",
+    "qa": "npm run check && npm run test",
+    "version:patch": "npm version patch",
+    "version:minor": "npm version minor",
+    "version:major": "npm version major",
+    "preversion": "npm run qa",
+    "postversion": "git push --follow-tags",
+    "prepublishOnly": "npm run qa"
+  }
+}