SERPINFO

SERPINFO は、uBlacklist が Google、Bing、DuckDuckGo などの検索エンジンで動作する仕組みです。 各 SERPINFO は、特定の検索エンジンの検索結果ページで検索結果を見つける方法を記述する YAML ファイルです。それにより、uBlacklist が検索結果をブロック、ハイライトしたり、ボタンを追加したりできるようになります。

uBlacklist には、サポートされた検索エンジンのための SERPINFO が組み込まれています。他人が公開している SERPINFO を購読したり、サポートされていない検索エンジンのために自分で SERPINFO を書いたりすることもできます。

SERPINFO のオプションページは、拡張機能のオプションページでその他の検索エンジン から開くことができます。 そこでは、個々の SERPINFO を有効または無効にしたり、他人が公開したものを購読したり、マイ SERPINFO に自分の SERPINFO を記述したりすることができます。

ファイル形式

SERPINFO ファイルは以下の構造を持つ YAML 形式を使用します:

name: SearchEngineName
version: 1.0.0
homepage: https://example.com/
lastModified: 2023-09-01T00:00:00Z

pages:
  - name: PageType
    matches:
      - https://search.example.com/search?*
    results:
      - root: .result-selector
        url: a.link
        props:
          title: .title
    commonProps:
      $site: example
      $category: web

トップレベルプロパティ

ページ定義

pages 配列内の各項目は、特定の種類の検索結果ページ (Web、画像、ニュースなど) を表します:

検索結果定義

results 配列内の各項目は、単一の検索結果からデータを抽出する方法を定義します:

コマンド

SERPINFO は複雑なシナリオに対応するため、以下の 3 つのカテゴリに分類されたコマンドをサポートします:

ルートコマンド

• <css-selector> または [selector, <css-selector>]: CSS セレクターに一致する要素を検索
• [upward, <level>, <root-command>]: ルートコマンドで見つかった各要素から DOM ツリーを <level> ステップ上に移動

要素コマンド

• <css-selector> または [selector, <css-selector>, <element-command>?]: CSS セレクターで要素を取得
• [upward, <level>, <element-command>?]: DOM ツリーを <level> ステップ上に移動

注意: <element-command> が省略された場合、現在のルート要素が暗黙的に使用されます。

プロパティコマンド

• <css-selector>: CSS セレクターに一致する要素の textContent プロパティ (デフォルト) または href 属性 (URL 抽出時) を取得
• [attribute, <name>, <element-command>?]: 属性値を取得
• [property, <name>, <element-command>?]: プロパティ値を取得
• [const, <value>]: 定数文字列を返す
• [domainToURL, <property-command>]: ドメインを URL に変換
• [regexInclude, <pattern>, <property-command>]: 正規表現に一致する場合のみ含める
• [regexExclude, <pattern>, <property-command>]: 正規表現に一致する場合は除外
• [regexSubstitute, <pattern>, <replacement>, <property-command>]: 正規表現で置換
• [or, [<property-command>*], <element-command>?]: 複数のコマンドを順番に試す

注意: <element-command> が省略された場合、現在のルート要素が暗黙的に使用されます。

ボタンコマンド

• [icon, <options>?, <element-command>?]: スタイルを指定してアイコンボタンを追加します。オプションには以下が含まれます:

  • style: インラインスタイル (例: "top: 16px; right: 32px; --ub-icon-size: 16px;")

• [text, <options>?, <element-command>?]: 位置とスタイルを指定してテキストボタンを追加します。オプションには以下が含まれます:

  • position: "beforebegin", "afterbegin", "beforeend", "afterend" (デフォルト: beforeend")
  • style: インラインスタイル (例: "color: var(--fg-color); font-size: 14px;")

• [inset, <options>?, <element-command>?]: 要素内の特定の位置にボタンを追加。オプションには以下が含まれます:

  • top: CSS の長さまたは割合
  • right: CSS の長さまたは割合
  • bottom: CSS の長さまたは割合
  • left: CSS の長さまたは割合
  • zIndex: z-index 値 (デフォルト: 1)

注意: <element-command> が省略された場合、現在のルート要素が使用されます。

例

以下は Bing 画像検索の例です:

name: Bing
version: 0.1.0
homepage: https://github.com/ublacklist/builtin#readme
license: MIT
lastModified: 2023-04-05T11:11:20Z

pages:
  - name: Images (desktop)
    matches:
      - https://www.bing.com/images/search?*
    userAgent: desktop
    results:
      - root: [upward, 1, ".iuscp"]
        url:
          - regexSubstitute
          - '"purl":"([^"]+)'
          - "\\1"
          - [attribute, "m", ".iusc"]
        props:
          title: [attribute, "title", "li > a"]
        button: [inset, { top: "32px", right: 0 }, ".iuscp"]
    commonProps:
      $site: bing
      $category: images

購読

SERPINFO の公開

SERPINFO ファイルをホストし、購読リンクを提供することで、SERPINFO を他のユーザーと共有できます。

1. 上記の形式に従って SERPINFO ファイルを作成
2. ファイルを GitHub や自身のウェブサイトなどで公開
3. 以下の形式で購読リンクを共有:

https://ublacklist.github.io/serpinfo/subscribe?url=<url-encoded-url>

<url-encoded-url> は、公開された SERPINFO ファイルの URL を URLエンコード したものです。

SERPINFO の購読

SERPINFO を購読するには:

1. 提供された購読リンクをクリック
2. 拡張機能がオプションページを開き、購読の追加を促します
3. 確認して拡張機能にSERPINFOを追加