@riebeckite/plugin-highlight 0.0.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright Rerurate_514
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,91 @@
+# @riebeckite/plugin-highlight
+
+Inline `==highlight==` support. Text wrapped in double equals is rendered as a
+`<mark>` element at build time.
+
+[日本語](./README_ja.md)
+
+## Overview
+
+`highlight()` registers a remark transformer that rewrites `==text==` in
+Markdown text nodes into raw HTML before the tree is converted to HTML. It
+complements `remark-gfm` (which only understands `~~strikethrough~~`).
+
+## Usage
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { highlight } from "@riebeckite/plugin-highlight";
+
+export default defineConfig({
+  // ...
+  plugins: [highlight()],
+});
+```
+
+## Syntax
+
+```md
+This sentence has a ==highlighted phrase== inside it.
+```
+
+Output:
+
+```html
+This sentence has a <mark class="rb-highlight">highlighted phrase</mark> inside it.
+```
+
+Highlights are matched non-greedily, must stay on a single line, and are
+ignored when they are empty or contain only whitespace. Matches inside code
+blocks, inline code, raw HTML, and frontmatter are left untouched.
+
+## Options
+
+| Option | Type | Default | Description |
+| ------ | ---- | ------- | ----------- |
+| `className` | `string` | `"rb-highlight"` | CSS class on each generated element |
+| `tag` | `string` | `"mark"` | HTML tag used for the highlight |
+
+```ts
+highlight({ className: "my-highlight", tag: "span" });
+```
+
+## Styling
+
+The package ships `style.css`, exposed as
+`@riebeckite/plugin-highlight/style.css`. The default rule styles
+`.rb-highlight` with a subtle accent background and falls back to the
+`--rb-color-accent` theme variable when available:
+
+```css
+.rb-highlight {
+  --rb-highlight-accent: var(--rb-color-accent, #f6d365);
+  padding: 0.05em 0.25em;
+  border-radius: 0.2em;
+  background: color-mix(in srgb, var(--rb-highlight-accent) 45%, transparent);
+  color: inherit;
+}
+```
+
+Because the plugin registers a style asset, the host site includes this
+stylesheet automatically; override the class or supply your own CSS to change
+the appearance.
+
+## Limitations
+
+- A highlight never spans multiple text nodes or lines, so `==` delimiters
+  cannot wrap other Markdown (links, emphasis, code) or line breaks.
+- Nested highlights are not supported; the innermost `==` pair wins.
+- The transformer emits raw HTML, so enable raw HTML output in the pipeline
+  (the default Riebeckite pipeline does).
+
+## Exports
+
+- `highlight(options?)` — plugin factory
+- `highlightPlugin` — alias of `highlight`
+- `remarkHighlight(options?)` — the underlying remark transformer
+- Type: `HighlightOptions`
+
+## See also
+
+- [Plugin guide](../../../docs/en/plugin-system.md)

package/README_ja.md

@@ -0,0 +1,91 @@
+# @riebeckite/plugin-highlight
+
+`==ハイライト==` を `<mark>` 要素として表示するプラグインです。Markdown の
+テキストノードをビルド時に書き換えます。
+
+[English](./README.md)
+
+## 概要
+
+`highlight()` は、Markdown のテキストノードにある `==テキスト==` を HTML に
+変換する前に生の HTML へ置き換える remark トランスフォーマーを登録します。
+`~~打ち消し線~~` だけを扱う `remark-gfm` を補完します。
+
+## 設定する
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { highlight } from "@riebeckite/plugin-highlight";
+
+export default defineConfig({
+  // ...
+  plugins: [highlight()],
+});
+```
+
+## 構文
+
+```md
+この文には ==ハイライトする語句== が含まれます。
+```
+
+出力:
+
+```html
+この文には <mark class="rb-highlight">ハイライトする語句</mark> が含まれます。
+```
+
+ハイライトは非貪欲に一致し、改行をまたぎません。空、または空白だけの
+ハイライトは無視します。コードブロック、インラインコード、生の HTML、
+フロントマターの内部は変更しません。
+
+## オプション
+
+| 項目 | 型 | 既定値 | 説明 |
+| --- | --- | --- | --- |
+| `className` | `string` | `"rb-highlight"` | 生成する要素に付ける CSS クラス |
+| `tag` | `string` | `"mark"` | ハイライトに使う HTML タグ |
+
+```ts
+highlight({ className: "my-highlight", tag: "span" });
+```
+
+## スタイル
+
+このパッケージは `style.css` を同梱し、
+`@riebeckite/plugin-highlight/style.css` として公開します。既定のルールは
+`.rb-highlight` に控えめなアクセント背景を付け、テーマ変数
+`--rb-color-accent` があればそれを使います。
+
+```css
+.rb-highlight {
+  --rb-highlight-accent: var(--rb-color-accent, #f6d365);
+  padding: 0.05em 0.25em;
+  border-radius: 0.2em;
+  background: color-mix(in srgb, var(--rb-highlight-accent) 45%, transparent);
+  color: inherit;
+}
+```
+
+プラグインはスタイルアセットを登録するため、ホスト側のサイトはこの
+スタイルシートを自動的に取り込みます。見た目を変えたい場合はクラスを指定する
+か、独自の CSS で上書きしてください。
+
+## 制限
+
+- ハイライトは複数のテキストノードや行をまたげません。`==` で他の Markdown
+  (リンク、強調、コード) や改行を囲むことはできません。
+- 入れ子のハイライトには対応しません。最も内側の `==` の組が優先されます。
+- 生の HTML を出力するため、パイプラインで生 HTML の出力を有効にする必要が
+  あります（Riebeckite の既定パイプラインでは有効です）。
+
+## 主なエクスポート
+
+- `highlight(options?)`: プラグインを作成する
+- `highlightPlugin`: `highlight` の別名
+- `remarkHighlight(options?)`: 内部の remark トランスフォーマー
+- 型: `HighlightOptions`
+
+## 関連資料
+
+- [プラグインガイド](../../../docs/ja/plugin-system.md)

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+import type { HighlightOptions } from "./src/types.js";
+export { remarkHighlight } from "./src/remark.js";
+export type { HighlightOptions } from "./src/types.js";
+export declare function highlight(options?: HighlightOptions): import("@riebeckite/core").RiebeckitePlugin<HighlightOptions>;
+/** Alias kept for parity with plugins that export a `…Plugin` factory. */
+export declare const highlightPlugin: typeof highlight;

package/dist/index.js

@@ -0,0 +1,103 @@
+// index.ts
+import {
+  createStyleAsset,
+  definePlugin
+} from "@riebeckite/core";
+
+// src/remark.ts
+import { escapeHtml, escapeHtmlAttribute } from "@riebeckite/core";
+import { visit } from "unist-util-visit";
+var DEFAULT_CLASS_NAME = "rb-highlight";
+var DEFAULT_TAG = "mark";
+var HIGHLIGHT_PATTERN = /==([^=\n]+?)==/g;
+var SKIPPED_PARENT_TYPES = /* @__PURE__ */ new Set([
+  "code",
+  "inlineCode",
+  "html",
+  "yaml",
+  "toml"
+]);
+var TAG_NAME_PATTERN = /^[a-zA-Z][a-zA-Z0-9-]*$/;
+function remarkHighlight(options = {}) {
+  const className = options.className ?? DEFAULT_CLASS_NAME;
+  const tag = resolveTag(options.tag);
+  return (tree) => {
+    visit(tree, "text", (node, index, parent) => {
+      if (!parent || index === void 0) return;
+      if (SKIPPED_PARENT_TYPES.has(parent.type)) return;
+      if (!node.value.includes("==")) return;
+      const newNodes = splitHighlights(node.value, className, tag);
+      if (!newNodes) return;
+      parent.children.splice(index, 1, ...newNodes);
+      return index + newNodes.length;
+    });
+  };
+}
+function splitHighlights(value, className, tag) {
+  const newNodes = [];
+  let lastIndex = 0;
+  let matched = false;
+  const highlightRe = new RegExp(HIGHLIGHT_PATTERN.source, "g");
+  for (let match = highlightRe.exec(value); match !== null; match = highlightRe.exec(value)) {
+    const [full, highlighted] = match;
+    if (highlighted.trim().length === 0) continue;
+    const start = match.index;
+    if (start > lastIndex) {
+      newNodes.push({
+        type: "text",
+        value: value.slice(lastIndex, start)
+      });
+    }
+    newNodes.push(createHighlightNode(highlighted, className, tag));
+    lastIndex = start + full.length;
+    matched = true;
+  }
+  if (!matched) return null;
+  if (lastIndex < value.length) {
+    newNodes.push({ type: "text", value: value.slice(lastIndex) });
+  }
+  return newNodes;
+}
+function createHighlightNode(value, className, tag) {
+  return {
+    type: "html",
+    value: `<${tag} class="${escapeHtmlAttribute(className)}">${escapeHtml(value)}</${tag}>`
+  };
+}
+function resolveTag(tag) {
+  return tag && TAG_NAME_PATTERN.test(tag) ? tag : DEFAULT_TAG;
+}
+
+// index.ts
+var TAG_NAME_PATTERN2 = /^[a-zA-Z][a-zA-Z0-9-]*$/;
+function highlight(options = {}) {
+  return definePlugin({
+    name: "highlight",
+    options,
+    validateOptions: validateHighlightOptions,
+    extendMarkdownPipeline: (pipeline) => {
+      pipeline.use(remarkHighlight, options);
+    },
+    assets: [createStyleAsset("highlight")]
+  });
+}
+var highlightPlugin = highlight;
+function validateHighlightOptions(options) {
+  if (!options) return [];
+  const issues = [];
+  if (options.className !== void 0 && typeof options.className !== "string") {
+    issues.push({ path: "className", message: "Expected a string." });
+  }
+  if (options.tag !== void 0 && (typeof options.tag !== "string" || !TAG_NAME_PATTERN2.test(options.tag))) {
+    issues.push({
+      path: "tag",
+      message: 'Expected an HTML tag name such as "mark".'
+    });
+  }
+  return issues;
+}
+export {
+  highlight,
+  highlightPlugin,
+  remarkHighlight
+};

package/dist/src/remark.d.ts

@@ -0,0 +1,3 @@
+import type { Root } from "mdast";
+import type { HighlightOptions } from "./types.js";
+export declare function remarkHighlight(options?: HighlightOptions): (tree: Root) => void;

package/dist/src/types.d.ts

@@ -0,0 +1,7 @@
+/** Options accepted by the highlight plugin. */
+export type HighlightOptions = {
+    /** CSS class applied to each generated highlight element. */
+    className?: string;
+    /** HTML tag used for highlight elements. Defaults to `"mark"`. */
+    tag?: string;
+};

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@riebeckite/plugin-highlight",
+  "version": "0.0.1",
+  "license": "Apache-2.0",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "source": "./index.ts",
+      "default": "./dist/index.js"
+    },
+    "./style.css": "./style.css"
+  },
+  "dependencies": {
+    "@types/mdast": "^4.0.4",
+    "unist-util-visit": "^5.1.0",
+    "@riebeckite/core": "0.0.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "LICENSE",
+    "README.md",
+    "README_ja.md",
+    "dist",
+    "style.css"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Rerurate514/riebeckite.git",
+    "directory": "packages/plugins/highlight"
+  },
+  "homepage": "https://github.com/Rerurate514/riebeckite#readme",
+  "bugs": {
+    "url": "https://github.com/Rerurate514/riebeckite/issues"
+  },
+  "description": "Obsidian-style inline text highlighting for Riebeckite.",
+  "keywords": [
+    "riebeckite",
+    "plugin",
+    "markdown",
+    "highlight"
+  ],
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  },
+  "sideEffects": [
+    "./style.css"
+  ],
+  "scripts": {
+    "build": "node ../../../scripts/build_package.mjs"
+  }
+}

package/style.css

@@ -0,0 +1,13 @@
+.rb-highlight {
+  --rb-highlight-accent: var(--rb-color-accent, #f6d365);
+  padding: 0.05em 0.25em;
+  border-radius: 0.2em;
+  background: color-mix(in srgb, var(--rb-highlight-accent) 45%, transparent);
+  color: inherit;
+}
+
+html[data-theme="dark"] .rb-highlight,
+html.dark .rb-highlight {
+  --rb-highlight-accent: var(--rb-color-accent, #ffd166);
+  background: color-mix(in srgb, var(--rb-highlight-accent) 32%, transparent);
+}