@riebeckite/plugin-query 0.0.32 → 0.0.33

package/README.md

@@ -10,7 +10,7 @@ JavaScript is required.
 
 ## Overview
 
-`queryPlugin()` recognises fenced blocks
+`query()` recognises fenced blocks
 
 ````md
 ```query
@@ -31,11 +31,11 @@ permalink).
 
 ```ts
 import { defineConfig } from "@riebeckite/core";
-import { queryPlugin } from "@riebeckite/plugin-query";
+import { query } from "@riebeckite/plugin-query";
 
 export default defineConfig({
   // ...
-  plugins: [queryPlugin()],
+  plugins: [query()],
 });
 ```
 
@@ -85,6 +85,26 @@ limit: 10
 format: list
 ```
 
+## Live example
+
+A list with a limit:
+
+~~~query
+format: list
+sort:
+  field: title
+  order: asc
+limit: 5
+~~~
+
+A table with selected columns:
+
+~~~query
+format: table
+columns: [title, date, tags]
+limit: 5
+~~~
+
 ## Options
 
 | Option | Type | Default | Description |
@@ -113,7 +133,7 @@ emits a `content-query-invalid` error diagnostic. Unknown fields emit a
 
 ## Exports
 
-- `queryPlugin(options?)` — plugin factory
+- `query(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`)

package/README_ja.md

@@ -8,7 +8,7 @@
 
 ## できること
 
-`queryPlugin()` は Markdown 中のフェンスコードブロック
+`query()` は Markdown 中のフェンスコードブロック
 
 ````md
 ```query
@@ -28,11 +28,11 @@ limit: 5
 
 ```ts
 import { defineConfig } from "@riebeckite/core";
-import { queryPlugin } from "@riebeckite/plugin-query";
+import { query } from "@riebeckite/plugin-query";
 
 export default defineConfig({
   // ...
-  plugins: [queryPlugin()],
+  plugins: [query()],
 });
 ```
 
@@ -82,6 +82,26 @@ limit: 10
 format: list
 ```
 
+## 実行例
+
+件数を絞ったリスト:
+
+~~~query
+format: list
+sort:
+  field: title
+  order: asc
+limit: 5
+~~~
+
+列を選んだテーブル:
+
+~~~query
+format: table
+columns: [title, date, tags]
+limit: 5
+~~~
+
 ## オプション
 
 | オプション | 型 | 既定値 | 内容 |
@@ -97,7 +117,7 @@ format: list
 
 ## 診断
 
-不正な YAML やマッピングでないブロックは、その場にエラー表示を出しつつ、`content-query-invalid` のエラー診断を生成します。未知のフィールドは `content-query-unknown-field` の警告になります。
+不正な YAML やマッピングでないブロックは、その場にエラーを表示し、`content-query-invalid` のエラー診断を生成します。未知のフィールドは `content-query-unknown-field` の警告になります。
 
 ## 制限事項
 
@@ -106,7 +126,7 @@ format: list
 
 ## エクスポート
 
-- `queryPlugin(options?)`：プラグインファクトリ
+- `query(options?)`：プラグインファクトリ
 - `remarkQuery(options?)`：Remark 変換だけを利用する場合の API（`options.language` でフェンス言語を指定）
 - `queryContentEntries(entries, spec)`：Core の照合エンジン（`@riebeckite/core` からも利用可能）
 - 型: `QueryOptions`、`QuerySpec`、`QueryOutputFormat`

package/dist/index.d.ts

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

package/dist/index.js

@@ -69,18 +69,18 @@ function resolveQuery(spec, options) {
     className: options.className ?? "rr-query"
   };
 }
-function renderQueryResult(entries, query) {
+function renderQueryResult(entries, query2) {
   if (entries.length === 0) {
-    return `<p class="${escapeHtmlAttribute(query.className)} ${escapeHtmlAttribute(query.className)}--empty">${escapeHtml(query.empty)}</p>`;
+    return `<p class="${escapeHtmlAttribute(query2.className)} ${escapeHtmlAttribute(query2.className)}--empty">${escapeHtml(query2.empty)}</p>`;
   }
-  return query.format === "list" ? renderList(entries, query) : renderTable(entries, query);
+  return query2.format === "list" ? renderList(entries, query2) : renderTable(entries, query2);
 }
 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;
+function renderTable(entries, query2) {
+  const { className, columns } = query2;
   const head = columns.map(
     (field) => `<th class="${escapeHtmlAttribute(className)}__heading" scope="col">${escapeHtml(columnLabel(field))}</th>`
   ).join("");
@@ -102,8 +102,8 @@ function renderTable(entries, query) {
     "</div>"
   ].join("");
 }
-function renderList(entries, query) {
-  const { className, columns } = query;
+function renderList(entries, query2) {
+  const { className, columns } = query2;
   const metaColumns = columns.filter((field) => field !== "title");
   const items = entries.map((entry) => {
     const meta = metaColumns.map((field) => {
@@ -201,11 +201,11 @@ function replacePlaceholders(entry, entries, options, diagnostics) {
   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 query2 = 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);
+    return renderQueryResult(selected, query2);
   });
 }
 function parseBlock(entry, encoded, options, diagnostics) {
@@ -278,7 +278,7 @@ function formatError(error) {
 
 // index.ts
 import { queryContentEntries as queryContentEntries2 } from "@riebeckite/core";
-function queryPlugin(options = {}) {
+function query(options = {}) {
   const language = options.language ?? "query";
   const runtime = createQueryRuntime(options);
   return definePlugin({
@@ -342,7 +342,7 @@ function isColumnList(value) {
   return value === void 0 || Array.isArray(value) && value.every((item) => typeof item === "string");
 }
 export {
+  query,
   queryContentEntries2 as queryContentEntries,
-  queryPlugin,
   remarkQuery
 };

package/dist/src/placeholder.d.ts

@@ -1,5 +1,4 @@
 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

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

package/dist/src/render.d.ts

@@ -1,6 +1,6 @@
 import { type ContentManifestEntry } from "@riebeckite/core";
 import type { QueryOptions, QuerySpec } from "./types.js";
-export type ResolvedQuery = {
+type ResolvedQuery = {
     format: "table" | "list";
     columns: readonly string[];
     empty: string;
@@ -9,3 +9,4 @@ export type ResolvedQuery = {
 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;
+export {};

package/dist/src/runtime.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-query",
-  "version": "0.0.32",
+  "version": "0.0.33",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -15,14 +15,14 @@
     "./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"
   },
   "devDependencies": {
-    "tsx": "^4.22.4",
-    "@riebeckite/test": "0.0.32"
+    "@riebeckite/test": "0.0.33",
+    "tsx": "^4.22.4"
   },
   "publishConfig": {
     "access": "public"