@riebeckite/plugin-bases 0.0.32 → 0.0.33

package/README.md

@@ -58,6 +58,18 @@ The same YAML may be placed in a fenced `base` block or in a `.base` file.
 Top-level and view-local `filters` are combined with AND. Table and cards are
 rendered at build time; all dynamic values are escaped before HTML output.
 
+## Live example
+
+~~~base
+properties:
+  file.name:
+    displayName: Title
+views:
+  - type: table
+    name: Pages
+    limit: 5
+~~~
+
 ## Official syntax audit
 
 This implementation follows the documented YAML shape in the [Obsidian Bases
@@ -161,6 +173,6 @@ the static, no-JavaScript output model.
 ## Options and exports
 
 `className`, `language`, `limit`, `showFallback`, and `view` retain their existing
-meanings. The package exports `bases`, `basesPlugin`, `remarkBases`, `parseBases`,
+meanings. The package exports `bases`, `bases`, `remarkBases`, `parseBases`,
 `parseBasesExpression`, `analyzeBasesDependencies`, `evaluateBasesExpression`, `matchesCondition`, and the
 public Bases types.

package/README_ja.md

@@ -2,7 +2,7 @@
 
 <!-- Generated from docs/docs/plugins/bases.ja.md. Edit the canonical documentation in docs/docs/plugins and run `pnpm docs:sync`. -->
 
-Obsidian Bases の互換サブセットをビルド時に描画します。`bases()` は fenced
+Obsidian Bases の互換サブセットをビルド時に描画します。`bases()` はフェンス付き
 `base` ブロックと、参照された `.base` ドキュメントを扱います。クライアント側の
 評価器は含みません。
 
@@ -54,11 +54,23 @@ views:
     order: [file.name, formula.label]
 ```
 
-同じ YAML を fenced `base` ブロックまたは `.base` ファイルに書けます。トップ
-レベルとビューごとの `filters` は AND で結合します。Table と cards はビルド時に
+同じ YAML をフェンス付き `base` ブロックまたは `.base` ファイルに書けます。トップ
+レベルとビューごとの `filters` は AND で結合します。表とカードはビルド時に
 描画し、HTML に出す動的な値はすべてエスケープします。
 
-## 公式構文の監査
+## 実行例
+
+~~~base
+properties:
+  file.name:
+    displayName: Title
+views:
+  - type: table
+    name: Pages
+    limit: 5
+~~~
+
+## 公式構文への対応
 
 Obsidian の [Bases 構文](https://help.obsidian.md/bases/syntax) と
 [ビュー](https://help.obsidian.md/bases/views) の YAML 形式を確認し、決定的な静的出力に
@@ -66,13 +78,13 @@ Obsidian の [Bases 構文](https://help.obsidian.md/bases/syntax) と
 
 | 構文またはビュー機能 | 状態 | 静的出力での扱い |
 | --- | --- | --- |
-| ルートの `filters`、`formulas`、`properties`、`summaries`、`views` | 対応 | 再帰的な `and`／`or`／`not` filter と `displayName` を受け付けます。 |
+| ルートの `filters`、`formulas`、`properties`、`summaries`、`views` | 対応 | 再帰的な `and`／`or`／`not` フィルタと `displayName` を受け付けます。 |
 | ビューの `type`、`name`、`limit`、`filters`、`order`、`sort`、`groupBy`、`groupOrder`、`summaries` | 対応 | `groupOrder` は排他的です。空リストはすべてのグループを隠し、存在しない値を列挙すると空グループを作ります。 |
-| Table と cards のレイアウト | 対応 | 実行時の評価器を持たないセマンティック HTML を生成します。 |
-| List、kanban、map のレイアウト | 未対応 | 対話的・空間的な動作はこの静的レンダラーでは表現できません。 |
+| 表とカードのレイアウト | 対応 | 実行時の評価器を持たないセマンティック HTML を生成します。 |
+| list、kanban、map のレイアウト | 未対応 | 対話的・空間的な動作はこの静的レンダラーでは表現できません。 |
 | 編集、プロパティメニュー、列幅変更、ドラッグ＆ドロップ、折りたたみ操作 | 対象外 | Bases はサイトのビルド時に描画します。 |
 
-## 式と Formula のサブセット
+## 式と Formula の対応範囲
 
 式は AST に構文解析して直接評価します。`eval`、`Function`、任意の JavaScript 実行は
 使いません。リテラル、配列、ネストしたメンバー・インデックス参照、`!`、単項 `-`、
@@ -92,42 +104,42 @@ Formula の循環参照は空の値になります。
 既存の Date だけを受け付けます。日付フィールドとフォーマットは UTC を使うため、静的
 ビルドでホストのロケールや曖昧な日付構文に依存しません。
 
-Formula の評価は、1回につき AST の 10,000 ステップとネストした式の 128 段階までです。
+Formula の評価は、1 回につき AST の 10,000 ステップとネストした式の 128 段階までです。
 いずれかを超えると決定的に停止し、`bases-invalid` 診断を出して Base のエラー表示に
-切り替えます。大きな高階式や深い式によって静的ビルドが無制限に実行されることを防ぎ、
+切り替えます。大きな高階の式や深い式で静的ビルドの処理が無制限に続くことを防ぎ、
 JavaScript のコールバックは実行しません。
 
 ## ファイルメタデータ
 
 `file.size` はソースファイルのバイト数です。`file.mtime` と `file.ctime` は
-ファイルシステムから得る UTC の `Date` 値で、プロパティ、filter、Formula、ソート、
-グループ、集計、高階式で使えます。ソースのメタデータが欠落または不正な場合は、描画後の
+ファイルシステムから得る UTC の `Date` 値で、プロパティ、フィルタ、Formula、ソート、
+グループ、集計、高階の式で使えます。ソースのメタデータが欠落または不正な場合は、描画後の
 Markdown やビルド時刻から補わず、空の値として扱います。日付どうしの減算はミリ秒になり、
 `"7 days"` のような duration による Date の加減算もできます。
 
 ファイルシステムのコンテンツでは、`file.ctime` に Node の `birthtime` を使います。
-status-change time である `stat.ctime` は使いません。Windows では通常、作成時刻を取得
+状態変更時刻である `stat.ctime` は使いません。Windows では通常、作成時刻を取得
 できます。Linux のファイルシステムは作成時刻を持たないことがあり、Node が
 ファイルシステム依存の代替値を返すか、利用できる値がない場合があります。移植性が必要な
 Base では空の `file.ctime` を扱ってください。キャッシュした時刻は UTC の瞬間を保ちます。
 
 ## 増分ビルド
 
-Bases は、filter、formula、column、sort、group、summary が読むプロパティを永続 Output
-Inventory に記録します。これは fenced Base と参照された各 `.base` ドキュメントに個別に適用されます。
+Bases は、フィルタ、Formula、列、ソート、グループ、集計が読むプロパティを永続 Output
+Inventory に記録します。これはフェンス付き Base と参照された各 `.base` ドキュメントに個別に適用されます。
 これらのプロパティ、参照するファイルメタデータ、または公開候補集合が変わった場合だけ、その値を読む Base 出力を
-再生成します。filter 不一致から一致への変更も検出します。本文だけの編集と無関係な frontmatter 編集では Base 出力を
+再生成します。フィルタに一致しない状態から一致する状態への変更も検出します。本文だけの編集と無関係な frontmatter 編集では Base 出力を
 再利用します。
 
-formula の循環、動的なプロパティ参照など、静的に証明できない依存関係では Base 単位で保守的に再生成します。
-不明な依存関係を依存なしとして扱うことはありません。draft、scheduled、unlisted のエントリは Base の行から除外され、
+Formula の循環、動的なプロパティ参照など、静的に証明できない依存関係では Base 単位で保守的に再生成します。
+不明な依存関係を依存なしとして扱うことはありません。下書き、スケジュール公開、unlisted のエントリは Base の行から除外され、
 キャッシュ出力からも公開されません。
 
 ## 静的ビューのアクセシビリティ
 
-Table は列と行グループの見出しを維持し、画面読み上げ用の件数を持ちます。狭い画面では
+表は列と行グループの見出しを維持し、画面読み上げ用の件数を持ちます。狭い画面では
 キーボードでフォーカスできる横スクロール領域に収めます。グループ名には行数を示し、
-`groupOrder` にあるが一致する行がない値は空グループとして明示します。Card のグループは
+`groupOrder` にあるが一致する行がない値は空グループとして明示します。カードのグループは
 ラベル付きリストとし、集計値には画面読み上げ用の列名を加えます。いずれも JavaScript を
 使わない静的出力のままです。
 
@@ -136,24 +148,24 @@ Table は列と行グループの見出しを維持し、画面読み上げ用
 | Obsidian Base の機能 | 状態 | 備考 |
 | --- | --- | --- |
 | YAML ルート、`filters`、`properties`、`formulas`、`summaries`、`views` | 対応 | YAML または仕様が不正な場合は診断を出します。 |
-| Table と cards | 対応 | ほかのビュー種別は描画しません。 |
-| AST の filter と Formula | 一部対応 | 対応関数は上記のとおりです。 |
+| 表とカード | 対応 | ほかのビュー種別は描画しません。 |
+| AST のフィルタと Formula | 一部対応 | 対応関数は上記のとおりです。 |
 | Formula によるソートと複数の安定ソートキー | 対応 | 空の値は末尾に並びます。 |
-| `groupBy` と `groupOrder` | 対応 | Formula プロパティ、順序付きの空グループ、Table、cards に対応します。対話的な折りたたみは対象外です。 |
-| Table の集計 | 一部対応 | 名前付き集計、Empty、Filled、Unique、Checked、Unchecked、数値、日付の集計を使えます。 |
-| Cards の集計 | 対象外 | Obsidian は集計を cards ではなく Table に表示します。 |
+| `groupBy` と `groupOrder` | 対応 | Formula プロパティ、順序付きの空グループ、表、カードに対応します。対話的な折りたたみは対象外です。 |
+| 表の集計 | 一部対応 | 名前付き集計、Empty、Filled、Unique、Checked、Unchecked、数値、日付の集計を使えます。 |
+| カードの集計 | 対象外 | Obsidian は集計をカードではなく表に表示します。 |
 | `file.name`、`file.path`、`file.ext`、`file.folder`、`file.tags`、`file.links`、`file.properties`、`file.link` | 一部対応 | Markdown マニフェストから導出します。name/path は `.md` のソース規則を使います。 |
 | `file.size`、`file.mtime`、`file.ctime` | 対応 | バイト数、ファイルシステムの更新時刻、作成時刻相当を使います。Linux では `ctime` が利用できないことがあります。`stat.ctime`、frontmatter、ビルド時刻へは置き換えません。 |
-| Backlinks、embeds | 未対応 | これらの値は空になります。 |
+| Backlinks、埋め込み | 未対応 | これらの値は空になります。 |
 | リストの `map`、`filter`、`reduce` | 一部対応 | `value`、`index`、`acc` スコープの式を使い、リスト長には上限があります。 |
-| 決定的な utility、object、date、file-property 関数 | 一部対応 | UTC 日付、`duration`、コレクション／object ヘルパー、`file.hasProperty` を使えます。Vault API や描画済みリンクを必要とする関数は使えません。 |
-| 増分依存追跡 | 対応 | filter 候補集合と AST から得たプロパティ依存を追跡し、動的・循環 formula は Base 単位でフォールバックします。 |
-| 正規表現、オブジェクトリテラル、`file()`、link/image/icon/HTML の描画、`now`、`today`、`random`、相対日付 | 未対応 | JavaScript を実行せず、ビルド時刻に依存せず、安全でない URL を出力しません。 |
+| 決定的なユーティリティ、オブジェクト、日付、ファイルプロパティの関数 | 一部対応 | UTC 日付、`duration`、コレクション／オブジェクトのヘルパー、`file.hasProperty` を使えます。Vault API や描画済みリンクを必要とする関数は使えません。 |
+| 増分依存追跡 | 対応 | フィルタ候補集合と AST から得たプロパティ依存を追跡し、動的・循環 Formula は Base 単位でフォールバックします。 |
+| 正規表現、オブジェクトリテラル、`file()`、リンク・画像・アイコン・HTML の描画、`now`、`today`、`random`、相対日付 | 未対応 | JavaScript を実行せず、ビルド時刻に依存せず、安全でない URL を出力しません。 |
 | 編集、グループの折りたたみなどの対話的なビュー操作 | 対象外 | Riebeckite は静的なビルド出力を描画します。 |
 
 ## オプションとエクスポート
 
 `className`、`language`、`limit`、`showFallback`、`view` の意味は従来どおりです。
-パッケージは `bases`、`basesPlugin`、`remarkBases`、`parseBases`、
+パッケージは `bases`、`bases`、`remarkBases`、`parseBases`、
 `parseBasesExpression`、`analyzeBasesDependencies`、`evaluateBasesExpression`、`matchesCondition`、公開 Bases 型を
 エクスポートします。

package/dist/index.d.ts

@@ -14,5 +14,3 @@ export type { BasesBuiltinValue, BasesCondition, BasesExpression, BasesGroupBy,
  * build time, so no client-side JavaScript is required.
  */
 export declare function bases(options?: BasesOptions): import("@riebeckite/core").RiebeckitePlugin<BasesOptions>;
-/** Alias kept for symmetry with other plugin factories. */
-export declare const basesPlugin: typeof bases;

package/dist/index.js

@@ -1897,7 +1897,7 @@ function renderEmpty(className) {
   return `<p class="${escapeHtmlAttribute(className)}__empty">No matching notes.</p>`;
 }
 function renderFallback(className, source) {
-  return `<details class="${escapeHtmlAttribute(className)}__fallback"><summary>Base definition</summary><pre><code>${escapeHtml2(source)}</code></pre></details>`;
+  return `<details class="${escapeHtmlAttribute(className)}__fallback rb-source-fallback"><summary>Base definition</summary><pre><code>${escapeHtml2(source)}</code></pre></details>`;
 }
 function renderCell(entry, property, className, spec) {
   const key = property.toLowerCase();
@@ -2272,7 +2272,6 @@ function bases(options = {}) {
     assets: [createStyleAsset("bases", "@riebeckite/plugin-bases/style.css")]
   });
 }
-var basesPlugin = bases;
 function validateBasesOptions(options) {
   if (!options) return [];
   const issues = [];
@@ -2300,7 +2299,6 @@ export {
   BasesEvaluationError,
   analyzeBasesDependencies,
   bases,
-  basesPlugin,
   evaluateBasesExpression,
   groupBasesEntries,
   matchesCondition,

package/dist/src/expression.d.ts

@@ -1,5 +1,5 @@
 import type { BasesExpression } from "./types.js";
-export type ExpressionResult = {
+type ExpressionResult = {
     readonly ok: true;
     readonly value: BasesExpression;
 } | {
@@ -7,3 +7,4 @@ export type ExpressionResult = {
     readonly message: string;
 };
 export declare function parseBasesExpression(source: string): ExpressionResult;
+export {};

package/dist/src/page.d.ts

@@ -1,6 +1,6 @@
 import { type ContentManifest, type ContentSource, type Diagnostic, type PluginPage } from "@riebeckite/core";
 import type { BasesOptions } from "./types.js";
-export type BaseDocument = {
+type BaseDocument = {
     readonly pathname: string;
     readonly dependencies: readonly import("@riebeckite/core").OutputDependency[];
 };
@@ -15,3 +15,4 @@ export declare function resolveBaseDocument(input: {
     readonly pathname: string;
     readonly diagnostics: Diagnostic[];
 }, options: BasesOptions): Promise<PluginPage | null>;
+export {};

package/dist/src/placeholder.d.ts

@@ -10,12 +10,12 @@ import type { BasesSpec } from "./types.js";
  * HTML, so it never reaches the published page.
  */
 export declare const BASES_ATTRIBUTE = "data-rr-bases";
-export type BasesPlaceholderPayload = {
+type BasesPlaceholderPayload = {
     readonly spec: BasesSpec;
     readonly source: string;
 };
-export declare function encodeBasesPayload(payload: BasesPlaceholderPayload): string;
 export declare function decodeBasesPayload(encoded: string): BasesPlaceholderPayload | null;
 export declare function createBasesPlaceholder(payload: BasesPlaceholderPayload): string;
 /** A fresh global pattern is returned per call to avoid shared `lastIndex`. */
 export declare function createBasesPlaceholderPattern(): RegExp;
+export {};

package/dist/src/remark.d.ts

@@ -1,5 +1,5 @@
 import type { Root } from "mdast";
-export type RemarkBasesOptions = {
+type RemarkBasesOptions = {
     /** Fenced code block language treated as a Base. Defaults to `base`. */
     language?: string;
 };
@@ -12,3 +12,4 @@ export type RemarkBasesOptions = {
  * the content manifest exists.
  */
 export declare function remarkBases(options?: RemarkBasesOptions): (tree: Root, file: unknown) => void;
+export {};

package/dist/src/runtime.d.ts

@@ -1,6 +1,6 @@
 import type { ContentManifest, Diagnostic, OutputDependency, ResolvedRiebeckiteConfig } from "@riebeckite/core";
 import type { BasesOptions } from "./types.js";
-export type BasesRuntime = {
+type BasesRuntime = {
     /** Replaces every Base placeholder in the manifest with rendered output. */
     resolve(manifest: ContentManifest, diagnostics: Diagnostic[], config?: ResolvedRiebeckiteConfig): void;
     dependenciesFor(slug: string): readonly OutputDependency[];
@@ -8,3 +8,4 @@ export type BasesRuntime = {
     setDocumentDependencies(dependencies: ReadonlyMap<string, readonly OutputDependency[]>): void;
 };
 export declare function createBasesRuntime(options: BasesOptions): BasesRuntime;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-bases",
-  "version": "0.0.32",
+  "version": "0.0.33",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -15,10 +15,10 @@
     "./style.css": "./style.css"
   },
   "dependencies": {
+    "@riebeckite/core": "0.0.33",
     "@types/mdast": "^4.0.4",
     "unist-util-visit": "^5.1.0",
-    "vfile-matter": "^5.0.1",
-    "@riebeckite/core": "0.0.32"
+    "vfile-matter": "^5.0.1"
   },
   "publishConfig": {
     "access": "public"
@@ -53,6 +53,7 @@
     "./style.css"
   ],
   "scripts": {
-    "build": "node ../../../scripts/build_package.mjs"
+    "build": "node ../../../scripts/build_package.mjs",
+    "test": "node --import tsx --test \"test/*.test.ts\""
   }
 }

package/style.css

@@ -204,22 +204,6 @@
   border: 0;
 }
 
-.rb-bases__fallback {
-  margin-top: 1rem;
-  color: var(--rb-bases-muted);
-  font-size: 0.8125rem;
-}
-
-.rb-bases__fallback pre {
-  overflow-x: auto;
-  margin: 0.5rem 0 0;
-  padding: 0.75rem;
-  border: 1px solid var(--rb-bases-rule);
-  background: var(--rb-bases-surface);
-  color: var(--rb-bases-ink);
-  font-size: 0.8125rem;
-}
-
 .rb-bases--error {
   margin: 1.5rem 0;
   padding: 0.75rem 1rem;