@riebeckite/plugin-icons 0.0.0-stage → 0.0.33

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

@@ -1,3 +1,169 @@
-# Temporary Holding Version
+# @riebeckite/plugin-icons
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+<!-- Generated from docs/docs/plugins/icons.md. Edit the canonical documentation in docs/docs/plugins and run `pnpm docs:sync`. -->
+
+[日本語](./README_ja.md)
+
+Reads the icons you already configured in Obsidian Iconize and Iconic and
+renders them on the static site. Icons are resolved once at build time and
+passed to navigation, folder pages, search, article headers, tag listings, and
+property panels as structured data.
+
+## Installation
+
+```bash
+pnpm add @riebeckite/plugin-icons
+```
+
+## Usage
+
+```ts
+import { icons } from "@riebeckite/plugin-icons";
+
+export default {
+  plugins: [icons()],
+};
+```
+
+No configuration is required. The plugin looks for
+`.obsidian/plugins/obsidian-icon-folder/data.json` and
+`.obsidian/plugins/iconic/data.json` in the Obsidian vault. When the content
+directory is a subdirectory of the vault, its vault-relative prefix is inferred
+automatically.
+
+## Where icons appear
+
+- navigation items and folder-only navigation entries
+- generated folder pages and their page/folder lists
+- the article title, when the note has a file icon
+- search results
+- tags in the article metadata and taxonomy tag pages
+- property keys in the properties panel
+
+Inline icons in Markdown are rendered wherever prose is rendered: headings,
+paragraphs, lists, tables, and blockquotes. Code blocks, inline code, links,
+URLs, raw HTML, and escaped colons are left untouched.
+
+## Iconize
+
+Supported settings and data:
+
+- file and folder icons keyed by vault-relative path
+- custom rules with order, basename or full-path matching, color, and the
+  `everything` / `files` / `folders` scope
+- frontmatter icons and colors, including custom field names
+- inline icons using the configured identifier (default `:`)
+- Lucide icons such as `LiRocket`
+- folder-based custom icon packs under the configured icon packs directory
+- per-icon colors, rule colors, and the global icon color
+
+A direct path entry wins over a custom rule, matching Iconize. Rules are
+evaluated in ascending `order`; invalid regular expressions fall back to a
+substring match. Literal emoji values are rendered as emoji.
+
+## Iconic
+
+Supported settings and data:
+
+- file and folder icons keyed by vault-relative path
+- `fileRules` and `folderRules`
+- rule icons and colors, including the nine named theme colors
+- `tagIcons` and `propertyIcons`
+- conditions for name, filename, extension, tree, path, tags, properties,
+  links, embeds, created, and modified
+- `is`, `contains`, `startsWith`, `endsWith`, `matches`, `hasValue`,
+  `hasProperty`, boolean and numeric operators, array operators, `!` negation,
+  and `all` / `any` / `none` groups
+
+Iconic rules are evaluated in array order and the first enabled match wins. A
+matching rule overrides a manually assigned file icon, as it does in Obsidian.
+
+## Inline icons
+
+The default syntax is `:name:`.
+
+- `:rocket:`, `:smile:`, `:warning:`, and `:book:` resolve to emoji.
+- An unknown emoji name falls back to the Lucide icon with the same name.
+- `:LiRocket:` resolves a Lucide icon directly.
+- A custom pack prefix such as `:MyPackRocket:` resolves the pack icon.
+- Unknown names stay as literal text.
+
+Icons inherit the surrounding font size and color. When no color is configured
+they use `currentColor`, so light and dark themes work without extra CSS. Icons
+are decorative and marked `aria-hidden="true"` so screen readers do not
+announce them twice.
+
+## Precedence
+
+When more than one source has an icon, the default order is:
+
+1. explicit `overrides` option
+2. note frontmatter
+3. Iconic
+4. Iconize
+
+The order is configurable. Inside each source, the upstream rules still apply:
+Iconize uses direct entry before custom rule, and Iconic uses the first matching
+rule before the manual icon.
+
+## Options
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `sources` | `("iconize" \| "iconic")[]` | both | Icon sources to read. |
+| `inline` | `boolean` | `true` | Resolve inline icon syntax in Markdown. |
+| `frontmatter` | `boolean` | `true` | Read icons from note frontmatter. |
+| `colors` | `boolean` | `true` | Apply configured icon colors. |
+| `precedence` | `("config" \| "frontmatter" \| "iconic" \| "iconize")[]` | `["config", "frontmatter", "iconic", "iconize"]` | Source order for a single icon. |
+| `overrides` | `Record<string, string \| { icon: string; color?: string }>` | `{}` | Explicit icons keyed by vault path or slug. |
+| `vaultRoot` | `string` | auto-detected | Obsidian vault root. |
+| `vaultPrefix` | `string` | inferred | Vault-relative prefix of the content directory. |
+| `iconize` | `{ enabled?, dataFile?, iconPacks? }` | auto | Iconize overrides. |
+| `iconic` | `{ enabled?, dataFile? }` | auto | Iconic overrides. |
+
+Example for a vault and site that live in separate repositories:
+
+```ts
+icons({
+  vaultRoot: "../notes",
+  vaultPrefix: "content/",
+  iconize: { dataFile: "../notes/.obsidian/plugins/obsidian-icon-folder/data.json" },
+  iconic: { dataFile: "../notes/.obsidian/plugins/iconic/data.json" },
+});
+```
+
+Explicit data files must stay inside the vault root (or the working directory
+when no vault root is set).
+
+## Supported icon packs
+
+Lucide is read on demand from `lucide-static`; only icons that are actually
+referenced are emitted. Folder-based Iconize packs are read from the configured
+icon packs directory. Zip-only packs are not read; extract them into folders
+under that directory. Iconize's `twemoji` emoji style is not bundled, so native
+emoji are used instead.
+
+## Unsupported and constrained behavior
+
+- Iconic `clock`, `headings`, `bookmarks`, and now-relative date/time conditions
+  cannot be evaluated during a static build. They never match, and a diagnostic
+  explains why. Absolute date comparisons on `created` and `modified` work when
+  file metadata is available.
+- Iconic emoji colors are not reproduced with CSS filters; emoji render in the
+  platform's native colors.
+- Obsidian UI icons (ribbon, tabs, menus, bookmarks) are intentionally ignored.
+- Icons for unpublished notes are not emitted into public HTML.
+- A missing or malformed settings file is reported as a warning and never fails
+  the build.
+
+## Security
+
+The plugin reads only the known Obsidian settings files and the configured icon
+packs directory. It does not execute plugin JavaScript, does not copy
+`.obsidian` into the output, and does not scan the vault for arbitrary files.
+Settings and pack paths are restricted to the vault root, symlinks are skipped,
+and file sizes are capped.
+
+Custom SVG and Lucide SVG pass through an allowlist sanitizer that removes
+scripts, event handlers, styles, external references, and unsafe URL schemes
+before any HTML is emitted. No client-side JavaScript renders icons.

package/README_ja.md

@@ -0,0 +1,169 @@
+# @riebeckite/plugin-icons
+
+<!-- Generated from docs/docs/plugins/icons.ja.md. Edit the canonical documentation in docs/docs/plugins and run `pnpm docs:sync`. -->
+
+[English](./README.md)
+
+Obsidian の Iconize と Iconic で設定済みのアイコンを読み取り、静的サイトに
+表示するプラグインです。アイコンはビルド時に一度だけ解決され、ナビゲーション、
+フォルダページ、検索、記事タイトル、タグ一覧、プロパティパネルへ構造化データ
+として渡されます。
+
+## インストール
+
+```bash
+pnpm add @riebeckite/plugin-icons
+```
+
+## 使い方
+
+```ts
+import { icons } from "@riebeckite/plugin-icons";
+
+export default {
+  plugins: [icons()],
+};
+```
+
+設定は不要です。Obsidian vault の
+`.obsidian/plugins/obsidian-icon-folder/data.json` と
+`.obsidian/plugins/iconic/data.json` を探します。コンテンツディレクトリが
+vault のサブディレクトリにある場合は、vault からの相対パスも自動で推定します。
+
+## アイコンの表示箇所
+
+- ナビゲーション項目と、ページを持たないフォルダ項目
+- 自動生成されるフォルダページと、そのページ・フォルダ一覧
+- ノートにファイルアイコンがある場合の記事タイトル
+- 検索結果
+- 記事メタデータのタグと、タクソノミーのタグページ
+- プロパティパネルのプロパティ名
+
+Markdown のインラインアイコンは、見出し、段落、リスト、テーブル、引用内で
+表示されます。コードブロック、インラインコード、リンク、URL、生の HTML、
+エスケープしたコロンは変更しません。
+
+## Iconize
+
+次の設定とデータに対応します。
+
+- vault 相対パスをキーにしたファイル・フォルダアイコン
+- 順序、ファイル名またはフルパス一致、色、`everything` / `files` /
+  `folders` の対象範囲を持つカスタムルール
+- frontmatter のアイコンと色（フィールド名の変更を含む）
+- 設定した識別子（既定は `:`）によるインラインアイコン
+- `LiRocket` のような Lucide アイコン
+- 設定したアイコンパックディレクトリ配下のフォルダ型カスタムパック
+- アイコン単位の色、ルールの色、グローバルなアイコン色
+
+パスに直接設定したアイコンはカスタムルールより優先されます。これは Iconize
+と同じ挙動です。ルールは `order` の昇順で評価し、正規表現が不正な場合は部分
+文字列一致にフォールバックします。値が絵文字そのものであれば絵文字として
+表示します。
+
+## Iconic
+
+次の設定とデータに対応します。
+
+- vault 相対パスをキーにしたファイル・フォルダアイコン
+- `fileRules` と `folderRules`
+- ルールのアイコンと色（9 種類の名前付きテーマ色を含む）
+- `tagIcons` と `propertyIcons`
+- 名前、ファイル名、拡張子、ツリー、パス、タグ、プロパティ、リンク、
+  埋め込み、作成日時、更新日時を対象にした条件
+- `is`、`contains`、`startsWith`、`endsWith`、`matches`、`hasValue`、
+  `hasProperty`、真偽値・数値・配列の演算子、`!` による否定、
+  `all` / `any` / `none` の条件グループ
+
+Iconic のルールは配列順に評価し、有効な最初の一致を採用します。一致した
+ルールは手動設定のファイルアイコンを上書きします。Obsidian と同じ挙動です。
+
+## インラインアイコン
+
+既定の構文は `:name:` です。
+
+- `:rocket:`、`:smile:`、`:warning:`、`:book:` は絵文字になります。
+- 絵文字名が見つからない場合は、同じ名前の Lucide アイコンを使います。
+- `:LiRocket:` は Lucide アイコンを直接指定します。
+- `:MyPackRocket:` のようにパック名を付けると、カスタムパックのアイコンを
+  使います。
+- 解決できない名前はそのままの文字列で残します。
+
+アイコンは周囲のフォントサイズと色を継承します。色が未設定のときは
+`currentColor` を使うため、ライトテーマとダークテーマの両方で追加の CSS は
+不要です。アイコンは装飾として `aria-hidden="true"` を付け、スクリーン
+リーダーが二重に読み上げないようにしています。
+
+## 優先順位
+
+複数のソースにアイコンがある場合、既定の順序は次のとおりです。
+
+1. `overrides` オプション
+2. ノートの frontmatter
+3. Iconic
+4. Iconize
+
+順序は変更できます。ソース内部では上流の規則を維持します。Iconize は直接
+設定をカスタムルールより優先し、Iconic は最初に一致したルールを手動設定より
+優先します。
+
+## オプション
+
+| オプション | 型 | 既定値 | 説明 |
+| --- | --- | --- | --- |
+| `sources` | `("iconize" \| "iconic")[]` | 両方 | 読み取るアイコンソース。 |
+| `inline` | `boolean` | `true` | Markdown のインラインアイコンを解決する。 |
+| `frontmatter` | `boolean` | `true` | frontmatter のアイコンを読む。 |
+| `colors` | `boolean` | `true` | 設定されたアイコンの色を適用する。 |
+| `precedence` | `("config" \| "frontmatter" \| "iconic" \| "iconize")[]` | `["config", "frontmatter", "iconic", "iconize"]` | 1 つのアイコンを決めるときのソース順。 |
+| `overrides` | `Record<string, string \| { icon: string; color?: string }>` | `{}` | vault パスまたは slug をキーにした明示的なアイコン。 |
+| `vaultRoot` | `string` | 自動検出 | Obsidian vault のルート。 |
+| `vaultPrefix` | `string` | 自動推定 | コンテンツディレクトリの vault 相対プレフィックス。 |
+| `iconize` | `{ enabled?, dataFile?, iconPacks? }` | 自動 | Iconize の上書き設定。 |
+| `iconic` | `{ enabled?, dataFile? }` | 自動 | Iconic の上書き設定。 |
+
+vault とサイトが別リポジトリにある場合の例です。
+
+```ts
+icons({
+  vaultRoot: "../notes",
+  vaultPrefix: "content/",
+  iconize: { dataFile: "../notes/.obsidian/plugins/obsidian-icon-folder/data.json" },
+  iconic: { dataFile: "../notes/.obsidian/plugins/iconic/data.json" },
+});
+```
+
+明示したデータファイルは vault ルート（vault ルートを指定しない場合は作業
+ディレクトリ）の内側になければなりません。
+
+## 対応アイコンパック
+
+Lucide は `lucide-static` から必要なときだけ読み込み、実際に参照された
+アイコンだけを出力します。フォルダ型の Iconize パックは、設定されたアイコン
+パックディレクトリから読み込みます。Zip のみのパックには対応しません。その
+場合はディレクトリへ展開してください。Iconize の `twemoji` は同梱していない
+ため、ネイティブ絵文字で表示します。
+
+## 未対応・制約
+
+- Iconic の `clock`、`headings`、`bookmarks`、現在時刻に依存する日時条件は
+  静的ビルドでは評価できません。一致しないものとして扱い、理由を診断に
+  出力します。ファイルメタデータがある場合、`created` と `modified` の
+  絶対日時比較は利用できます。
+- Iconic の絵文字色は CSS フィルターで再現しません。絵文字はプラット
+  フォーム標準の色で表示されます。
+- Obsidian の UI アイコン（リボン、タブ、メニュー、ブックマーク）は対象外
+  です。
+- 非公開ノートのアイコンは公開 HTML に出力しません。
+- 設定ファイルがない場合や壊れている場合は警告を出し、ビルドは継続します。
+
+## セキュリティ
+
+既知の Obsidian 設定ファイルと、設定されたアイコンパックディレクトリだけを
+読みます。プラグインの JavaScript は実行せず、`.obsidian` を出力へコピーせず、
+vault 全体を任意に走査しません。設定とパックのパスは vault ルート内に制限し、
+シンボリックリンクを除外し、ファイルサイズに上限を設けています。
+
+カスタム SVG と Lucide SVG は許可リスト方式のサニタイザを通し、スクリプト、
+イベントハンドラ、スタイル、外部参照、危険な URL スキームを除去してから
+HTML を出力します。アイコンの描画にクライアント側 JavaScript は使いません。

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+import type { IconsOptions } from "./src/types.js";
+export type { IconOverride, IconPrecedence, IconSource, IconsOptions, ResolvedIconsOptions, } from "./src/types.js";
+export declare function icons(options?: IconsOptions): import("@riebeckite/core").RiebeckitePlugin<IconsOptions>;