HN 日本語サマリー

← 一覧へ戻る
Web開発

MicroLighterの紹介

Introducing MicroLighter (daverupert.com)

37 pointsby tobr7 コメント

要約

MicroLighterは、CSS Custom Highlights APIを利用した軽量なクライアントサイドのシンタックスハイライターです。依存関係がなく、約2KBのサイズで、DOM操作を避け、CSSのみでコードのトークンをハイライトします。Textmateの言語定義を利用し、オンデマンドで言語定義をロードすることで、バンドルサイズを削減し、柔軟なテーマ設定とWebコンポーネントによる機能拡張を可能にします。

全文翻訳

microlighter

MicroLighter という、CSS Custom Highlights API を使用する軽量なクライアントサイド構文ハイライターを作成しました。なぜこれを作ったのかについては後ほど説明しますが、まずはその機能の一部を… えーと… ハイライト… させてください。

  • 依存関係ゼロ
  • ミニファイ・gzip圧縮後で約2KB
  • <span> ではなく CSS の ::highlight(token-name) を使用
  • Textmate の言語グラマーを活用
  • 人間が読める light-dark() テーマ
  • 全ての言語/グラマーはオンデマンドで読み込み
  • ハイライト以外の機能はすべて <micro-lighter> カスタム要素に移行

ある時、私の Jekyll ブログの構文ハイライトがおかしくなりました。長年、数多くの構文ハイライター(Highlight.js、PrismJS、Rouge、Shiki など)を使ってきましたが、クライアントサイドとサーバーサイドの実装の違いによるトレードオフを感じていました。次にどれかを選ぶという状況に直面し、Bramus の CSS Custom Highlights API を使った構文ハイライトの手法 を探求したいと思いました。

CSS の ::highlight() 擬似要素にはいくつかの制限があります。イタリック、太字、フォントの切り替えはできません。しかし、それ以外は、いたるところに <span> を挿入するのではなく、CSS を介して「このトークンをハイライトしたい」という意図を、idiomatic に表現できる pretty cool な構文です。Highlight API を使用することで、DOM の変更を一切回避でき、ライブラリのスコープは、正規表現パターンを使用してコードブロックをスキャンし、CSS.highlights.set(category, textRanges) を送信してコードブロックをハイライトするというものに縮小されます。

このサイトでは、それほど多くの構文ハイライトは必要ありません。すべての投稿にコードがあるわけではなく、私のコードサンプルはせいぜい15行程度です。私の悩みは、言語を頻繁に切り替えることです。同じ投稿で HTML、CSS、JavaScript を使います。ここで少し bash、あそこで少し ruby、おまけに markdown も。これらの言語をすべて使用すると、私の正規表現の能力の限界を超えて複雑さが増したため、VS Code で使用されている Textmate の確立されたパターンのコレクションに頼ることにしました。そして気づいた時には、私の小さなハイライターはほとんどすべての言語に対応できるようになっていました。

異なる言語を頻繁に使用することを考慮して、私が確立した原則の 1 つは、設定とバンドルサイズを削減するために、すべての言語グラマーがオンデマンドで自動読み込みされるべきだということです。そうすれば、使用したものに対してのみ料金を支払うことになります。

PrismJS の簡略化されたトークンカテゴリに触発され、Textmate の詳細なトークンカテゴリを、より人間が理解しやすいセットにフラット化し、スタイリングを容易にしました。それに加えて、コードブロックのスタイリングに関する私の大きな不満の 1 つは、ライトテーマとダークテーマが別個のエンティティであることなので、light-dark() を使用してそれらを 1 つのテーマに統合しました。

私が組み込んだ最後の大きな意見は、構文ハイライターに 1 つの仕事だけをしてもらいたかったということです。それは、言語を推測し、その言語でコードをハイライトすることです。これをガイドラインとして、行番号などの追加機能はすべて Web コンポーネントに移動しました。バニラの Web コンポーネントは約 1KiB のサイズを追加しますが、UI をネイティブカスタム要素のような UI プリミティブに共配置することは適切だと感じられ、ShadowDOM のカプセル化により、コードとプレゼンテーション UI を簡単に分離できます。

明らかに、私は Web コンポーネントの変態ですが、すべてをコアライブラリに詰め込もうとするよりも、懸念事項をうまく分離できているように感じます。

試してみる

サイトで始めるには、自己初期化するミニファイされたバンドルを使用するのが良いでしょうが、ESM と Web コンポーネントも出荷しています。

npm install microlighter
<script type="module" src="path/to/microlighter/microlighter.min.js"></script>

前述したように、私のすべての投稿に構文ハイライトがあるわけではないので、コードがあるページであることがわかっている場合にのみスクリプトをインポートするようにしています。

if(document.querySelector('pre>code').length) {
	import('path/to/microlighter/microlighter.min.js');
}

何か気の利いたことを自分でやるつもりなら、ESM バージョンを使用できます。

import { highlightAll } from 'microlighter'

highlightAll({
	selector: 'pre.onlyTheseGetHighlights'
})

そして、私が話した追加機能が必要な場合は、Web コンポーネントを使用することもできます。

<micro-lighter data-syntax-theme="github" line-numbers controls="copy">
  <pre><code>Code goes here</code></pre>
</micro-lighter>

Web コンポーネントのクラスは拡張性も高いため、サポートしていない機能が必要な場合は、ベースクラスを拡張して独自の機能を追加することで「フォーク」できます。

最後に、事前に提供されているテーマのいずれかを使用するか、独自のテーマを作成できます。基本的な構造は次のとおりです。

/**
 * セマンティックな `--syntax-*` トークンを設定します
 * @value background | foreground | comment | keyword |
 * operator |string | constant | function | type | variable |
 * property | tag | selector | inserted | deleted
 */
[data-syntax-theme="my-theme-name"] {
  color-scheme: light dark;

  /* コードブロックのトークン */
  --syntax-background: light-dark(#f8f8f8, #3a3a3a);
  --syntax-foreground: light-dark(#3a3a3a, #f8f8f8);

  /* ハイライトトークン */
  --syntax-comment: light-dark(#6e7781, #8b949e);
	--syntax-function: light-dark(#8250df, #d2a8ff);
  /* ...など... */
}

[data-syntax-theme="my-theme-name"] pre:has(code) {
	background-color:var(--syntax-background);
	color:var(--syntax-foreground)
}

::highlight(comment) { color: var(--syntax-comment) }
::highlight(function) { color: var(--syntax-function) }
/* ...など... */

これが MicroLighter です。もし使用して試してみてくれたら、ぜひ感想を聞かせてください。