@robot-inventor/shell-session-syntax

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 for syntax highlight of regular expressions.

Why?

This project was created to more properly syntax highlight shellsession in Shiki.js.

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.

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

This project automatically generates the grammar file. It uses better-shell-syntax for Shell grammar and 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 or install the package and load it as a custom language grammar. It automatically overwrites the default shellsession grammar.

npm install @robot-inventor/shell-session-syntax

import { getHighlighter } from "shiki";
// Directly import the downloaded file.
import shellSession from "./shell-session.tmLanguage.json";
// Or import the package.
import shellSession from "@robot-inventor/shell-session-syntax";

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.

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 (MIT License)
• Linguist (MIT License)