@robot-inventor/shell-session-syntax 1.0.0

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,65 @@
+# shell-session-syntax
+
+Grammar files for better syntax highlight of Shell Session. This repository provides a TextMate grammar file in JSON format for ``shellsession`` syntax highlighting.
+
+I have merged the ``shellsession`` syntax used by GitHub and the powerful ``shellscript`` syntax used by VS Code.
+
+> [!NOTE]
+> You may also be interested in [regex-syntax](https://github.com/Robot-Inventor/regex-syntax) for syntax highlight of regular expressions.
+
+## Why?
+
+This project was created to more properly syntax highlight ``shellsession`` in [Shiki.js](https://shiki.style/).
+
+The grammar file used by Shiki does not highlight the first command in Shell Session, but it is difficult to change the existing behavior for [several reasons](https://github.com/shikijs/textmate-grammars-themes/issues/43).
+
+If you load shell-session-syntax as a custom language grammar in Shiki, you will get better syntax highlighting of ``shellsession``.
+
+|              Shiki's default syntax               |                  shell-session-syntax                  |
+| :-----------------------------------------------: | :----------------------------------------------------: |
+| ![Shiki's default syntax](docs/shiki-default.png) | ![shell-session-syntax](docs/shell-session-syntax.png) |
+
+This project automatically generates the grammar file. It uses [better-shell-syntax](https://github.com/jeff-hykin/better-shell-syntax/blob/master/autogenerated/shell.tmLanguage.json) for Shell grammar and [Linguist](https://github.com/github-linguist/linguist/) for Shell Session grammar. When merging these grammars, some patches are automatically applied.
+
+## Usage
+
+To use shell-session-syntax in Shiki, please download ``./syntaxes/shell-session.tmLanguage.json`` and load it as a custom language grammar. It automatically overwrites the default ``shellsession`` grammar.
+
+```javascript
+import { getHighlighter } from "shiki";
+import shellSession from "./shell-session.tmLanguage.json" assert { type: "json" };
+
+const code = `
+user@foo$ echo "Hello, World!" > hello.txt
+Hello, World!
+user@foo$ ls -l | grep ".txt"
+hello.txt
+`.trim();
+
+const highlighter = await getHighlighter({
+    langs: [shellSession],
+    themes: ["vitesse-dark"]
+});
+
+const html = highlighter.codeToHtml(code, {
+    lang: "shellsession",
+    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
+
+shell-session-syntax is generated by automatically applying patches to the following grammar files and merging them.
+
+- [better-shell-syntax](https://github.com/jeff-hykin/better-shell-syntax) ([MIT License](https://github.com/jeff-hykin/better-shell-syntax/blob/master/LICENSE))
+- [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/shell-session.tmLanguage.json" assert { type: "json" };
+export default grammar;

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@robot-inventor/shell-session-syntax",
+  "version": "1.0.0",
+  "description": "Grammar files for better syntax highlight of Shell Session.",
+  "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/shell-session-syntax.git"
+  },
+  "author": "Robot-Inventor",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/Robot-Inventor/shell-session-syntax/issues"
+  },
+  "homepage": "https://github.com/Robot-Inventor/shell-session-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"
+  }
+}