@robot-inventor/regex-syntax 1.0.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 ろぼいん
+
+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,49 @@
+# regex-syntax
+
+Grammar files for syntax highlight of regex. The grammar files are automatically generated from [Linguist](https://github.com/github-linguist/linguist/)'s regex grammars.
+
+> [!NOTE]
+> You may also be interested in [shell-session-syntax](https://github.com/Robot-Inventor/shell-session-syntax/) for syntax highlight of shell sessions.
+
+|Before|After|
+|:---:|:---:|
+|![before](docs/without-regex-syntax.png)|![after](docs/regex-syntax.png)|
+
+## Usage
+
+To use regex-syntax in [Shiki.js](https://shiki.style/), please download ``./syntaxes/regex.tmLanguage.json`` and load it as a custom language grammar. Language name is ``regex`` and ``regexp``.
+
+```javascript
+import { getHighlighter } from "shiki";
+import regex from "./regex.tmLanguage.json" assert { type: "json" };
+
+const code = `
+^[a-zA-Z0-9.!#$%&'*+/=?^_\`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$
+`.trim();
+
+const highlighter = await getHighlighter({
+    langs: [regex],
+    themes: ["vitesse-dark"]
+});
+
+const html = highlighter.codeToHtml(code, {
+    lang: "regex",
+    theme: "vitesse-dark"
+});
+
+console.log(html);
+```
+
+## Update Grammar
+
+To update the grammar file, run the following command. It automatically downloads the latest upstream grammar files and applies patches.
+
+```bash
+npm run build
+```
+
+## Grammar Sources
+
+regex-syntax is generated by automatically applying patches to the following grammar file.
+
+- [Linguist](https://github.com/github-linguist/linguist/) ([MIT License](https://github.com/github-linguist/linguist/blob/master/LICENSE))

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+import type { LanguageRegistration } from "shiki";
+declare const _default: LanguageRegistration;
+export default _default;

package/dist/index.js

@@ -0,0 +1,2 @@
+import grammar from "../syntaxes/regex.tmLanguage.json" assert { type: "json" };
+export default grammar;

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@robot-inventor/regex-syntax",
+  "version": "1.0.3",
+  "description": "Grammar files for syntax highlight of regex.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "files": [
+    "dist",
+    "syntaxes"
+  ],
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "ts-node ./scripts/generate.ts && tsc"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Robot-Inventor/regex-syntax.git"
+  },
+  "author": "Robot-Inventor",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/Robot-Inventor/regex-syntax/issues"
+  },
+  "homepage": "https://github.com/Robot-Inventor/regex-syntax#readme",
+  "devDependencies": {
+    "rss-parser": "^3.13.0",
+    "tar": "^7.0.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.4.2"
+  },
+  "dependencies": {
+    "shiki": "^1.3.0"
+  }
+}

package/syntaxes/regex.tmLanguage.json

@@ -0,0 +1,167 @@
+{
+    "information_for_contributors": [
+        "This file is autogenerated. Do not edit it manually. Instead, edit the `generate.ts` script and run it.",
+        "Sources for this file are:",
+        "https://github.com/github-linguist/linguist/"
+    ],
+    "lastUpdated": "2024-04-29T00:57:43.416Z",
+    "regexGrammarVersion": "v7.29.0",
+    "name": "regex",
+    "aliases": [
+        "regexp"
+    ],
+    "scopeName": "text.regex",
+    "patterns": [
+        {
+            "include": "#regexp"
+        }
+    ],
+    "repository": {
+        "regex-character-class": {
+            "patterns": [
+                {
+                    "name": "constant.character.character-class.regexp",
+                    "match": "\\\\[wWsSdDtrnvf]|\\."
+                },
+                {
+                    "name": "constant.character.numeric.regexp",
+                    "match": "\\\\([0-7]{3}|x[0-9A-Fa-f]{2}|u[0-9A-Fa-f]{4})"
+                },
+                {
+                    "name": "constant.character.control.regexp",
+                    "match": "\\\\c[A-Z]"
+                },
+                {
+                    "name": "constant.character.escape.backslash.regexp",
+                    "match": "\\\\."
+                }
+            ]
+        },
+        "regexp": {
+            "patterns": [
+                {
+                    "name": "keyword.control.anchor.regexp",
+                    "match": "\\\\[bB]|\\^|\\$"
+                },
+                {
+                    "name": "keyword.other.back-reference.regexp",
+                    "match": "\\\\[1-9]\\d*|\\\\k<[a-zA-Z_$][\\w$]*>"
+                },
+                {
+                    "name": "keyword.operator.quantifier.regexp",
+                    "match": "[?+*]|\\{(\\d+,\\d+|\\d+,|,\\d+|\\d+)\\}\\??"
+                },
+                {
+                    "name": "keyword.operator.or.regexp",
+                    "match": "\\|"
+                },
+                {
+                    "name": "meta.group.assertion.regexp",
+                    "begin": "(\\()(?:(\\?=)|(\\?!)|(\\?<=)|(\\?<!))",
+                    "end": "(\\))",
+                    "patterns": [
+                        {
+                            "include": "#regexp"
+                        }
+                    ],
+                    "beginCaptures": {
+                        "1": {
+                            "name": "punctuation.definition.group.regexp"
+                        },
+                        "2": {
+                            "name": "meta.assertion.look-ahead.regexp"
+                        },
+                        "3": {
+                            "name": "meta.assertion.negative-look-ahead.regexp"
+                        },
+                        "4": {
+                            "name": "meta.assertion.look-behind.regexp"
+                        },
+                        "5": {
+                            "name": "meta.assertion.negative-look-behind.regexp"
+                        }
+                    },
+                    "endCaptures": {
+                        "1": {
+                            "name": "punctuation.definition.group.regexp"
+                        }
+                    }
+                },
+                {
+                    "name": "meta.group.regexp",
+                    "begin": "\\(((\\?:)|(\\?<[a-zA-Z_$][\\w$]*>))?",
+                    "end": "\\)",
+                    "patterns": [
+                        {
+                            "include": "#regexp"
+                        }
+                    ],
+                    "beginCaptures": {
+                        "0": {
+                            "name": "punctuation.definition.group.regexp"
+                        }
+                    },
+                    "endCaptures": {
+                        "0": {
+                            "name": "punctuation.definition.group.regexp"
+                        }
+                    }
+                },
+                {
+                    "name": "constant.other.character-class.set.regexp",
+                    "begin": "(\\[)(\\^)?",
+                    "end": "(\\])",
+                    "patterns": [
+                        {
+                            "name": "constant.other.character-class.range.regexp",
+                            "match": "(?:.|(\\\\(?:[0-7]{3}|x[0-9A-Fa-f]{2}|u[0-9A-Fa-f]{4}))|(\\\\c[A-Z])|(\\\\.))\\-(?:[^\\]\\\\]|(\\\\(?:[0-7]{3}|x[0-9A-Fa-f]{2}|u[0-9A-Fa-f]{4}))|(\\\\c[A-Z])|(\\\\.))",
+                            "captures": {
+                                "1": {
+                                    "name": "constant.character.numeric.regexp"
+                                },
+                                "2": {
+                                    "name": "constant.character.control.regexp"
+                                },
+                                "3": {
+                                    "name": "constant.character.escape.backslash.regexp"
+                                },
+                                "4": {
+                                    "name": "constant.character.numeric.regexp"
+                                },
+                                "5": {
+                                    "name": "constant.character.control.regexp"
+                                },
+                                "6": {
+                                    "name": "constant.character.escape.backslash.regexp"
+                                }
+                            }
+                        },
+                        {
+                            "include": "#regex-character-class"
+                        }
+                    ],
+                    "beginCaptures": {
+                        "1": {
+                            "name": "punctuation.definition.character-class.regexp"
+                        },
+                        "2": {
+                            "name": "keyword.operator.negation.regexp"
+                        }
+                    },
+                    "endCaptures": {
+                        "1": {
+                            "name": "punctuation.definition.character-class.regexp"
+                        }
+                    }
+                },
+                {
+                    "include": "#regex-character-class"
+                },
+                {
+                    "match": ".",
+                    "name": "string.regexp"
+                }
+            ]
+        }
+    }
+}