@riebeckite/plugin-seo 0.0.16 → 0.0.17

package/README.md

@@ -20,8 +20,6 @@ export default defineConfig({
   // ...
   plugins: [
     seo({
-      siteName: "Riebeckite Blog",
-      defaultImage: "/ogp.png",
       feed: { rss: true, atom: true, json: true, limit: 30 },
       sitemap: true,
       robots: true,
@@ -34,8 +32,6 @@ export default defineConfig({
 
 | Option | Type | Description |
 | ------ | ---- | ----------- |
-| `siteName` | `string` | Site name used in page titles. Defaults to `site.title`. |
-| `defaultImage` | `string` | Default OG image. Falls back to `site.defaultOgImage`. |
 | `feed` | `{ rss?: boolean; atom?: boolean; json?: boolean; limit?: number }` | Feed output settings. `limit` defaults to 30 and applies to every format. |
 | `sitemap` | `boolean` | Sitemap output settings. |
 | `robots` | `boolean` | robots.txt output settings. |
@@ -44,22 +40,27 @@ export default defineConfig({
 
 ### Articles (`buildArticleSeo`)
 
-- `title`: `"{title} | {siteName}"`
+- `title`: `"{title} | {site.title}"`
 - `description`: `frontmatter.description`, otherwise the first 160 characters
   of the post text
 - `canonicalUrl`: `frontmatter.canonical`, otherwise the entry's resolved canonical permalink
 - `imageUrl`: `frontmatter.ogImage` / `frontmatter.image`, otherwise
-  `defaultImage` / `site.defaultOgImage`
+  `site.defaultOgImage`
 - `noindex`: `frontmatter.noindex === true`
 - `publishedTime`: `published` / `date` / `created`
 - `modifiedTime`: `updated`, falling back to the publish time
 - `tags`, `readingTimeMinutes`
 - JSON-LD: `BlogPosting` and `BreadcrumbList`
 
+Pass the page's `headTags` when they already include a BreadcrumbList (for
+example contributed by the breadcrumbs plugin) and this plugin omits its own
+list, so the page keeps a single BreadcrumbList entity.
+
 ### Websites (`buildWebsiteSeo`)
 
 Title, description, canonical URL, default image, and JSON-LD `WebSite` +
-`BreadcrumbList` for index, tag, and other non-article pages.
+`BreadcrumbList` for index, tag, and other non-article pages. The
+BreadcrumbList is omitted under the same `headTags` condition as articles.
 
 ## Feeds, sitemap, and robots
 

package/README_ja.md

@@ -14,8 +14,6 @@ export default defineConfig({
   // ...
   plugins: [
     seo({
-      siteName: "Riebeckite Blog",
-      defaultImage: "/ogp.png",
       feed: { rss: true, atom: true, json: true, limit: 30 },
       sitemap: true,
       robots: true,
@@ -26,15 +24,13 @@ export default defineConfig({
 
 | 項目 | 説明 |
 | --- | --- |
-| `siteName` | ページタイトルに使うサイト名。省略時は `site.title` |
-| `defaultImage` | 既定の OGP 画像。省略時は `site.defaultOgImage` |
 | `feed` | RSS、Atom、JSON Feed の出力を個別に有効化する。`limit` は全形式共通の件数上限で、既定値は 30 件 |
 | `sitemap` | サイトマップを出力する |
 | `robots` | robots.txt を出力する |
 
 ## 記事の frontmatter が出力を決める
 
-`buildArticleSeo()` は記事タイトル、説明、canonical URL、OGP 画像、公開・更新日時、タグ、読了時間を組み立て、`BlogPosting` と `BreadcrumbList` の JSON-LD を作ります。値は次の順で補完されます。
+`buildArticleSeo()` は記事タイトル、説明、canonical URL、OGP 画像、公開・更新日時、タグ、読了時間を組み立て、`BlogPosting` と `BreadcrumbList` の JSON-LD を作ります。呼び出し側がページの `headTags` を渡し、そこに BreadcrumbList（breadcrumbs プラグインが提供するものなど）が既にある場合、重複を避けるためこのプラグイン側の BreadcrumbList は省略します。値は次の順で補完されます。
 
 | フィールド | 用途 |
 | --- | --- |

package/dist/index.js

@@ -125,16 +125,16 @@ function renderJsonFeed(config, entries) {
 }
 function getResolvedFeedMetadata(config) {
   return {
-    title: config.site.feed.title ?? config.site.title,
-    description: config.site.feed.description ?? config.site.description,
-    language: config.site.feed.language ?? getHtmlLanguage(config)
+    title: config.site.feed.title,
+    description: config.site.feed.description,
+    language: config.site.feed.language
   };
 }
 
 // src/metadata.ts
 import { calculateReadingTime } from "@riebeckite/core";
-function buildArticleSeo(config, options, permalink, post) {
-  const siteName = getSiteName(config, options);
+function buildArticleSeo(config, permalink, post, headTags) {
+  const siteName = config.site.title;
   const title = getArticleTitle(config, permalink, post.frontmatter.title);
   const canonicalUrl = buildCanonicalUrl(
     config,
@@ -144,7 +144,6 @@ function buildArticleSeo(config, options, permalink, post) {
   const description = getDescription(post) || config.site.description;
   const imageUrl = buildImageUrl(
     config,
-    options,
     post.frontmatter.ogImage ?? post.frontmatter.image
   );
   const publishedTime = getIsoDate2(
@@ -153,10 +152,31 @@ function buildArticleSeo(config, options, permalink, post) {
   const modifiedTime = getIsoDate2(post.frontmatter.updated) ?? publishedTime;
   const tags = normalizeTags(post.frontmatter.tags);
   const readingTimeMinutes = calculateReadingTime(post.html);
-  const breadcrumb = buildBreadcrumbSchema(config, [
-    { name: siteName, url: buildAbsoluteUrl(config, "/") },
-    { name: title, url: canonicalUrl }
-  ]);
+  const jsonLd = [
+    removeUndefined({
+      "@context": "https://schema.org",
+      "@type": "BlogPosting",
+      headline: title,
+      description,
+      url: canonicalUrl,
+      image: imageUrl ? [imageUrl] : void 0,
+      datePublished: publishedTime,
+      dateModified: modifiedTime,
+      author: config.site.author ? { "@type": "Person", name: config.site.author } : void 0,
+      publisher: { "@type": "Organization", name: siteName },
+      keywords: tags.length > 0 ? tags.join(", ") : void 0,
+      timeRequired: readingTimeMinutes ? `PT${readingTimeMinutes}M` : void 0,
+      inLanguage: getHtmlLanguage(config)
+    })
+  ];
+  if (!hasBreadcrumbListHeadTag(headTags)) {
+    jsonLd.push(
+      buildBreadcrumbSchema(config, [
+        { name: siteName, url: buildAbsoluteUrl(config, "/") },
+        { name: title, url: canonicalUrl }
+      ])
+    );
+  }
   return {
     title: buildPageTitle(siteName, title),
     description,
@@ -168,32 +188,32 @@ function buildArticleSeo(config, options, permalink, post) {
     modifiedTime,
     tags,
     readingTimeMinutes,
-    jsonLd: [
-      removeUndefined({
-        "@context": "https://schema.org",
-        "@type": "BlogPosting",
-        headline: title,
-        description,
-        url: canonicalUrl,
-        image: imageUrl ? [imageUrl] : void 0,
-        datePublished: publishedTime,
-        dateModified: modifiedTime,
-        author: config.site.author ? { "@type": "Person", name: config.site.author } : void 0,
-        publisher: { "@type": "Organization", name: siteName },
-        keywords: tags.length > 0 ? tags.join(", ") : void 0,
-        timeRequired: readingTimeMinutes ? `PT${readingTimeMinutes}M` : void 0,
-        inLanguage: getHtmlLanguage(config)
-      }),
-      breadcrumb
-    ]
+    jsonLd
   };
 }
-function buildWebsiteSeo(config, options, input) {
-  const siteName = getSiteName(config, options);
+function buildWebsiteSeo(config, input, headTags) {
+  const siteName = config.site.title;
   const canonicalUrl = buildAbsoluteUrl(config, input.path);
   const description = input.description || config.site.description;
-  const imageUrl = buildImageUrl(config, options);
+  const imageUrl = buildImageUrl(config);
   const title = input.kind === "tag" ? input.title : buildPageTitle(siteName, input.title);
+  const jsonLd = [
+    removeUndefined({
+      "@context": "https://schema.org",
+      "@type": "WebSite",
+      name: siteName,
+      description,
+      url: canonicalUrl,
+      inLanguage: getHtmlLanguage(config)
+    })
+  ];
+  if (!hasBreadcrumbListHeadTag(headTags)) {
+    jsonLd.push(
+      buildBreadcrumbSchema(config, [
+        { name: siteName, url: buildAbsoluteUrl(config, "/") }
+      ])
+    );
+  }
   return {
     title,
     description,
@@ -202,19 +222,7 @@ function buildWebsiteSeo(config, options, input) {
     type: "website",
     noindex: false,
     tags: [],
-    jsonLd: [
-      removeUndefined({
-        "@context": "https://schema.org",
-        "@type": "WebSite",
-        name: siteName,
-        description,
-        url: canonicalUrl,
-        inLanguage: getHtmlLanguage(config)
-      }),
-      buildBreadcrumbSchema(config, [
-        { name: siteName, url: buildAbsoluteUrl(config, "/") }
-      ])
-    ]
+    jsonLd
   };
 }
 function buildCanonicalUrl(config, canonical, permalink) {
@@ -223,13 +231,10 @@ function buildCanonicalUrl(config, canonical, permalink) {
   }
   return buildPostUrl(config, permalink);
 }
-function buildImageUrl(config, options, value) {
-  const image = value || options.defaultImage || config.site.defaultOgImage;
+function buildImageUrl(config, value) {
+  const image = value || config.site.defaultOgImage;
   return image ? buildAbsoluteUrl(config, image) : "";
 }
-function getSiteName(config, options) {
-  return options.siteName || config.site.title;
-}
 function getArticleTitle(config, slug, value) {
   if (typeof value === "string" && value.trim()) return value.trim();
   const lastSegment = slug.split("/").filter(Boolean).at(-1);
@@ -247,6 +252,25 @@ function getIsoDate2(value) {
   const date = new Date(value);
   return Number.isNaN(date.getTime()) ? void 0 : date.toISOString();
 }
+function hasBreadcrumbListHeadTag(headTags) {
+  return headTags?.some(
+    (tag) => tag.tag === "script" && typeof tag.children === "string" && hasBreadcrumbListJsonLd(tag.children)
+  ) ?? false;
+}
+function hasBreadcrumbListJsonLd(value) {
+  try {
+    return hasBreadcrumbListType(JSON.parse(value));
+  } catch {
+    return false;
+  }
+}
+function hasBreadcrumbListType(value) {
+  if (Array.isArray(value)) return value.some(hasBreadcrumbListType);
+  if (!value || typeof value !== "object") return false;
+  const record = value;
+  if (record["@type"] === "BreadcrumbList") return true;
+  return hasBreadcrumbListType(record["@graph"]);
+}
 
 // src/plugin.ts
 import { definePlugin } from "@riebeckite/core";
@@ -353,8 +377,8 @@ function seo(options = {}) {
     name: "seo",
     options,
     seo: {
-      buildArticleSeo: (config, permalink, post) => buildArticleSeo(config, options, permalink, post),
-      buildWebsiteSeo: (config, input) => buildWebsiteSeo(config, options, input),
+      buildArticleSeo: (config, permalink, post, headTags) => buildArticleSeo(config, permalink, post, headTags),
+      buildWebsiteSeo: (config, input, headTags) => buildWebsiteSeo(config, input, headTags),
       buildAbsoluteUrl,
       buildPostUrl,
       getDescription,

package/dist/src/metadata.d.ts

@@ -1,4 +1,3 @@
-import type { PostContent, ResolvedRiebeckiteConfig, SeoMetadata, WebsiteSeoInput } from "@riebeckite/core";
-import type { SeoPluginOptions } from "./types.js";
-export declare function buildArticleSeo(config: ResolvedRiebeckiteConfig, options: SeoPluginOptions, permalink: string, post: PostContent): SeoMetadata;
-export declare function buildWebsiteSeo(config: ResolvedRiebeckiteConfig, options: SeoPluginOptions, input: WebsiteSeoInput): SeoMetadata;
+import type { PluginHeadTag, PostContent, ResolvedRiebeckiteConfig, SeoMetadata, WebsiteSeoInput } from "@riebeckite/core";
+export declare function buildArticleSeo(config: ResolvedRiebeckiteConfig, permalink: string, post: PostContent, headTags?: readonly PluginHeadTag[]): SeoMetadata;
+export declare function buildWebsiteSeo(config: ResolvedRiebeckiteConfig, input: WebsiteSeoInput, headTags?: readonly PluginHeadTag[]): SeoMetadata;

package/dist/src/types.d.ts

@@ -6,8 +6,6 @@ export type FeedOptions = {
     limit?: number;
 };
 export type SeoPluginOptions = {
-    siteName?: string;
-    defaultImage?: string;
     feed?: FeedOptions;
     sitemap?: boolean;
     robots?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-seo",
-  "version": "0.0.16",
+  "version": "0.0.17",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -14,11 +14,11 @@
     }
   },
   "dependencies": {
-    "@riebeckite/core": "0.0.16"
+    "@riebeckite/core": "0.0.17"
   },
   "devDependencies": {
     "tsx": "^4.22.4",
-    "@riebeckite/test": "0.0.16"
+    "@riebeckite/test": "0.0.17"
   },
   "publishConfig": {
     "access": "public"