@riebeckite/plugin-query 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,122 @@
+# @riebeckite/plugin-query
+
+Turn `query` code blocks into lists or tables of content. Filtering, sorting,
+and pagination run against frontmatter and tags at build time, so no client-side
+JavaScript is required.
+
+[日本語](./README_ja.md)
+
+## Overview
+
+`queryPlugin()` recognises fenced blocks
+
+````md
+```query
+filter:
+  tags:
+    any: [diary]
+sort:
+  field: date
+  order: desc
+limit: 5
+```
+````
+
+and renders them using the content manifest (every note's frontmatter, tags, and
+permalink).
+
+## Usage
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { queryPlugin } from "@riebeckite/plugin-query";
+
+export default defineConfig({
+  // ...
+  plugins: [queryPlugin()],
+});
+```
+
+## Block syntax
+
+The block body is a YAML mapping. Every field is optional.
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| `filter` | object | Filtering conditions (below) |
+| `sort` | object \| object[] | `field` (a frontmatter key, `title`, `slug`, or `permalink`) and `order` (`asc` / `desc`, default `asc`). The default field is `date` |
+| `limit` | number | Maximum number of entries |
+| `offset` | number | Entries to skip from the top |
+| `format` | `"table"` \| `"list"` | Output format. Defaults to `table` |
+| `columns` | string[] | Table columns: presets (`title`, `date`, `updated`, `created`, `published`, `tags`, `description`, `permalink`) or frontmatter keys |
+| `excludeSelf` | boolean | Exclude the note hosting the block from its own results |
+| `empty` | string | Message shown when nothing matches |
+
+### `filter`
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| `tags.any` | string[] | Has at least one of these tags |
+| `tags.all` | string[] | Has every one of these tags |
+| `tags.none` | string[] | Has none of these tags |
+| `folder` | string \| string[] | Slug prefix match |
+| `frontmatter` | object | Frontmatter equality. An array matches any member; string comparisons are case-insensitive |
+| `date` | object | `field` (default `date`) plus inclusive `from` / `to` bounds |
+
+```yaml
+filter:
+  tags:
+    any: [diary, note]
+    none: [draft]
+  folder: articles
+  frontmatter:
+    draft: false
+  date:
+    field: published
+    from: 2024-01-01
+    to: 2024-12-31
+sort:
+  - field: date
+    order: desc
+  - field: title
+limit: 10
+format: list
+```
+
+## Options
+
+| Option | Type | Default | Description |
+| ------ | ---- | ------- | ----------- |
+| `className` | `string` | `"rr-query"` | Root CSS class |
+| `language` | `string` | `"query"` | Fence language to target |
+| `defaultFormat` | `"table"` \| `"list"` | `"table"` | Format when a block omits `format` |
+| `defaultColumns` | `string[]` | `["title", "date"]` | Columns when a block omits `columns` |
+| `defaultSort` | object | none | Sort when a block omits `sort` |
+| `defaultLimit` | `number` | none | Row cap when a block omits `limit` |
+| `emptyMessage` | `string` | `"No matching content."` | Empty-state message |
+| `excludeSelf` | `boolean` | `false` | Exclude the host page by default |
+
+## Diagnostics
+
+A block that is not valid YAML (or not a mapping) renders an inline error and
+emits a `content-query-invalid` error diagnostic. Unknown fields emit a
+`content-query-unknown-field` warning.
+
+## Limitations
+
+- Links produced by a query are not added to the content graph (backlinks).
+  Only links written in the source Markdown participate.
+- Results are fixed at build time. Rebuilding a host note when a queried note
+  changes is future work; a full build always recomputes correctly.
+
+## Exports
+
+- `queryPlugin(options?)` — plugin factory
+- `remarkQuery(options?)` — remark transform usable on its own (`options.language` selects the fence language)
+- `queryContentEntries(entries, spec)` — the Core matching engine (also
+  available from `@riebeckite/core`)
+- Types: `QueryOptions`, `QuerySpec`, `QueryOutputFormat`
+
+## See also
+
+- [Plugin guide](../../../docs/en/plugin-system.md)

package/README_ja.md

@@ -0,0 +1,114 @@
+# @riebeckite/plugin-query
+
+`query` コードブロックを、コンテンツの一覧（表またはリスト）に変換するプラグインです。絞り込み・並べ替え・件数制限をフロントマターとタグに対して行い、ビルド時に HTML を生成します。クライアント側の JavaScript は不要です。
+
+[English](./README.md)
+
+## できること
+
+`queryPlugin()` は Markdown 中のフェンスコードブロック
+
+````md
+```query
+filter:
+  tags:
+    any: [diary]
+sort:
+  field: date
+  order: desc
+limit: 5
+```
+````
+
+を検出し、マニフェスト（全ノートのフロントマター・タグ・パーマリンク）を使って結果を描画します。
+
+## 設定
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { queryPlugin } from "@riebeckite/plugin-query";
+
+export default defineConfig({
+  // ...
+  plugins: [queryPlugin()],
+});
+```
+
+## ブロックの書き方
+
+ブロック本文は YAML のマッピングです。すべて省略できます。
+
+| フィールド | 型 | 内容 |
+| --- | --- | --- |
+| `filter` | object | 絞り込み条件（下記） |
+| `sort` | object \| object[] | 並べ替え。`field`（フロントマターキー、`title`、`slug`、`permalink`）と `order`（`asc` / `desc`、既定 `asc`）。既定のフィールドは `date` |
+| `limit` | number | 最大件数 |
+| `offset` | number | 先頭から読み飛ばす件数 |
+| `format` | `"table"` \| `"list"` | 表示形式。既定は `table` |
+| `columns` | string[] | 表の列。プリセット（`title`、`date`、`updated`、`created`、`published`、`tags`、`description`、`permalink`）またはフロントマターキー |
+| `excludeSelf` | boolean | このブロックを含むノート自身を結果から除く |
+| `empty` | string | 一致が無いときのメッセージ |
+
+### `filter`
+
+| フィールド | 型 | 内容 |
+| --- | --- | --- |
+| `tags.any` | string[] | いずれかのタグを持つ |
+| `tags.all` | string[] | すべてのタグを持つ |
+| `tags.none` | string[] | どのタグも持たない |
+| `folder` | string \| string[] | スラッグの前方一致 |
+| `frontmatter` | object | フロントマターの一致。値が配列ならそのいずれかに一致。文字列比較は大文字小文字を区別しない |
+| `date` | object | `field`（既定 `date`）と `from` / `to`（両端を含む） |
+
+```yaml
+filter:
+  tags:
+    any: [diary, note]
+    none: [draft]
+  folder: articles
+  frontmatter:
+    draft: false
+  date:
+    field: published
+    from: 2024-01-01
+    to: 2024-12-31
+sort:
+  - field: date
+    order: desc
+  - field: title
+limit: 10
+format: list
+```
+
+## オプション
+
+| オプション | 型 | 既定値 | 内容 |
+| --- | --- | --- | --- |
+| `className` | `string` | `"rr-query"` | ルート要素の CSS クラス |
+| `language` | `string` | `"query"` | 対象のフェンス言語 |
+| `defaultFormat` | `"table"` \| `"list"` | `"table"` | ブロックが `format` を省略したときの形式 |
+| `defaultColumns` | `string[]` | `["title", "date"]` | ブロックが `columns` を省略したときの列 |
+| `defaultSort` | object | なし | ブロックが `sort` を省略したときの並べ替え |
+| `defaultLimit` | `number` | なし | ブロックが `limit` を省略したときの上限 |
+| `emptyMessage` | `string` | `"No matching content."` | 空結果のメッセージ |
+| `excludeSelf` | `boolean` | `false` | 既定で自身を除外する |
+
+## 診断
+
+不正な YAML やマッピングでないブロックは、その場にエラー表示を出しつつ、`content-query-invalid` のエラー診断を生成します。未知のフィールドは `content-query-unknown-field` の警告になります。
+
+## 制限事項
+
+- クエリ結果として生成したリンクは、コンテンツグラフ（バックリンク）には含まれません。元の Markdown に書かれたリンクだけが対象です。
+- 結果はビルド時に確定します。クエリ対象ノートの変更でホストノートを再生成する増分最適化は今後の課題です（フルビルドでは正しく再計算されます）。
+
+## エクスポート
+
+- `queryPlugin(options?)` — プラグインファクトリ
+- `remarkQuery(options?)` — Remark 変換だけを利用する場合の API（`options.language` でフェンス言語を指定）
+- `queryContentEntries(entries, spec)` — Core の照合エンジン（`@riebeckite/core` からも利用可能）
+- 型: `QueryOptions`、`QuerySpec`、`QueryOutputFormat`
+
+## 関連資料
+
+- [プラグインシステム](../../../docs/ja/plugin-system.md)

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+import type { QueryOptions } from "./src/types.js";
+export { remarkQuery } from "./src/remark.js";
+export { queryContentEntries } from "@riebeckite/core";
+export type { QueryOptions, QueryOutputFormat, QuerySpec, } from "./src/types.js";
+export declare function queryPlugin(options?: QueryOptions): import("@riebeckite/core").RiebeckitePlugin<QueryOptions>;

package/dist/index.js

@@ -0,0 +1,345 @@
+// index.ts
+import {
+  createStyleAsset,
+  definePlugin
+} from "@riebeckite/core";
+
+// src/remark.ts
+import { visit } from "unist-util-visit";
+
+// src/placeholder.ts
+var QUERY_ATTRIBUTE = "data-rr-query";
+function encodeQuerySpec(source) {
+  return encodeURIComponent(source);
+}
+function decodeQuerySpec(encoded) {
+  return decodeURIComponent(encoded);
+}
+function createQueryPlaceholder(source) {
+  return `<div ${QUERY_ATTRIBUTE}="${encodeQuerySpec(source)}"></div>`;
+}
+function createQueryPlaceholderPattern() {
+  return new RegExp(
+    `<div\\b[^>]*\\b${QUERY_ATTRIBUTE}="([^"]*)"[^>]*>\\s*</div>`,
+    "g"
+  );
+}
+
+// src/remark.ts
+function remarkQuery(options = {}) {
+  const language = options.language ?? "query";
+  return (tree) => {
+    visit(tree, "code", (node, index, parent) => {
+      if (node.lang !== language) return;
+      if (!parent || index === void 0) return;
+      const html = {
+        type: "html",
+        value: createQueryPlaceholder(node.value)
+      };
+      parent.children.splice(index, 1, html);
+    });
+  };
+}
+
+// src/runtime.ts
+import { queryContentEntries } from "@riebeckite/core";
+import { matter } from "vfile-matter";
+
+// src/render.ts
+import {
+  escapeHtml,
+  escapeHtmlAttribute
+} from "@riebeckite/core";
+var DATE_ONLY = /^\d{4}-\d{2}-\d{2}$/;
+var COLUMN_LABELS = {
+  title: "Title",
+  date: "Date",
+  updated: "Updated",
+  created: "Created",
+  published: "Published",
+  tags: "Tags",
+  description: "Description",
+  permalink: "Permalink"
+};
+function resolveQuery(spec, options) {
+  return {
+    format: spec.format ?? options.defaultFormat ?? "table",
+    columns: spec.columns ?? options.defaultColumns ?? ["title", "date"],
+    empty: spec.empty ?? options.emptyMessage ?? "No matching content.",
+    className: options.className ?? "rr-query"
+  };
+}
+function renderQueryResult(entries, query) {
+  if (entries.length === 0) {
+    return `<p class="${escapeHtmlAttribute(query.className)} ${escapeHtmlAttribute(query.className)}--empty">${escapeHtml(query.empty)}</p>`;
+  }
+  return query.format === "list" ? renderList(entries, query) : renderTable(entries, query);
+}
+function renderQueryError(message, options) {
+  const className = options.className ?? "rr-query";
+  return `<div class="${escapeHtmlAttribute(className)} ${escapeHtmlAttribute(className)}--error" role="status">${escapeHtml(message)}</div>`;
+}
+function renderTable(entries, query) {
+  const { className, columns } = query;
+  const head = columns.map(
+    (field) => `<th class="${escapeHtmlAttribute(className)}__heading" scope="col">${escapeHtml(columnLabel(field))}</th>`
+  ).join("");
+  const rows = entries.map((entry) => {
+    const cells = columns.map((field) => {
+      const modifier = escapeHtmlAttribute(`rr-query__cell--${slugify(field)}`);
+      return `<td class="${escapeHtmlAttribute(className)}__cell ${modifier}">${renderCell(entry, field, className)}</td>`;
+    }).join("");
+    return `<tr class="${escapeHtmlAttribute(className)}__row">${cells}</tr>`;
+  }).join("");
+  return [
+    `<div class="${escapeHtmlAttribute(className)}" data-rr-query-result>`,
+    `<table class="${escapeHtmlAttribute(className)}__table">`,
+    `<thead><tr>${head}</tr></thead>`,
+    `<tbody>${rows}</tbody>`,
+    "</table>",
+    "</div>"
+  ].join("");
+}
+function renderList(entries, query) {
+  const { className, columns } = query;
+  const metaColumns = columns.filter((field) => field !== "title");
+  const items = entries.map((entry) => {
+    const meta = metaColumns.map((field) => {
+      const value = renderCell(entry, field, className);
+      if (!value) return "";
+      return `<span class="${escapeHtmlAttribute(className)}__meta ${escapeHtmlAttribute(`rr-query__meta--${slugify(field)}`)}">${value}</span>`;
+    }).join(" ");
+    return `<li class="${escapeHtmlAttribute(className)}__item">${renderTitleLink(entry, className)}${meta ? ` ${meta}` : ""}</li>`;
+  }).join("");
+  return [
+    `<div class="${escapeHtmlAttribute(className)}" data-rr-query-result>`,
+    `<ul class="${escapeHtmlAttribute(className)}__list">${items}</ul>`,
+    "</div>"
+  ].join("");
+}
+function renderCell(entry, field, className) {
+  switch (field) {
+    case "title":
+      return renderTitleLink(entry, className);
+    case "tags":
+      return renderTags(entry.tags, className);
+    case "permalink":
+    case "url":
+      return `<a class="${escapeHtmlAttribute(className)}__link" href="${escapeHtmlAttribute(entry.permalink)}">${escapeHtml(entry.permalink)}</a>`;
+    default:
+      return escapeHtml(formatValue(readFrontmatterField(entry, field)));
+  }
+}
+function renderTitleLink(entry, className) {
+  return `<a class="${escapeHtmlAttribute(className)}__link" href="${escapeHtmlAttribute(entry.permalink)}">${escapeHtml(entry.title)}</a>`;
+}
+function renderTags(tags, className) {
+  return tags.map(
+    (tag) => `<span class="${escapeHtmlAttribute(className)}__tag">#${escapeHtml(tag)}</span>`
+  ).join(" ");
+}
+function readFrontmatterField(entry, field) {
+  if (field === "date") {
+    return entry.frontmatter.date ?? entry.frontmatter.created ?? entry.frontmatter.published ?? entry.frontmatter.updated;
+  }
+  return entry.frontmatter[field];
+}
+function columnLabel(field) {
+  return COLUMN_LABELS[field] ?? field;
+}
+function formatValue(value) {
+  if (value === void 0 || value === null) return "";
+  if (value instanceof Date) return formatDate(value);
+  if (Array.isArray(value)) return value.map((item) => formatValue(item)).join(", ");
+  if (typeof value === "string") {
+    return DATE_ONLY.test(value.trim()) ? value.trim() : value;
+  }
+  return String(value);
+}
+function formatDate(value) {
+  const time = value.getTime();
+  if (!Number.isFinite(time)) return "";
+  return value.toISOString().slice(0, 10);
+}
+function slugify(value) {
+  return value.trim().toLowerCase().replace(/[^a-z0-9]+/g, "-").replace(/^-+|-+$/g, "");
+}
+
+// src/runtime.ts
+var KNOWN_KEYS = /* @__PURE__ */ new Set([
+  "filter",
+  "sort",
+  "limit",
+  "offset",
+  "format",
+  "columns",
+  "excludeSelf",
+  "empty"
+]);
+function createQueryRuntime(options) {
+  const tracked = /* @__PURE__ */ new Map();
+  return {
+    track(slug, content) {
+      tracked.set(slug, content);
+    },
+    resolve(manifest, diagnostics) {
+      const entries = manifest.entries;
+      for (const entry of entries) {
+        if (!entry.html.includes(QUERY_ATTRIBUTE)) continue;
+        const html = replacePlaceholders(entry, entries, options, diagnostics);
+        if (html === entry.html) continue;
+        entry.html = html;
+        const content = tracked.get(entry.slug);
+        if (content) content.html = html;
+      }
+    }
+  };
+}
+function replacePlaceholders(entry, entries, options, diagnostics) {
+  const pattern = createQueryPlaceholderPattern();
+  return entry.html.replace(pattern, (_match, encoded) => {
+    const parsed = parseBlock(entry, encoded, options, diagnostics);
+    if (typeof parsed === "string") return parsed;
+    const query = resolveQuery(parsed, options);
+    const excludeSelf = parsed.excludeSelf ?? options.excludeSelf ?? false;
+    const pool = excludeSelf ? entries.filter((candidate) => candidate.slug !== entry.slug) : entries;
+    const selected = queryContentEntries(pool, parsed);
+    return renderQueryResult(selected, query);
+  });
+}
+function parseBlock(entry, encoded, options, diagnostics) {
+  let source;
+  try {
+    source = decodeQuerySpec(encoded);
+  } catch (error) {
+    return reportInvalid(
+      entry,
+      diagnostics,
+      `could not be decoded (${formatError(error)})`,
+      options
+    );
+  }
+  let parsed;
+  try {
+    parsed = parseYamlMapping(source);
+  } catch (error) {
+    return reportInvalid(
+      entry,
+      diagnostics,
+      `is not valid YAML (${formatError(error)})`,
+      options
+    );
+  }
+  if (parsed === null || parsed === void 0) return {};
+  if (typeof parsed !== "object" || Array.isArray(parsed)) {
+    return reportInvalid(entry, diagnostics, "must be a YAML mapping", options);
+  }
+  const spec = parsed;
+  for (const key of Object.keys(spec)) {
+    if (KNOWN_KEYS.has(key)) continue;
+    diagnostics.push({
+      code: "content-query-unknown-field",
+      severity: "warning",
+      pluginName: "query",
+      slug: entry.slug,
+      message: `Unknown query field \`${key}\` was ignored.`
+    });
+  }
+  return spec;
+}
+function reportInvalid(entry, diagnostics, reason, options) {
+  const message = `Query block in \`${entry.slug}\` ${reason}.`;
+  diagnostics.push({
+    code: "content-query-invalid",
+    severity: "error",
+    pluginName: "query",
+    slug: entry.slug,
+    message
+  });
+  return renderQueryError(message, options);
+}
+function parseYamlMapping(source) {
+  const document = `---
+${source}
+---
+`;
+  const file = {
+    value: document,
+    data: {},
+    toString: () => document
+  };
+  matter(file);
+  return file.data.matter;
+}
+function formatError(error) {
+  return error instanceof Error ? error.message : String(error);
+}
+
+// index.ts
+import { queryContentEntries as queryContentEntries2 } from "@riebeckite/core";
+function queryPlugin(options = {}) {
+  const language = options.language ?? "query";
+  const runtime = createQueryRuntime(options);
+  return definePlugin({
+    name: "query",
+    options,
+    provides: ["content.query"],
+    validateOptions: validateQueryOptions,
+    extendMarkdownPipeline: (pipeline) => {
+      pipeline.use(remarkQuery, { language });
+    },
+    onPostProcessed: (context) => {
+      runtime.track(context.slug, context.content);
+    },
+    onManifestCreated: (context) => {
+      runtime.resolve(context.manifest, context.diagnostics);
+    },
+    assets: [createStyleAsset("query")]
+  });
+}
+function validateQueryOptions(options) {
+  if (!options) return [];
+  const issues = [];
+  if (options.className !== void 0 && (typeof options.className !== "string" || options.className.trim() === "")) {
+    issues.push({ path: "className", message: "Expected a non-empty string." });
+  }
+  if (options.language !== void 0 && (typeof options.language !== "string" || options.language.trim() === "")) {
+    issues.push({ path: "language", message: "Expected a non-empty string." });
+  }
+  if (!isFormat(options.defaultFormat)) {
+    issues.push({
+      path: "defaultFormat",
+      message: 'Expected "table" or "list".'
+    });
+  }
+  if (!isColumnList(options.defaultColumns)) {
+    issues.push({
+      path: "defaultColumns",
+      message: "Expected an array of column strings."
+    });
+  }
+  if (options.defaultLimit !== void 0 && (!Number.isFinite(options.defaultLimit) || options.defaultLimit < 0)) {
+    issues.push({
+      path: "defaultLimit",
+      message: "Expected a non-negative finite number."
+    });
+  }
+  if (options.emptyMessage !== void 0 && typeof options.emptyMessage !== "string") {
+    issues.push({ path: "emptyMessage", message: "Expected a string." });
+  }
+  if (options.excludeSelf !== void 0 && typeof options.excludeSelf !== "boolean") {
+    issues.push({ path: "excludeSelf", message: "Expected a boolean." });
+  }
+  return issues;
+}
+function isFormat(value) {
+  return value === void 0 || value === "table" || value === "list";
+}
+function isColumnList(value) {
+  return value === void 0 || Array.isArray(value) && value.every((item) => typeof item === "string");
+}
+export {
+  queryContentEntries2 as queryContentEntries,
+  queryPlugin,
+  remarkQuery
+};

package/dist/src/placeholder.d.ts

@@ -0,0 +1,5 @@
+export declare const QUERY_ATTRIBUTE = "data-rr-query";
+export declare function encodeQuerySpec(source: string): string;
+export declare function decodeQuerySpec(encoded: string): string;
+export declare function createQueryPlaceholder(source: string): string;
+export declare function createQueryPlaceholderPattern(): RegExp;

package/dist/src/remark.d.ts

@@ -0,0 +1,5 @@
+import type { Root } from "mdast";
+export type RemarkQueryOptions = {
+    language?: string;
+};
+export declare function remarkQuery(options?: RemarkQueryOptions): (tree: Root) => void;

package/dist/src/render.d.ts

@@ -0,0 +1,11 @@
+import { type ContentManifestEntry } from "@riebeckite/core";
+import type { QueryOptions, QuerySpec } from "./types.js";
+export type ResolvedQuery = {
+    format: "table" | "list";
+    columns: readonly string[];
+    empty: string;
+    className: string;
+};
+export declare function resolveQuery(spec: QuerySpec, options: QueryOptions): ResolvedQuery;
+export declare function renderQueryResult(entries: readonly ContentManifestEntry[], query: ResolvedQuery): string;
+export declare function renderQueryError(message: string, options: QueryOptions): string;

package/dist/src/runtime.d.ts

@@ -0,0 +1,7 @@
+import type { ContentManifest, Diagnostic, PostContent } from "@riebeckite/core";
+import type { QueryOptions } from "./types.js";
+export type QueryRuntime = {
+    track(slug: string, content: PostContent): void;
+    resolve(manifest: ContentManifest, diagnostics: Diagnostic[]): void;
+};
+export declare function createQueryRuntime(options: QueryOptions): QueryRuntime;

package/dist/src/types.d.ts

@@ -0,0 +1,18 @@
+import type { ContentQuerySort, ContentQuerySpec } from "@riebeckite/core";
+export type QueryOutputFormat = "table" | "list";
+export type QuerySpec = ContentQuerySpec & {
+    format?: QueryOutputFormat;
+    columns?: readonly string[];
+    excludeSelf?: boolean;
+    empty?: string;
+};
+export type QueryOptions = {
+    className?: string;
+    language?: string;
+    defaultFormat?: QueryOutputFormat;
+    defaultColumns?: readonly string[];
+    defaultSort?: ContentQuerySort;
+    defaultLimit?: number;
+    emptyMessage?: string;
+    excludeSelf?: boolean;
+};

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@riebeckite/plugin-query",
+  "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",
+    "vfile-matter": "^5.0.1",
+    "@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/query"
+  },
+  "homepage": "https://github.com/Rerurate514/riebeckite#readme",
+  "bugs": {
+    "url": "https://github.com/Rerurate514/riebeckite/issues"
+  },
+  "description": "Build-time content queries for Riebeckite code blocks.",
+  "keywords": [
+    "riebeckite",
+    "plugin",
+    "query",
+    "markdown"
+  ],
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  },
+  "sideEffects": [
+    "./style.css"
+  ],
+  "scripts": {
+    "build": "node ../../../scripts/build_package.mjs"
+  }
+}

package/style.css

@@ -0,0 +1,111 @@
+.rr-query {
+  --rr-query-ink: var(--rb-color-ink, #000000);
+  --rr-query-paper: var(--rb-color-paper, #ffffff);
+  --rr-query-muted: var(--rb-color-muted, #69645c);
+  --rr-query-accent: var(--rb-color-accent, #686868);
+  --rr-query-rule: var(
+    --rb-color-border,
+    color-mix(in srgb, var(--rr-query-ink) 18%, transparent)
+  );
+  --rr-query-surface: color-mix(
+    in srgb,
+    var(--rr-query-paper) 94%,
+    var(--rr-query-ink)
+  );
+
+  margin: 1.5rem 0;
+  color: var(--rr-query-ink);
+}
+
+.rr-query__table {
+  width: 100%;
+  border-collapse: collapse;
+  font-size: 0.9375rem;
+}
+
+.rr-query__heading {
+  padding: 0.5rem 0.75rem;
+  border-bottom: 1px solid var(--rr-query-ink);
+  text-align: left;
+  font-weight: 700;
+}
+
+.rr-query__cell {
+  padding: 0.5rem 0.75rem;
+  vertical-align: top;
+}
+
+.rr-query__row:not(:last-child) .rr-query__cell {
+  border-bottom: 1px solid var(--rr-query-rule);
+}
+
+.rr-query__cell--date,
+.rr-query__meta--date,
+.rr-query__meta--created,
+.rr-query__meta--updated,
+.rr-query__meta--published {
+  color: var(--rr-query-muted);
+  white-space: nowrap;
+}
+
+.rr-query__link {
+  color: inherit;
+  text-decoration: underline;
+  text-decoration-color: var(--rr-query-rule);
+  text-underline-offset: 0.2em;
+}
+
+.rr-query__link:hover,
+.rr-query__link:focus-visible {
+  text-decoration-color: var(--rr-query-accent);
+}
+
+.rr-query__tag {
+  color: var(--rr-query-muted);
+  font-size: 0.8125em;
+  white-space: nowrap;
+}
+
+.rr-query__list {
+  margin: 0;
+  padding: 0;
+  list-style: none;
+}
+
+.rr-query__item {
+  display: flex;
+  flex-wrap: wrap;
+  gap: 0.5rem;
+  align-items: baseline;
+  padding: 0.5rem 0;
+  border-bottom: 1px solid var(--rr-query-rule);
+}
+
+.rr-query__item:last-child {
+  border-bottom: 0;
+}
+
+.rr-query__meta {
+  color: var(--rr-query-muted);
+  font-size: 0.8125em;
+}
+
+.rr-query--empty {
+  margin: 1.5rem 0;
+  color: var(--rr-query-muted);
+  font-style: italic;
+}
+
+.rr-query--error {
+  margin: 1.5rem 0;
+  padding: 0.75rem 1rem;
+  border: 1px solid var(--rr-query-ink);
+  background: var(--rr-query-surface);
+  font-size: 0.875rem;
+}
+
+html[data-theme="dark"] .rr-query,
+html.dark .rr-query {
+  --rr-query-ink: var(--rb-color-paper, #ffffff);
+  --rr-query-paper: var(--rb-color-ink, #000000);
+}